Create an external account for a given account.
", -< "operationId": "PostAccountsAccountBankAccounts", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "bank_account": { -< "explode": true, -< "style": "deepObject" -< }, -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "bank_account": { -< "anyOf": [ -< { -< "properties": { -< "account_holder_name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "account_holder_type": { -< "enum": [ -< "company", -< "individual" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "account_number": { -< "maxLength": 5000, -< "type": "string" -< }, -< "account_type": { -< "enum": [ -< "checking", -< "futsu", -< "savings", -< "toza" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "currency": { -< "type": "string" -< }, -< "object": { -< "enum": [ -< "bank_account" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "routing_number": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "account_number", -< "country" -< ], -< "title": "external_account_payout_bank_account", -< "type": "object" -< }, -< { -< "maxLength": 5000, -< "type": "string" -< } -< ], -< "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." -< }, -< "default_for_currency": { -< "description": "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.", -< "type": "boolean" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "external_account": { -< "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.", -< "maxLength": 5000, -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "metadata": { -< "additionalProperties": { -< "type": "string" -< }, -< "description": "Set of [key-value pairs](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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -< "type": "object" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/external_account" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/accounts/{account}/bank_accounts/{id}": { -< "delete": { -< "description": "Delete a specified external account for a given account.
", -< "operationId": "DeleteAccountsAccountBankAccountsId", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/deleted_external_account" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "get": { -< "description": "Retrieve a specified external account for a given account.
", -< "operationId": "GetAccountsAccountBankAccountsId", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/external_account" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
\n\nYou can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
", -< "operationId": "PostAccountsAccountBankAccountsId", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "account_holder_name": { -< "description": "The name of the person or business that owns the bank account.", -< "maxLength": 5000, -< "type": "string" -< }, -< "account_holder_type": { -< "description": "The type of entity that holds the account. This can be either `individual` or `company`.", -< "enum": [ -< "", -< "company", -< "individual" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "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`.", -< "enum": [ -< "checking", -< "futsu", -< "savings", -< "toza" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "address_city": { -< "description": "City/District/Suburb/Town/Village.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_country": { -< "description": "Billing address country, if provided when creating card.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line1": { -< "description": "Address line 1 (Street address/PO Box/Company name).", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line2": { -< "description": "Address line 2 (Apartment/Suite/Unit/Building).", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_state": { -< "description": "State/County/Province/Region.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_zip": { -< "description": "ZIP or postal code.", -< "maxLength": 5000, -< "type": "string" -< }, -< "default_for_currency": { -< "description": "When set to true, this becomes the default external account for its currency.", -< "type": "boolean" -< }, -< "exp_month": { -< "description": "Two digit number representing the card’s expiration month.", -< "maxLength": 5000, -< "type": "string" -< }, -< "exp_year": { -< "description": "Four digit number representing the card’s expiration year.", -< "maxLength": 5000, -< "type": "string" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Set of [key-value pairs](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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "name": { -< "description": "Cardholder name.", -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/external_account" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -43398,43407c52416 -< "anyOf": [ -< { -< "$ref": "#/components/schemas/bank_account" -< }, -< { -< "$ref": "#/components/schemas/card" -< } -< ], -< "title": "Polymorphic", -< "x-stripeBypassValidation": true ---- -> "$ref": "#/components/schemas/external_account" -43475,43478d52483 -< "bank_account": { -< "explode": true, -< "style": "deepObject" -< }, -43491,43553d52495 -< "bank_account": { -< "anyOf": [ -< { -< "properties": { -< "account_holder_name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "account_holder_type": { -< "enum": [ -< "company", -< "individual" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "account_number": { -< "maxLength": 5000, -< "type": "string" -< }, -< "account_type": { -< "enum": [ -< "checking", -< "futsu", -< "savings", -< "toza" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "currency": { -< "type": "string" -< }, -< "object": { -< "enum": [ -< "bank_account" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "routing_number": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "account_number", -< "country" -< ], -< "title": "external_account_payout_bank_account", -< "type": "object" -< }, -< { -< "maxLength": 5000, -< "type": "string" -< } -< ], -< "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." -< }, -43579a52522,52524 -> "required": [ -> "external_account" -> ], -43584c52529 -< "required": false ---- -> "required": true -43984,45285d52928 -< "/v1/accounts/{account}/people": { -< "get": { -< "description": "Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
", -< "operationId": "GetAccountsAccountPeople", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", -< "in": "query", -< "name": "ending_before", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", -< "in": "query", -< "name": "limit", -< "required": false, -< "schema": { -< "type": "integer" -< }, -< "style": "form" -< }, -< { -< "description": "Filters on the list of people returned based on the person's relationship to the account's company.", -< "explode": true, -< "in": "query", -< "name": "relationship", -< "required": false, -< "schema": { -< "properties": { -< "director": { -< "type": "boolean" -< }, -< "executive": { -< "type": "boolean" -< }, -< "owner": { -< "type": "boolean" -< }, -< "representative": { -< "type": "boolean" -< } -< }, -< "title": "all_people_relationship_specs", -< "type": "object" -< }, -< "style": "deepObject" -< }, -< { -< "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", -< "in": "query", -< "name": "starting_after", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "description": "", -< "properties": { -< "data": { -< "items": { -< "$ref": "#/components/schemas/person" -< }, -< "type": "array" -< }, -< "has_more": { -< "description": "True if this list has another page of items after this one that can be fetched.", -< "type": "boolean" -< }, -< "object": { -< "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", -< "enum": [ -< "list" -< ], -< "type": "string" -< }, -< "url": { -< "description": "The URL where this list can be accessed.", -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "data", -< "has_more", -< "object", -< "url" -< ], -< "title": "PersonList", -< "type": "object", -< "x-expandableFields": [ -< "data" -< ] -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "Creates a new person.
", -< "operationId": "PostAccountsAccountPeople", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "address": { -< "explode": true, -< "style": "deepObject" -< }, -< "address_kana": { -< "explode": true, -< "style": "deepObject" -< }, -< "address_kanji": { -< "explode": true, -< "style": "deepObject" -< }, -< "dob": { -< "explode": true, -< "style": "deepObject" -< }, -< "documents": { -< "explode": true, -< "style": "deepObject" -< }, -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "full_name_aliases": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< }, -< "registered_address": { -< "explode": true, -< "style": "deepObject" -< }, -< "relationship": { -< "explode": true, -< "style": "deepObject" -< }, -< "verification": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "address": { -< "description": "The person's address.", -< "properties": { -< "city": { -< "maxLength": 100, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 200, -< "type": "string" -< }, -< "line2": { -< "maxLength": 200, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "address_specs", -< "type": "object" -< }, -< "address_kana": { -< "description": "The Kana variation of the person's address (Japan only).", -< "properties": { -< "city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< }, -< "town": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "japan_address_kana_specs", -< "type": "object" -< }, -< "address_kanji": { -< "description": "The Kanji variation of the person's address (Japan only).", -< "properties": { -< "city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< }, -< "town": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "japan_address_kanji_specs", -< "type": "object" -< }, -< "dob": { -< "anyOf": [ -< { -< "properties": { -< "day": { -< "type": "integer" -< }, -< "month": { -< "type": "integer" -< }, -< "year": { -< "type": "integer" -< } -< }, -< "required": [ -< "day", -< "month", -< "year" -< ], -< "title": "date_of_birth_specs", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "The person's date of birth." -< }, -< "documents": { -< "description": "Documents that may be submitted to satisfy various informational requests.", -< "properties": { -< "company_authorization": { -< "properties": { -< "files": { -< "items": { -< "maxLength": 500, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "title": "documents_param", -< "type": "object" -< }, -< "passport": { -< "properties": { -< "files": { -< "items": { -< "maxLength": 500, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "title": "documents_param", -< "type": "object" -< }, -< "visa": { -< "properties": { -< "files": { -< "items": { -< "maxLength": 500, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "title": "documents_param", -< "type": "object" -< } -< }, -< "title": "person_documents_specs", -< "type": "object" -< }, -< "email": { -< "description": "The person's email address.", -< "type": "string" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "first_name": { -< "description": "The person's first name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "first_name_kana": { -< "description": "The Kana variation of the person's first name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "first_name_kanji": { -< "description": "The Kanji variation of the person's first name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "full_name_aliases": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "A list of alternate names or aliases that the person is known by." -< }, -< "gender": { -< "description": "The person's gender (International regulations require either \"male\" or \"female\").", -< "type": "string" -< }, -< "id_number": { -< "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -< "maxLength": 5000, -< "type": "string" -< }, -< "id_number_secondary": { -< "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -< "maxLength": 5000, -< "type": "string" -< }, -< "last_name": { -< "description": "The person's last name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "last_name_kana": { -< "description": "The Kana variation of the person's last name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "last_name_kanji": { -< "description": "The Kanji variation of the person's last name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "maiden_name": { -< "description": "The person's maiden name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Set of [key-value pairs](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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "nationality": { -< "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", -< "maxLength": 5000, -< "type": "string" -< }, -< "person_token": { -< "description": "A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person.", -< "maxLength": 5000, -< "type": "string" -< }, -< "phone": { -< "description": "The person's phone number.", -< "type": "string" -< }, -< "political_exposure": { -< "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.", -< "maxLength": 5000, -< "type": "string" -< }, -< "registered_address": { -< "description": "The person's registered address.", -< "properties": { -< "city": { -< "maxLength": 100, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 200, -< "type": "string" -< }, -< "line2": { -< "maxLength": 200, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "address_specs", -< "type": "object" -< }, -< "relationship": { -< "description": "The relationship that this person has with the account's legal entity.", -< "properties": { -< "director": { -< "type": "boolean" -< }, -< "executive": { -< "type": "boolean" -< }, -< "owner": { -< "type": "boolean" -< }, -< "percent_ownership": { -< "anyOf": [ -< { -< "type": "number" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "representative": { -< "type": "boolean" -< }, -< "title": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "relationship_specs", -< "type": "object" -< }, -< "ssn_last_4": { -< "description": "The last four digits of the person's Social Security number (U.S. only).", -< "type": "string" -< }, -< "verification": { -< "description": "The person's verification status.", -< "properties": { -< "additional_document": { -< "properties": { -< "back": { -< "maxLength": 500, -< "type": "string" -< }, -< "front": { -< "maxLength": 500, -< "type": "string" -< } -< }, -< "title": "person_verification_document_specs", -< "type": "object" -< }, -< "document": { -< "properties": { -< "back": { -< "maxLength": 500, -< "type": "string" -< }, -< "front": { -< "maxLength": 500, -< "type": "string" -< } -< }, -< "title": "person_verification_document_specs", -< "type": "object" -< } -< }, -< "title": "person_verification_specs", -< "type": "object" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/person" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/accounts/{account}/people/{person}": { -< "delete": { -< "description": "Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
Retrieves an existing person.
", -< "operationId": "GetAccountsAccountPeoplePerson", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "person", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/person" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "Updates an existing person.
", -< "operationId": "PostAccountsAccountPeoplePerson", -< "parameters": [ -< { -< "in": "path", -< "name": "account", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "person", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "address": { -< "explode": true, -< "style": "deepObject" -< }, -< "address_kana": { -< "explode": true, -< "style": "deepObject" -< }, -< "address_kanji": { -< "explode": true, -< "style": "deepObject" -< }, -< "dob": { -< "explode": true, -< "style": "deepObject" -< }, -< "documents": { -< "explode": true, -< "style": "deepObject" -< }, -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "full_name_aliases": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< }, -< "registered_address": { -< "explode": true, -< "style": "deepObject" -< }, -< "relationship": { -< "explode": true, -< "style": "deepObject" -< }, -< "verification": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "address": { -< "description": "The person's address.", -< "properties": { -< "city": { -< "maxLength": 100, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 200, -< "type": "string" -< }, -< "line2": { -< "maxLength": 200, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "address_specs", -< "type": "object" -< }, -< "address_kana": { -< "description": "The Kana variation of the person's address (Japan only).", -< "properties": { -< "city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< }, -< "town": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "japan_address_kana_specs", -< "type": "object" -< }, -< "address_kanji": { -< "description": "The Kanji variation of the person's address (Japan only).", -< "properties": { -< "city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< }, -< "town": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "japan_address_kanji_specs", -< "type": "object" -< }, -< "dob": { -< "anyOf": [ -< { -< "properties": { -< "day": { -< "type": "integer" -< }, -< "month": { -< "type": "integer" -< }, -< "year": { -< "type": "integer" -< } -< }, -< "required": [ -< "day", -< "month", -< "year" -< ], -< "title": "date_of_birth_specs", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "The person's date of birth." -< }, -< "documents": { -< "description": "Documents that may be submitted to satisfy various informational requests.", -< "properties": { -< "company_authorization": { -< "properties": { -< "files": { -< "items": { -< "maxLength": 500, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "title": "documents_param", -< "type": "object" -< }, -< "passport": { -< "properties": { -< "files": { -< "items": { -< "maxLength": 500, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "title": "documents_param", -< "type": "object" -< }, -< "visa": { -< "properties": { -< "files": { -< "items": { -< "maxLength": 500, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "title": "documents_param", -< "type": "object" -< } -< }, -< "title": "person_documents_specs", -< "type": "object" -< }, -< "email": { -< "description": "The person's email address.", -< "type": "string" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "first_name": { -< "description": "The person's first name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "first_name_kana": { -< "description": "The Kana variation of the person's first name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "first_name_kanji": { -< "description": "The Kanji variation of the person's first name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "full_name_aliases": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "A list of alternate names or aliases that the person is known by." -< }, -< "gender": { -< "description": "The person's gender (International regulations require either \"male\" or \"female\").", -< "type": "string" -< }, -< "id_number": { -< "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -< "maxLength": 5000, -< "type": "string" -< }, -< "id_number_secondary": { -< "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -< "maxLength": 5000, -< "type": "string" -< }, -< "last_name": { -< "description": "The person's last name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "last_name_kana": { -< "description": "The Kana variation of the person's last name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "last_name_kanji": { -< "description": "The Kanji variation of the person's last name (Japan only).", -< "maxLength": 5000, -< "type": "string" -< }, -< "maiden_name": { -< "description": "The person's maiden name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Set of [key-value pairs](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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "nationality": { -< "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", -< "maxLength": 5000, -< "type": "string" -< }, -< "person_token": { -< "description": "A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person.", -< "maxLength": 5000, -< "type": "string" -< }, -< "phone": { -< "description": "The person's phone number.", -< "type": "string" -< }, -< "political_exposure": { -< "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.", -< "maxLength": 5000, -< "type": "string" -< }, -< "registered_address": { -< "description": "The person's registered address.", -< "properties": { -< "city": { -< "maxLength": 100, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 200, -< "type": "string" -< }, -< "line2": { -< "maxLength": 200, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "address_specs", -< "type": "object" -< }, -< "relationship": { -< "description": "The relationship that this person has with the account's legal entity.", -< "properties": { -< "director": { -< "type": "boolean" -< }, -< "executive": { -< "type": "boolean" -< }, -< "owner": { -< "type": "boolean" -< }, -< "percent_ownership": { -< "anyOf": [ -< { -< "type": "number" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "representative": { -< "type": "boolean" -< }, -< "title": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "relationship_specs", -< "type": "object" -< }, -< "ssn_last_4": { -< "description": "The last four digits of the person's Social Security number (U.S. only).", -< "type": "string" -< }, -< "verification": { -< "description": "The person's verification status.", -< "properties": { -< "additional_document": { -< "properties": { -< "back": { -< "maxLength": 500, -< "type": "string" -< }, -< "front": { -< "maxLength": 500, -< "type": "string" -< } -< }, -< "title": "person_verification_document_specs", -< "type": "object" -< }, -< "document": { -< "properties": { -< "back": { -< "maxLength": 500, -< "type": "string" -< }, -< "front": { -< "maxLength": 500, -< "type": "string" -< } -< }, -< "title": "person_verification_document_specs", -< "type": "object" -< } -< }, -< "title": "person_verification_specs", -< "type": "object" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/person" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -45345a52989 -> "description": "A filter on the list of people returned based on whether these people are directors of the account's company.", -45348a52993 -> "description": "A filter on the list of people returned based on whether these people are executives of the account's company.", -45351a52997 -> "description": "A filter on the list of people returned based on whether these people are owners of the account's company.", -45354a53001 -> "description": "A filter on the list of people returned based on whether these people are the representative of the account's company.", -45516a53164 -> "description": "City, district, suburb, town, or village.", -45520a53169 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -45524a53174 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -45528a53179 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -45532a53184 -> "description": "ZIP or postal code.", -45536a53189 -> "description": "State, county, province, or region.", -45547a53201 -> "description": "City or ward.", -45551a53206 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -45555a53211 -> "description": "Block or building number.", -45559a53216 -> "description": "Building details.", -45563a53221 -> "description": "Postal code.", -45567a53226 -> "description": "Prefecture.", -45571a53231 -> "description": "Town or cho-me.", -45582a53243 -> "description": "City or ward.", -45586a53248 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -45590a53253 -> "description": "Block or building number.", -45594a53258 -> "description": "Building details.", -45598a53263 -> "description": "Postal code.", -45602a53268 -> "description": "Prefecture.", -45606a53273 -> "description": "Town or cho-me.", -45618a53286 -> "description": "The day of birth, between 1 and 31.", -45621a53290 -> "description": "The month of birth, between 1 and 12.", -45624a53294 -> "description": "The four-digit year of birth.", -45648a53319 -> "description": "One or more documents that demonstrate proof that this person is authorized to represent the company.", -45650a53322 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -45661a53334 -> "description": "One or more documents showing the person's passport page with photo and personal data.", -45663a53337 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -45674a53349 -> "description": "One or more documents showing the person's visa required for living in the country where they are residing.", -45676a53352 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -45809a53486 -> "description": "City, district, suburb, town, or village.", -45813a53491 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -45817a53496 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -45821a53501 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -45825a53506 -> "description": "ZIP or postal code.", -45829a53511 -> "description": "State, county, province, or region.", -45840a53523 -> "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", -45843a53527 -> "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", -45846a53531 -> "description": "Whether the person is an owner of the account’s legal entity.", -45860c53545,53546 -< ] ---- -> ], -> "description": "The percent owned by the person of the account's legal entity." -45862a53549 -> "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.", -45865a53553 -> "description": "The person's title (e.g., CEO, Support Engineer).", -45880a53569 -> "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", -45882a53572 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -45886a53577 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -45894a53586 -> "description": "An identifying document, either a passport or local ID card.", -45896a53589 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -45900a53594 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -46161a53856 -> "description": "City, district, suburb, town, or village.", -46165a53861 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -46169a53866 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -46173a53871 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -46177a53876 -> "description": "ZIP or postal code.", -46181a53881 -> "description": "State, county, province, or region.", -46192a53893 -> "description": "City or ward.", -46196a53898 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -46200a53903 -> "description": "Block or building number.", -46204a53908 -> "description": "Building details.", -46208a53913 -> "description": "Postal code.", -46212a53918 -> "description": "Prefecture.", -46216a53923 -> "description": "Town or cho-me.", -46227a53935 -> "description": "City or ward.", -46231a53940 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -46235a53945 -> "description": "Block or building number.", -46239a53950 -> "description": "Building details.", -46243a53955 -> "description": "Postal code.", -46247a53960 -> "description": "Prefecture.", -46251a53965 -> "description": "Town or cho-me.", -46263a53978 -> "description": "The day of birth, between 1 and 31.", -46266a53982 -> "description": "The month of birth, between 1 and 12.", -46269a53986 -> "description": "The four-digit year of birth.", -46293a54011 -> "description": "One or more documents that demonstrate proof that this person is authorized to represent the company.", -46295a54014 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -46306a54026 -> "description": "One or more documents showing the person's passport page with photo and personal data.", -46308a54029 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -46319a54041 -> "description": "One or more documents showing the person's visa required for living in the country where they are residing.", -46321a54044 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -46454a54178 -> "description": "City, district, suburb, town, or village.", -46458a54183 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -46462a54188 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -46466a54193 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -46470a54198 -> "description": "ZIP or postal code.", -46474a54203 -> "description": "State, county, province, or region.", -46485a54215 -> "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", -46488a54219 -> "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", -46491a54223 -> "description": "Whether the person is an owner of the account’s legal entity.", -46505c54237,54238 -< ] ---- -> ], -> "description": "The percent owned by the person of the account's legal entity." -46507a54241 -> "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.", -46510a54245 -> "description": "The person's title (e.g., CEO, Support Engineer).", -46525a54261 -> "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", -46527a54264 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -46531a54269 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -46539a54278 -> "description": "An identifying document, either a passport or local ID card.", -46541a54281 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -46545a54286 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -47002a54744 -> "description": "Minimum value to filter by (exclusive)", -47005a54748 -> "description": "Minimum value to filter by (inclusive)", -47008a54752 -> "description": "Maximum value to filter by (exclusive)", -47011a54756 -> "description": "Maximum value to filter by (inclusive)", -47388,47461d55132 -< "/v1/application_fees/{id}/refund": { -< "post": { -< "description": "", -< "operationId": "PostApplicationFeesIdRefund", -< "parameters": [ -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "amount": { -< "type": "integer" -< }, -< "directive": { -< "maxLength": 5000, -< "type": "string" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/application_fee" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -47727a55399 -> "description": "The secret scope type.", -47734a55407 -> "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", -47876a55550 -> "description": "The secret scope type.", -47883a55558 -> "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", -47966a55642 -> "description": "The secret scope type.", -47973a55650 -> "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", -48058a55736 -> "description": "The secret scope type.", -48065a55744 -> "description": "The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.", -48174c55853 -< "/v1/balance/history": { ---- -> "/v1/balance_transactions": { -48177c55856 -< "operationId": "GetBalanceHistory", ---- -> "operationId": "GetBalanceTransactions", -48179a55859 -> "description": "This parameter is deprecated and we recommend listing by created and filtering in memory instead.", -48182c55862 -< "name": "created", ---- -> "name": "available_on", -48188a55869 -> "description": "Minimum value to filter by (exclusive)", -48191a55873 -> "description": "Minimum value to filter by (inclusive)", -48194a55877 -> "description": "Maximum value to filter by (exclusive)", -48197a55881 -> "description": "Maximum value to filter by (inclusive)", -48212,48448d55895 -< "description": "Only return transactions in a certain currency. 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).", -< "in": "query", -< "name": "currency", -< "required": false, -< "schema": { -< "type": "string" -< }, -< "style": "form" -< }, -< { -< "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", -< "in": "query", -< "name": "ending_before", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", -< "in": "query", -< "name": "limit", -< "required": false, -< "schema": { -< "type": "integer" -< }, -< "style": "form" -< }, -< { -< "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.", -< "in": "query", -< "name": "payout", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< }, -< { -< "description": "Only returns the original transaction.", -< "in": "query", -< "name": "source", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< }, -< { -< "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", -< "in": "query", -< "name": "starting_after", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< }, -< { -< "description": "Only returns transactions of the given type. One of: `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`.", -< "in": "query", -< "name": "type", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "description": "", -< "properties": { -< "data": { -< "items": { -< "$ref": "#/components/schemas/balance_transaction" -< }, -< "type": "array" -< }, -< "has_more": { -< "description": "True if this list has another page of items after this one that can be fetched.", -< "type": "boolean" -< }, -< "object": { -< "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", -< "enum": [ -< "list" -< ], -< "type": "string" -< }, -< "url": { -< "description": "The URL where this list can be accessed.", -< "maxLength": 5000, -< "pattern": "^/v1/balance_transactions", -< "type": "string" -< } -< }, -< "required": [ -< "data", -< "has_more", -< "object", -< "url" -< ], -< "title": "BalanceTransactionsList", -< "type": "object", -< "x-expandableFields": [ -< "data" -< ] -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/balance/history/{id}": { -< "get": { -< "description": "Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
\n\nNote that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Retrieve a dispute for a specified charge.
", -< "operationId": "GetChargesChargeDispute", -< "parameters": [ -< { -< "in": "path", -< "name": "charge", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/dispute" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "", -< "operationId": "PostChargesChargeDispute", -< "parameters": [ -< { -< "in": "path", -< "name": "charge", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "evidence": { -< "explode": true, -< "style": "deepObject" -< }, -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "evidence": { -< "description": "Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.", -< "properties": { -< "access_activity_log": { -< "maxLength": 20000, -< "type": "string" -< }, -< "billing_address": { -< "maxLength": 5000, -< "type": "string" -< }, -< "cancellation_policy": { -< "type": "string" -< }, -< "cancellation_policy_disclosure": { -< "maxLength": 20000, -< "type": "string" -< }, -< "cancellation_rebuttal": { -< "maxLength": 20000, -< "type": "string" -< }, -< "customer_communication": { -< "type": "string" -< }, -< "customer_email_address": { -< "maxLength": 5000, -< "type": "string" -< }, -< "customer_name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "customer_purchase_ip": { -< "maxLength": 5000, -< "type": "string" -< }, -< "customer_signature": { -< "type": "string" -< }, -< "duplicate_charge_documentation": { -< "type": "string" -< }, -< "duplicate_charge_explanation": { -< "maxLength": 20000, -< "type": "string" -< }, -< "duplicate_charge_id": { -< "maxLength": 5000, -< "type": "string" -< }, -< "product_description": { -< "maxLength": 20000, -< "type": "string" -< }, -< "receipt": { -< "type": "string" -< }, -< "refund_policy": { -< "type": "string" -< }, -< "refund_policy_disclosure": { -< "maxLength": 20000, -< "type": "string" -< }, -< "refund_refusal_explanation": { -< "maxLength": 20000, -< "type": "string" -< }, -< "service_date": { -< "maxLength": 5000, -< "type": "string" -< }, -< "service_documentation": { -< "type": "string" -< }, -< "shipping_address": { -< "maxLength": 5000, -< "type": "string" -< }, -< "shipping_carrier": { -< "maxLength": 5000, -< "type": "string" -< }, -< "shipping_date": { -< "maxLength": 5000, -< "type": "string" -< }, -< "shipping_documentation": { -< "type": "string" -< }, -< "shipping_tracking_number": { -< "maxLength": 5000, -< "type": "string" -< }, -< "uncategorized_file": { -< "type": "string" -< }, -< "uncategorized_text": { -< "maxLength": 20000, -< "type": "string" -< } -< }, -< "title": "dispute_evidence_params", -< "type": "object" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Set of [key-value pairs](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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "submit": { -< "description": "Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).", -< "type": "boolean" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/dispute" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/charges/{charge}/dispute/close": { -< "post": { -< "description": "", -< "operationId": "PostChargesChargeDisputeClose", -< "parameters": [ -< { -< "in": "path", -< "name": "charge", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/dispute" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/charges/{charge}/refund": { -< "post": { -< "description": "When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
\n\nCreating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.
\n\nYou can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.
\n\nOnce entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.
", -< "operationId": "PostChargesChargeRefund", -< "parameters": [ -< { -< "in": "path", -< "name": "charge", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "amount": { -< "type": "integer" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "instructions_email": { -< "type": "string" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "payment_intent": { -< "maxLength": 5000, -< "type": "string" -< }, -< "reason": { -< "enum": [ -< "duplicate", -< "fraudulent", -< "requested_by_customer" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "refund_application_fee": { -< "type": "boolean" -< }, -< "reverse_transfer": { -< "type": "boolean" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/charge" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -51381,51509d58386 -< }, -< "post": { -< "description": "Create a refund.
", -< "operationId": "PostChargesChargeRefunds", -< "parameters": [ -< { -< "in": "path", -< "name": "charge", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "amount": { -< "description": "A positive integer representing how much to refund.", -< "type": "integer" -< }, -< "currency": { -< "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", -< "type": "string" -< }, -< "customer": { -< "description": "Customer whose customer balance to refund from.", -< "maxLength": 5000, -< "type": "string" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "instructions_email": { -< "description": "Address to send refund email, use customer email if not specified", -< "type": "string" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "origin": { -< "description": "Origin of the refund", -< "enum": [ -< "customer_balance" -< ], -< "type": "string" -< }, -< "payment_intent": { -< "maxLength": 5000, -< "type": "string" -< }, -< "reason": { -< "enum": [ -< "duplicate", -< "fraudulent", -< "requested_by_customer" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "refund_application_fee": { -< "type": "boolean" -< }, -< "reverse_transfer": { -< "type": "boolean" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/refund" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -51586,51678d58462 -< }, -< "post": { -< "description": "Update a specified refund.
", -< "operationId": "PostChargesChargeRefundsRefund", -< "parameters": [ -< { -< "in": "path", -< "name": "charge", -< "required": true, -< "schema": { -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "refund", -< "required": true, -< "schema": { -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/refund" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -51705a58490 -> "description": "Customer's email address.", -51924a58710,58713 -> "shipping_rates": { -> "explode": true, -> "style": "deepObject" -> }, -51940a58730 -> "description": "Configure a Checkout Session that can be used to recover an expired session.", -51942a58733 -> "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`", -51945a58737 -> "description": "If `true`, a recovery URL will be generated to recover this Checkout Session if it\nexpires before a successful transaction is completed. It will be attached to the\nCheckout Session object upon expiration.", -51966a58759 -> "description": "Set to true to enable automatic taxes.", -51997a58791 -> "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.", -52004a58799 -> "description": "If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).", -52039a58835 -> "description": "Describes whether Checkout saves the billing address onto `customer.address`.\nTo always collect a full billing address, use `billing_address_collection`. Defaults to `never`.", -52047a58844 -> "description": "Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.", -52055a58853 -> "description": "Describes whether Checkout saves shipping information onto `customer.shipping`.\nTo collect shipping information, use `shipping_address_collection`. Defaults to `never`.", -52071a58870 -> "description": "The ID of the coupon to apply to this Session.", -52075a58875 -> "description": "The ID of a promotion code to apply to this Session.", -52102a58903 -> "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.", -52104a58906 -> "description": "Set to true if the quantity can be adjusted to any non-negative integer. By default customers will be able to remove the line item by setting the quantity to 0.", -52107a58910 -> "description": "The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.", -52110a58914 -> "description": "The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.", -52119a58924,58936 -> "amount": { -> "description": "[Deprecated] The amount to be collected per unit of the line item. If specified, must also pass `currency` and `name`.", -> "type": "integer" -> }, -> "currency": { -> "description": "[Deprecated] 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). Required if `amount` is passed.", -> "type": "string" -> }, -> "description": { -> "description": "[Deprecated] The description for the line item, to be displayed on the Checkout page.", -> "maxLength": 5000, -> "type": "string" -> }, -52120a58938 -> "description": "The [tax rates](https://stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.", -52126a58945,58957 -> "images": { -> "description": "[Deprecated] A list of image URLs representing this line item. Each image can be up to 5 MB in size. If passing `price` or `price_data`, specify images on the associated product instead.", -> "items": { -> "maxLength": 5000, -> "type": "string" -> }, -> "type": "array" -> }, -> "name": { -> "description": "[Deprecated] The name for the item to be displayed on the Checkout page. Required if `amount` is passed.", -> "maxLength": 5000, -> "type": "string" -> }, -52127a58959 -> "description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.", -52131a58964 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", -52133a58967 -> "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).", -52136a58971 -> "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.", -52140a58976 -> "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", -52142a58979 -> "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.", -52146a58984 -> "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", -52155a58994 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -52158a58998 -> "description": "The product's name, meant to be displayable to the customer.", -52162a59003 -> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", -52173a59015 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -52175a59018 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -52184a59028 -> "description": "The number of intervals between subscription billings. 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).", -52194a59039 -> "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.", -52202a59048 -> "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", -52205a59052 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -52216a59064 -> "description": "The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.", -52219a59068 -> "description": "The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.", -52299a59149 -> "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).", -52302a59153 -> "description": "Controls when the funds will be captured from the customer's account.", -52309a59161 -> "description": "An arbitrary string attached to the object. Often useful for displaying to users.", -52316a59169 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -52319a59173 -> "description": "The Stripe account ID for which these funds are intended. For details,\nsee the PaymentIntents [use case for connected\naccounts](/docs/payments/connected-accounts).", -52322a59177 -> "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).", -52325a59181 -> "description": "Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment\nmethod collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the\ncustomer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the\ncustomer that their payment details will be saved and used for future\npayments.\n\nIf a Customer has been provided or Checkout creates a new Customer,\nCheckout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached\nto a Customer. To reuse the payment method, you can retrieve it from the\nCheckout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage`\nto dynamically optimize your payment flow and comply with regional\nlegislation and network rules, such as SCA.", -52332a59189 -> "description": "Shipping information for this payment.", -52334a59192 -> "description": "Shipping address.", -52336a59195 -> "description": "City, district, suburb, town, or village.", -52340a59200 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -52344a59205 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -52348a59210 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -52352a59215 -> "description": "ZIP or postal code.", -52356a59220 -> "description": "State, county, province, or region.", -52367a59232 -> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", -52371a59237 -> "description": "Recipient name.", -52375a59242 -> "description": "Recipient phone (including extension).", -52379a59247 -> "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.", -52391a59260 -> "description": "Extra information about the payment. This will appear on your\ncustomer's statement when this payment succeeds in creating a charge.", -52395a59265 -> "description": "Provides information about the charge that customers see on their statements. Concatenated with the\nprefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete\nstatement descriptor. Maximum 22 characters for the concatenated descriptor.", -52399a59270 -> "description": "The parameters used to automatically create a Transfer when the payment succeeds.\nFor more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", -52401a59273 -> "description": "The amount that will be transferred automatically when a charge succeeds.", -52404a59277 -> "description": "If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge's `transfer` field.", -52414a59288 -> "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.", -52432a59307 -> "description": "contains details about the ACSS Debit payment method options.", -52434a59310 -> "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). This is only accepted for Checkout Sessions in `setup` mode.", -52441a59318 -> "description": "Additional fields for Mandate creation", -52454c59331,59332 -< ] ---- -> ], -> "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." -52456a59335 -> "description": "List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.", -52466a59346 -> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", -52470a59351 -> "description": "Payment schedule for the mandate.", -52478a59360 -> "description": "Transaction type of the mandate.", -52489a59372 -> "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).", -52497a59381 -> "description": "Verification method for the intent", -52510a59395 -> "description": "contains details about the Affirm payment method options.", -52512a59398 -> "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).", -52522a59409 -> "description": "contains details about the Afterpay Clearpay payment method options.", -52524a59412 -> "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).", -52534a59423 -> "description": "contains details about the Alipay payment method options.", -52536a59426 -> "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).", -52546a59437 -> "description": "contains details about the AU Becs Debit payment method options.", -52548a59440 -> "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).", -52558a59451 -> "description": "contains details about the Bacs Debit payment method options.", -52560a59454 -> "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).", -52572a59467 -> "description": "contains details about the Bancontact payment method options.", -52574a59470 -> "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).", -52584a59481 -> "description": "contains details about the Boleto payment method options.", -52586a59484 -> "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 invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.", -52589a59488 -> "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).", -52601a59501 -> "description": "contains details about the Card payment method options.", -52603a59504 -> "description": "Installment options for card payments", -52605a59507 -> "description": "Setting to true enables installments for this Checkout Session.\nSetting to false will prevent any installment plan from applying to a payment.", -52612a59515 -> "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).", -52619a59523 -> "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.", -52623a59528 -> "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.", -52631a59537 -> "description": "contains details about the Customer Balance payment method options.", -52633a59540 -> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", -52635a59543 -> "description": "Configuration for eu_bank_transfer funding type.", -52637a59546 -> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.", -52648a59558 -> "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", -52662a59573 -> "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding. Permitted values include: `us_bank_account`, `eu_bank_account`, `id_bank_account`, `gb_bank_account`, `jp_bank_account`, `mx_bank_account`, `eu_bank_transfer`, `gb_bank_transfer`, `id_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", -52679a59591 -> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", -52685a59598 -> "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).", -52695a59609 -> "description": "contains details about the EPS payment method options.", -52697a59612 -> "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).", -52707a59623 -> "description": "contains details about the FPX payment method options.", -52709a59626 -> "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).", -52719a59637 -> "description": "contains details about the Giropay payment method options.", -52721a59640 -> "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).", -52731a59651 -> "description": "contains details about the Grabpay payment method options.", -52733a59654 -> "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).", -52743a59665 -> "description": "contains details about the Ideal payment method options.", -52745a59668 -> "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).", -52755a59679 -> "description": "contains details about the Klarna payment method options.", -52757a59682 -> "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).", -52767a59693 -> "description": "contains details about the Konbini payment method options.", -52769a59696 -> "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.", -52772a59700 -> "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).", -52782a59711 -> "description": "contains details about the OXXO payment method options.", -52784a59714 -> "description": "The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", -52787a59718 -> "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).", -52797a59729 -> "description": "contains details about the P24 payment method options.", -52799a59732 -> "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).", -52805a59739 -> "description": "Confirm that the payer has accepted the P24 terms and conditions.", -52812a59747 -> "description": "contains details about the PayNow payment method options.", -52814a59750 -> "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).", -52819,52821d59754 -< }, -< "tos_shown_and_accepted": { -< "type": "boolean" -52827a59761 -> "description": "contains details about the Pix payment method options.", -52829a59764 -> "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.", -52836a59772 -> "description": "contains details about the Sepa Debit payment method options.", -52838a59775 -> "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).", -52850a59788 -> "description": "contains details about the Sofort payment method options.", -52852a59791 -> "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).", -52862a59802 -> "description": "contains details about the Us Bank Account payment method options.", -52864a59805 -> "description": "Additional fields for Financial Connections Session creation", -52866a59808 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -52884a59827 -> "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).", -52892a59836 -> "description": "Verification method for the intent", -52904a59849 -> "description": "contains details about the WeChat Pay payment method options.", -52906a59852 -> "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", -52910a59857 -> "description": "The client type that the end customer will pay from", -52919a59867 -> "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).", -52976a59925 -> "description": "Set to `true` to enable phone number collection.", -52989a59939 -> "description": "An arbitrary string attached to the object. Often useful for displaying to users.", -52996a59947 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -52999a59951 -> "description": "The Stripe account for which the setup is intended.", -53009a59962 -> "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.", -53265a60219 -> "description": "The ID of the Shipping Rate to use for this shipping option.", -53269a60224 -> "description": "Parameters to be passed to Shipping Rate creation for this shipping option", -53271a60227 -> "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", -53273a60230 -> "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", -53275a60233 -> "description": "A unit of time.", -53285a60244 -> "description": "Must be greater than 0.", -53296a60256 -> "description": "The lower bound of the estimated range. If empty, represents no lower bound.", -53298a60259 -> "description": "A unit of time.", -53308a60270 -> "description": "Must be greater than 0.", -53323a60286 -> "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", -53327a60291 -> "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.", -53329a60294 -> "description": "A non-negative integer in cents representing how much to charge.", -53332a60298 -> "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).", -53338a60305 -> "description": "A non-negative integer in cents representing how much to charge.", -53341a60309 -> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", -53355a60324 -> "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", -53369a60339 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -53372a60343 -> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", -53380a60352 -> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.", -53383a60356 -> "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.", -53401a60375,60381 -> "shipping_rates": { -> "description": "[Deprecated] The shipping rate to apply to this Session. Only up to one may be specified.", -> "items": { -> "type": "string" -> }, -> "type": "array" -> }, -53415a60396 -> "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. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", -53417a60399,60403 -> "coupon": { -> "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", -> "maxLength": 5000, -> "type": "string" -> }, -53418a60405 -> "description": "The tax rates that will apply to any subscription item that does not have\n`tax_rates` set. Invoices created will have their `default_tax_rates` populated\nfrom the subscription.", -53425a60413 -> "description": "The subscription's description, meant to be displayable to the customer.\nUse this field to optionally store an explanation of the subscription\nfor rendering in Stripe hosted surfaces.", -53428a60417,60446 -> "items": { -> "description": "This parameter is deprecated. Use the line_items parameter on the Session instead.", -> "items": { -> "properties": { -> "plan": { -> "description": "Plan ID for this item.", -> "maxLength": 5000, -> "type": "string" -> }, -> "quantity": { -> "description": "The quantity of the subscription item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.", -> "type": "integer" -> }, -> "tax_rates": { -> "description": "The tax rates which apply to this item. When set, the `default_tax_rates`\non `subscription_data` do not apply to this item.", -> "items": { -> "maxLength": 5000, -> "type": "string" -> }, -> "type": "array" -> } -> }, -> "required": [ -> "plan" -> ], -> "title": "subscription_data_item_param", -> "type": "object" -> }, -> "type": "array" -> }, -53432a60451 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -53435a60455 -> "description": "The account on behalf of which to charge, for each of the subscription's invoices.", -53438a60459 -> "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", -53440a60462 -> "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.", -53443a60466 -> "description": "ID of an existing, connected Stripe account.", -53453a60477 -> "description": "Unix timestamp representing the end of the trial period the customer\nwill get before being charged for the first time. Has to be at least\n48 hours in the future.", -53456a60481,60484 -> "trial_from_plan": { -> "description": "Indicates if a plan’s `trial_period_days` should be applied to the subscription. Setting `trial_end` on `subscription_data` is preferred. Defaults to `false`.", -> "type": "boolean" -> }, -53457a60486 -> "description": "Integer representing the number of trial period days before the\ncustomer is charged for the first time. Has to be at least 1.", -53472a60502 -> "description": "Set to true to enable Tax ID collection.", -53997a61028 -> "description": "Minimum value to filter by (exclusive)", -54000a61032 -> "description": "Minimum value to filter by (inclusive)", -54003a61036 -> "description": "Maximum value to filter by (exclusive)", -54006a61040 -> "description": "Maximum value to filter by (inclusive)", -54174a61209 -> "description": "An array of Product IDs that this Coupon will apply to.", -54192a61228 -> "description": "A positive integer representing the amount to subtract from an invoice total.", -54454a61491 -> "description": "A positive integer representing the amount to subtract from an invoice total.", -54722a61760 -> "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.", -54725a61764 -> "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", -54729a61769 -> "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", -54733a61774 -> "description": "The line item quantity to credit.", -54751c61792,61793 -< ] ---- -> ], -> "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item`." -54753a61796 -> "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", -54760a61804 -> "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", -54763a61808 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -54904a61950 -> "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.", -54907a61954 -> "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", -54911a61959 -> "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", -54915a61964 -> "description": "The line item quantity to credit.", -54933c61982,61983 -< ] ---- -> ], -> "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item`." -54935a61986 -> "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", -54942a61994 -> "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", -54945a61998 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -55150a62204 -> "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.", -55153a62208 -> "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", -55157a62213 -> "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", -55161a62218 -> "description": "The line item quantity to credit.", -55179c62236,62237 -< ] ---- -> ], -> "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item`." -55181a62240 -> "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", -55188a62248 -> "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", -55191a62252 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -55728a62790 -> "description": "Minimum value to filter by (exclusive)", -55731a62794 -> "description": "Minimum value to filter by (inclusive)", -55734a62798 -> "description": "Maximum value to filter by (exclusive)", -55737a62802 -> "description": "Maximum value to filter by (inclusive)", -55944a63010 -> "description": "City, district, suburb, town, or village.", -55948a63015 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -55952a63020 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -55956a63025 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -55960a63030 -> "description": "ZIP or postal code.", -55964a63035 -> "description": "State, county, province, or region.", -55988a63060 -> "description": "Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.", -55990a63063 -> "description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).", -56040a63114 -> "description": "The name of the custom field. This may be up to 30 characters.", -56044a63119 -> "description": "The value of the custom field. This may be up to 30 characters.", -56064c63139,63140 -< ] ---- -> ], -> "description": "Default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields." -56066a63143 -> "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.", -56070a63148 -> "description": "Default footer to be displayed on invoices for this customer.", -56078a63157 -> "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", -56096c63175,63176 -< ] ---- -> ], -> "description": "Default options for invoice PDF rendering for this customer." -56154a63235 -> "description": "Customer shipping address.", -56156a63238 -> "description": "City, district, suburb, town, or village.", -56160a63243 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -56164a63248 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -56168a63253 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -56172a63258 -> "description": "ZIP or postal code.", -56176a63263 -> "description": "State, county, province, or region.", -56184a63272 -> "description": "Customer name.", -56188a63277 -> "description": "Customer phone (including extension).", -56228c63317,63318 -< ] ---- -> ], -> "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." -56248a63339 -> "description": "Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `bg_uic`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ph_tin`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`", -56306a63398 -> "description": "Value of the tax ID.", -56322a63415,63417 -> }, -> "validate": { -> "type": "boolean" -56460a63556 -> "next_page", -56635,56642d63730 -< "bank_account": { -< "explode": true, -< "style": "deepObject" -< }, -< "card": { -< "explode": true, -< "style": "deepObject" -< }, -56679a63768 -> "description": "City, district, suburb, town, or village.", -56683a63773 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -56687a63778 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -56691a63783 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -56695a63788 -> "description": "ZIP or postal code.", -56699a63793 -> "description": "State, county, province, or region.", -56720,56848d63813 -< "bank_account": { -< "anyOf": [ -< { -< "properties": { -< "account_holder_name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "account_holder_type": { -< "enum": [ -< "company", -< "individual" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "account_number": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "currency": { -< "type": "string" -< }, -< "object": { -< "enum": [ -< "bank_account" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "routing_number": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "account_number", -< "country" -< ], -< "title": "customer_payment_source_bank_account", -< "type": "object" -< }, -< { -< "maxLength": 5000, -< "type": "string" -< } -< ], -< "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." -< }, -< "card": { -< "anyOf": [ -< { -< "properties": { -< "address_city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_state": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_zip": { -< "maxLength": 5000, -< "type": "string" -< }, -< "cvc": { -< "maxLength": 5000, -< "type": "string" -< }, -< "exp_month": { -< "type": "integer" -< }, -< "exp_year": { -< "type": "integer" -< }, -< "metadata": { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< "name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "number": { -< "maxLength": 5000, -< "type": "string" -< }, -< "object": { -< "enum": [ -< "card" -< ], -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "exp_month", -< "exp_year", -< "number" -< ], -< "title": "customer_payment_source_card", -< "type": "object" -< }, -< { -< "maxLength": 5000, -< "type": "string" -< } -< ], -< "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).", -< "x-stripeBypassValidation": true -< }, -56852a63818 -> "description": "Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.", -56854a63821 -> "description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).", -56873,56887d63839 -< "default_alipay_account": { -< "description": "ID of Alipay account to make the customer's new default for invoice payments.", -< "maxLength": 500, -< "type": "string" -< }, -< "default_bank_account": { -< "description": "ID of bank account to make the customer's new default for invoice payments.", -< "maxLength": 500, -< "type": "string" -< }, -< "default_card": { -< "description": "ID of card to make the customer's new default for invoice payments.", -< "maxLength": 500, -< "type": "string" -< }, -56924a63877 -> "description": "The name of the custom field. This may be up to 30 characters.", -56928a63882 -> "description": "The value of the custom field. This may be up to 30 characters.", -56948c63902,63903 -< ] ---- -> ], -> "description": "Default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields." -56950a63906 -> "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.", -56954a63911 -> "description": "Default footer to be displayed on invoices for this customer.", -56962a63920 -> "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", -56980c63938,63939 -< ] ---- -> ], -> "description": "Default options for invoice PDF rendering for this customer." -57034a63994 -> "description": "Customer shipping address.", -57036a63997 -> "description": "City, district, suburb, town, or village.", -57040a64002 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -57044a64007 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -57048a64012 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -57052a64017 -> "description": "ZIP or postal code.", -57056a64022 -> "description": "State, county, province, or region.", -57064a64031 -> "description": "Customer name.", -57068a64036 -> "description": "Customer phone (including extension).", -57108c64076,64077 -< ] ---- -> ], -> "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." -57122a64092,64094 -> }, -> "validate": { -> "type": "boolean" -57572,59128d64543 -< "/v1/customers/{customer}/bank_accounts": { -< "get": { -< "deprecated": true, -< "description": "You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.
When you create a new credit card, you must specify a customer or recipient on which to create it.
\n\nIf the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.
Delete a specified source for a given customer.
", -< "operationId": "DeleteCustomersCustomerBankAccountsId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "anyOf": [ -< { -< "$ref": "#/components/schemas/payment_source" -< }, -< { -< "$ref": "#/components/schemas/deleted_payment_source" -< } -< ] -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "get": { -< "deprecated": true, -< "description": "By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.
", -< "operationId": "GetCustomersCustomerBankAccountsId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/bank_account" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "Update a specified source for a given customer.
", -< "operationId": "PostCustomersCustomerBankAccountsId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< }, -< "owner": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "account_holder_name": { -< "description": "The name of the person or business that owns the bank account.", -< "maxLength": 5000, -< "type": "string" -< }, -< "account_holder_type": { -< "description": "The type of entity that holds the account. This can be either `individual` or `company`.", -< "enum": [ -< "company", -< "individual" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "address_city": { -< "description": "City/District/Suburb/Town/Village.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_country": { -< "description": "Billing address country, if provided when creating card.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line1": { -< "description": "Address line 1 (Street address/PO Box/Company name).", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line2": { -< "description": "Address line 2 (Apartment/Suite/Unit/Building).", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_state": { -< "description": "State/County/Province/Region.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_zip": { -< "description": "ZIP or postal code.", -< "maxLength": 5000, -< "type": "string" -< }, -< "exp_month": { -< "description": "Two digit number representing the card’s expiration month.", -< "maxLength": 5000, -< "type": "string" -< }, -< "exp_year": { -< "description": "Four digit number representing the card’s expiration year.", -< "maxLength": 5000, -< "type": "string" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Set of [key-value pairs](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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "name": { -< "description": "Cardholder name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "owner": { -< "properties": { -< "address": { -< "properties": { -< "city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "source_address", -< "type": "object" -< }, -< "email": { -< "type": "string" -< }, -< "name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "phone": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "owner", -< "type": "object" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "anyOf": [ -< { -< "$ref": "#/components/schemas/card" -< }, -< { -< "$ref": "#/components/schemas/bank_account" -< }, -< { -< "$ref": "#/components/schemas/source" -< } -< ] -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/customers/{customer}/bank_accounts/{id}/verify": { -< "post": { -< "description": "Verify a specified bank account for a given customer.
", -< "operationId": "PostCustomersCustomerBankAccountsIdVerify", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "amounts": { -< "explode": true, -< "style": "deepObject" -< }, -< "expand": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "amounts": { -< "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.", -< "items": { -< "type": "integer" -< }, -< "type": "array" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/bank_account" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/customers/{customer}/cards": { -< "get": { -< "deprecated": true, -< "description": "You can see a list of the cards belonging to a customer.\nNote that the 10 most recent sources are always available on the Customer object.\nIf you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.
When you create a new credit card, you must specify a customer or recipient on which to create it.
\n\nIf the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.
Delete a specified source for a given customer.
", -< "operationId": "DeleteCustomersCustomerCardsId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "anyOf": [ -< { -< "$ref": "#/components/schemas/payment_source" -< }, -< { -< "$ref": "#/components/schemas/deleted_payment_source" -< } -< ] -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "get": { -< "deprecated": true, -< "description": "You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.
", -< "operationId": "GetCustomersCustomerCardsId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/card" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "Update a specified source for a given customer.
", -< "operationId": "PostCustomersCustomerCardsId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< }, -< "owner": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "account_holder_name": { -< "description": "The name of the person or business that owns the bank account.", -< "maxLength": 5000, -< "type": "string" -< }, -< "account_holder_type": { -< "description": "The type of entity that holds the account. This can be either `individual` or `company`.", -< "enum": [ -< "company", -< "individual" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "address_city": { -< "description": "City/District/Suburb/Town/Village.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_country": { -< "description": "Billing address country, if provided when creating card.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line1": { -< "description": "Address line 1 (Street address/PO Box/Company name).", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line2": { -< "description": "Address line 2 (Apartment/Suite/Unit/Building).", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_state": { -< "description": "State/County/Province/Region.", -< "maxLength": 5000, -< "type": "string" -< }, -< "address_zip": { -< "description": "ZIP or postal code.", -< "maxLength": 5000, -< "type": "string" -< }, -< "exp_month": { -< "description": "Two digit number representing the card’s expiration month.", -< "maxLength": 5000, -< "type": "string" -< }, -< "exp_year": { -< "description": "Four digit number representing the card’s expiration year.", -< "maxLength": 5000, -< "type": "string" -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Set of [key-value pairs](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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "name": { -< "description": "Cardholder name.", -< "maxLength": 5000, -< "type": "string" -< }, -< "owner": { -< "properties": { -< "address": { -< "properties": { -< "city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "postal_code": { -< "maxLength": 5000, -< "type": "string" -< }, -< "state": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "source_address", -< "type": "object" -< }, -< "email": { -< "type": "string" -< }, -< "name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "phone": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "title": "owner", -< "type": "object" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "anyOf": [ -< { -< "$ref": "#/components/schemas/card" -< }, -< { -< "$ref": "#/components/schemas/bank_account" -< }, -< { -< "$ref": "#/components/schemas/source" -< } -< ] -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -59238a64654 -> "description": "Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).", -59495,59547c64911,64912 -< "description": "Removes the currently applied discount on a customer.
", -< "operationId": "DeleteCustomersCustomerDiscount", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/deleted_discount" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "get": { -< "description": "", -< "operationId": "GetCustomersCustomerDiscount", ---- -> "description": "Removes the currently applied discount on a customer.
", -> "operationId": "DeleteCustomersCustomerDiscount", -59558,59572d64922 -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -59593c64943 -< "$ref": "#/components/schemas/discount" ---- -> "$ref": "#/components/schemas/deleted_discount" -59647a64998 -> "description": "Configuration for eu_bank_transfer funding type.", -59649a65001 -> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.", -59660a65013 -> "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", -59673a65027 -> "description": "The type of the `bank_transfer`", -59821a65176 -> "card_present", -60092,60104c65447 -< "anyOf": [ -< { -< "$ref": "#/components/schemas/bank_account" -< }, -< { -< "$ref": "#/components/schemas/card" -< }, -< { -< "$ref": "#/components/schemas/source" -< } -< ], -< "title": "Polymorphic", -< "x-stripeBypassValidation": true ---- -> "$ref": "#/components/schemas/payment_source" -60172,60179d65514 -< "bank_account": { -< "explode": true, -< "style": "deepObject" -< }, -< "card": { -< "explode": true, -< "style": "deepObject" -< }, -60192,60325d65526 -< "alipay_account": { -< "description": "A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.", -< "maxLength": 5000, -< "type": "string" -< }, -< "bank_account": { -< "anyOf": [ -< { -< "properties": { -< "account_holder_name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "account_holder_type": { -< "enum": [ -< "company", -< "individual" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "account_number": { -< "maxLength": 5000, -< "type": "string" -< }, -< "country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "currency": { -< "type": "string" -< }, -< "object": { -< "enum": [ -< "bank_account" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< "routing_number": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "account_number", -< "country" -< ], -< "title": "customer_payment_source_bank_account", -< "type": "object" -< }, -< { -< "maxLength": 5000, -< "type": "string" -< } -< ], -< "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details." -< }, -< "card": { -< "anyOf": [ -< { -< "properties": { -< "address_city": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_country": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line1": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_line2": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_state": { -< "maxLength": 5000, -< "type": "string" -< }, -< "address_zip": { -< "maxLength": 5000, -< "type": "string" -< }, -< "cvc": { -< "maxLength": 5000, -< "type": "string" -< }, -< "exp_month": { -< "type": "integer" -< }, -< "exp_year": { -< "type": "integer" -< }, -< "metadata": { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< "name": { -< "maxLength": 5000, -< "type": "string" -< }, -< "number": { -< "maxLength": 5000, -< "type": "string" -< }, -< "object": { -< "enum": [ -< "card" -< ], -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "exp_month", -< "exp_year", -< "number" -< ], -< "title": "customer_payment_source_card", -< "type": "object" -< }, -< { -< "maxLength": 5000, -< "type": "string" -< } -< ], -< "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).", -< "x-stripeBypassValidation": true -< }, -60345a65547,65549 -> }, -> "validate": { -> "type": "boolean" -60347a65552,65554 -> "required": [ -> "source" -> ], -60352c65559 -< "required": false ---- -> "required": true -60667a65875 -> "description": "Owner's address.", -60669a65878 -> "description": "City, district, suburb, town, or village.", -60673a65883 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -60677a65888 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -60681a65893 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -60685a65898 -> "description": "ZIP or postal code.", -60689a65903 -> "description": "State, county, province, or region.", -60697a65912 -> "description": "Owner's email address.", -60700a65916 -> "description": "Owner's full name.", -60704a65921 -> "description": "Owner's phone number.", -60841,62956d66057 -< "/v1/customers/{customer}/subscriptions": { -< "get": { -< "description": "You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.
", -< "operationId": "GetCustomersCustomerSubscriptions", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", -< "in": "query", -< "name": "ending_before", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", -< "in": "query", -< "name": "limit", -< "required": false, -< "schema": { -< "type": "integer" -< }, -< "style": "form" -< }, -< { -< "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", -< "in": "query", -< "name": "starting_after", -< "required": false, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "form" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "description": "", -< "properties": { -< "data": { -< "description": "Details about each object.", -< "items": { -< "$ref": "#/components/schemas/subscription" -< }, -< "type": "array" -< }, -< "has_more": { -< "description": "True if this list has another page of items after this one that can be fetched.", -< "type": "boolean" -< }, -< "object": { -< "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", -< "enum": [ -< "list" -< ], -< "type": "string" -< }, -< "url": { -< "description": "The URL where this list can be accessed.", -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "data", -< "has_more", -< "object", -< "url" -< ], -< "title": "SubscriptionList", -< "type": "object", -< "x-expandableFields": [ -< "data" -< ] -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "Creates a new subscription on an existing customer.
", -< "operationId": "PostCustomersCustomerSubscriptions", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "add_invoice_items": { -< "explode": true, -< "style": "deepObject" -< }, -< "automatic_tax": { -< "explode": true, -< "style": "deepObject" -< }, -< "billing_thresholds": { -< "explode": true, -< "style": "deepObject" -< }, -< "default_tax_rates": { -< "explode": true, -< "style": "deepObject" -< }, -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "items": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< }, -< "payment_settings": { -< "explode": true, -< "style": "deepObject" -< }, -< "pending_invoice_item_interval": { -< "explode": true, -< "style": "deepObject" -< }, -< "transfer_data": { -< "explode": true, -< "style": "deepObject" -< }, -< "trial_end": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "add_invoice_items": { -< "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", -< "items": { -< "properties": { -< "price": { -< "maxLength": 5000, -< "type": "string" -< }, -< "price_data": { -< "properties": { -< "currency": { -< "type": "string" -< }, -< "product": { -< "maxLength": 5000, -< "type": "string" -< }, -< "tax_behavior": { -< "enum": [ -< "exclusive", -< "inclusive", -< "unspecified" -< ], -< "type": "string" -< }, -< "unit_amount": { -< "type": "integer" -< }, -< "unit_amount_decimal": { -< "format": "decimal", -< "type": "string" -< } -< }, -< "required": [ -< "currency", -< "product" -< ], -< "title": "one_time_price_data", -< "type": "object" -< }, -< "quantity": { -< "type": "integer" -< }, -< "tax_rates": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< } -< }, -< "title": "add_invoice_item_entry", -< "type": "object" -< }, -< "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", -< "type": "number" -< }, -< "automatic_tax": { -< "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", -< "properties": { -< "enabled": { -< "type": "boolean" -< } -< }, -< "required": [ -< "enabled" -< ], -< "title": "automatic_tax_config", -< "type": "object" -< }, -< "backdate_start_date": { -< "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", -< "format": "unix-time", -< "type": "integer" -< }, -< "billing_cycle_anchor": { -< "description": "A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.", -< "format": "unix-time", -< "type": "integer", -< "x-stripeBypassValidation": true -< }, -< "billing_thresholds": { -< "anyOf": [ -< { -< "properties": { -< "amount_gte": { -< "type": "integer" -< }, -< "reset_billing_cycle_anchor": { -< "type": "boolean" -< } -< }, -< "title": "billing_thresholds_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." -< }, -< "cancel_at": { -< "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", -< "format": "unix-time", -< "type": "integer" -< }, -< "cancel_at_period_end": { -< "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", -< "type": "boolean" -< }, -< "collection_method": { -< "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", -< "enum": [ -< "charge_automatically", -< "send_invoice" -< ], -< "type": "string" -< }, -< "coupon": { -< "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", -< "maxLength": 5000, -< "type": "string" -< }, -< "currency": { -< "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", -< "type": "string" -< }, -< "days_until_due": { -< "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", -< "type": "integer" -< }, -< "default_payment_method": { -< "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).", -< "maxLength": 5000, -< "type": "string" -< }, -< "default_source": { -< "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `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).", -< "maxLength": 5000, -< "type": "string" -< }, -< "default_tax_rates": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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." -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "items": { -< "description": "A list of up to 20 subscription items, each with an attached price.", -< "items": { -< "properties": { -< "billing_thresholds": { -< "anyOf": [ -< { -< "properties": { -< "usage_gte": { -< "type": "integer" -< } -< }, -< "required": [ -< "usage_gte" -< ], -< "title": "item_billing_thresholds_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "metadata": { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< "price": { -< "maxLength": 5000, -< "type": "string" -< }, -< "price_data": { -< "properties": { -< "currency": { -< "type": "string" -< }, -< "product": { -< "maxLength": 5000, -< "type": "string" -< }, -< "recurring": { -< "properties": { -< "interval": { -< "enum": [ -< "day", -< "month", -< "week", -< "year" -< ], -< "type": "string" -< }, -< "interval_count": { -< "type": "integer" -< } -< }, -< "required": [ -< "interval" -< ], -< "title": "recurring_adhoc", -< "type": "object" -< }, -< "tax_behavior": { -< "enum": [ -< "exclusive", -< "inclusive", -< "unspecified" -< ], -< "type": "string" -< }, -< "unit_amount": { -< "type": "integer" -< }, -< "unit_amount_decimal": { -< "format": "decimal", -< "type": "string" -< } -< }, -< "required": [ -< "currency", -< "product", -< "recurring" -< ], -< "title": "recurring_price_data", -< "type": "object" -< }, -< "quantity": { -< "type": "integer" -< }, -< "tax_rates": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< } -< }, -< "title": "subscription_item_create_params", -< "type": "object" -< }, -< "type": "array" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "off_session": { -< "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", -< "type": "boolean" -< }, -< "payment_behavior": { -< "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.", -< "enum": [ -< "allow_incomplete", -< "default_incomplete", -< "error_if_incomplete", -< "pending_if_incomplete" -< ], -< "type": "string" -< }, -< "payment_settings": { -< "description": "Payment settings to pass to invoices created by the subscription.", -< "properties": { -< "payment_method_options": { -< "properties": { -< "acss_debit": { -< "anyOf": [ -< { -< "properties": { -< "mandate_options": { -< "properties": { -< "transaction_type": { -< "enum": [ -< "business", -< "personal" -< ], -< "type": "string" -< } -< }, -< "title": "mandate_options_param", -< "type": "object" -< }, -< "verification_method": { -< "enum": [ -< "automatic", -< "instant", -< "microdeposits" -< ], -< "type": "string", -< "x-stripeBypassValidation": true -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "bancontact": { -< "anyOf": [ -< { -< "properties": { -< "preferred_language": { -< "enum": [ -< "de", -< "en", -< "fr", -< "nl" -< ], -< "type": "string" -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "card": { -< "anyOf": [ -< { -< "properties": { -< "mandate_options": { -< "properties": { -< "amount": { -< "type": "integer" -< }, -< "amount_type": { -< "enum": [ -< "fixed", -< "maximum" -< ], -< "type": "string" -< }, -< "description": { -< "maxLength": 200, -< "type": "string" -< } -< }, -< "title": "mandate_options_param", -< "type": "object" -< }, -< "network": { -< "enum": [ -< "amex", -< "cartes_bancaires", -< "diners", -< "discover", -< "interac", -< "jcb", -< "mastercard", -< "unionpay", -< "unknown", -< "visa" -< ], -< "maxLength": 5000, -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "request_three_d_secure": { -< "enum": [ -< "any", -< "automatic" -< ], -< "type": "string" -< } -< }, -< "title": "subscription_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "customer_balance": { -< "anyOf": [ -< { -< "properties": { -< "bank_transfer": { -< "properties": { -< "eu_bank_transfer": { -< "properties": { -< "country": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "country" -< ], -< "title": "eu_bank_transfer_param", -< "type": "object" -< }, -< "type": { -< "type": "string" -< } -< }, -< "title": "bank_transfer_param", -< "type": "object" -< }, -< "funding_type": { -< "type": "string" -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "konbini": { -< "anyOf": [ -< { -< "properties": {}, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "us_bank_account": { -< "anyOf": [ -< { -< "properties": { -< "financial_connections": { -< "properties": { -< "permissions": { -< "items": { -< "enum": [ -< "balances", -< "ownership", -< "payment_method", -< "transactions" -< ], -< "maxLength": 5000, -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "type": "array" -< } -< }, -< "title": "invoice_linked_account_options_param", -< "type": "object" -< }, -< "verification_method": { -< "enum": [ -< "automatic", -< "instant", -< "microdeposits" -< ], -< "type": "string", -< "x-stripeBypassValidation": true -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< } -< }, -< "title": "payment_method_options", -< "type": "object" -< }, -< "payment_method_types": { -< "anyOf": [ -< { -< "items": { -< "enum": [ -< "ach_credit_transfer", -< "ach_debit", -< "acss_debit", -< "au_becs_debit", -< "bacs_debit", -< "bancontact", -< "boleto", -< "card", -< "customer_balance", -< "fpx", -< "giropay", -< "grabpay", -< "ideal", -< "konbini", -< "link", -< "paynow", -< "promptpay", -< "sepa_debit", -< "sofort", -< "us_bank_account", -< "wechat_pay" -< ], -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "save_default_payment_method": { -< "enum": [ -< "off", -< "on_subscription" -< ], -< "type": "string" -< } -< }, -< "title": "payment_settings", -< "type": "object" -< }, -< "pending_invoice_item_interval": { -< "anyOf": [ -< { -< "properties": { -< "interval": { -< "enum": [ -< "day", -< "month", -< "week", -< "year" -< ], -< "type": "string" -< }, -< "interval_count": { -< "type": "integer" -< } -< }, -< "required": [ -< "interval" -< ], -< "title": "pending_invoice_item_interval_params", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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." -< }, -< "promotion_code": { -< "description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", -< "maxLength": 5000, -< "type": "string" -< }, -< "proration_behavior": { -< "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", -< "enum": [ -< "always_invoice", -< "create_prorations", -< "none" -< ], -< "type": "string" -< }, -< "transfer_data": { -< "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.", -< "properties": { -< "amount_percent": { -< "type": "number" -< }, -< "destination": { -< "type": "string" -< } -< }, -< "required": [ -< "destination" -< ], -< "title": "transfer_data_specs", -< "type": "object" -< }, -< "trial_end": { -< "anyOf": [ -< { -< "enum": [ -< "now" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< { -< "format": "unix-time", -< "type": "integer" -< } -< ], -< "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more." -< }, -< "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. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", -< "type": "boolean" -< }, -< "trial_period_days": { -< "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", -< "type": "integer" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/subscription" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { -< "delete": { -< "description": "Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.
Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
\n\nBy default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
", -< "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "subscription_exposed_id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "expand": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "invoice_now": { -< "description": "Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.", -< "type": "boolean" -< }, -< "prorate": { -< "description": "Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end.", -< "type": "boolean" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/subscription" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "get": { -< "description": "Retrieves the subscription with the given ID.
", -< "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "subscription_exposed_id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/subscription" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "post": { -< "description": "Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
", -< "operationId": "PostCustomersCustomerSubscriptionsSubscriptionExposedId", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "subscription_exposed_id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": { -< "add_invoice_items": { -< "explode": true, -< "style": "deepObject" -< }, -< "automatic_tax": { -< "explode": true, -< "style": "deepObject" -< }, -< "billing_thresholds": { -< "explode": true, -< "style": "deepObject" -< }, -< "cancel_at": { -< "explode": true, -< "style": "deepObject" -< }, -< "default_tax_rates": { -< "explode": true, -< "style": "deepObject" -< }, -< "expand": { -< "explode": true, -< "style": "deepObject" -< }, -< "items": { -< "explode": true, -< "style": "deepObject" -< }, -< "metadata": { -< "explode": true, -< "style": "deepObject" -< }, -< "pause_collection": { -< "explode": true, -< "style": "deepObject" -< }, -< "payment_settings": { -< "explode": true, -< "style": "deepObject" -< }, -< "pending_invoice_item_interval": { -< "explode": true, -< "style": "deepObject" -< }, -< "transfer_data": { -< "explode": true, -< "style": "deepObject" -< }, -< "trial_end": { -< "explode": true, -< "style": "deepObject" -< } -< }, -< "schema": { -< "additionalProperties": false, -< "properties": { -< "add_invoice_items": { -< "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", -< "items": { -< "properties": { -< "price": { -< "maxLength": 5000, -< "type": "string" -< }, -< "price_data": { -< "properties": { -< "currency": { -< "type": "string" -< }, -< "product": { -< "maxLength": 5000, -< "type": "string" -< }, -< "tax_behavior": { -< "enum": [ -< "exclusive", -< "inclusive", -< "unspecified" -< ], -< "type": "string" -< }, -< "unit_amount": { -< "type": "integer" -< }, -< "unit_amount_decimal": { -< "format": "decimal", -< "type": "string" -< } -< }, -< "required": [ -< "currency", -< "product" -< ], -< "title": "one_time_price_data", -< "type": "object" -< }, -< "quantity": { -< "type": "integer" -< }, -< "tax_rates": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< } -< }, -< "title": "add_invoice_item_entry", -< "type": "object" -< }, -< "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", -< "type": "number" -< }, -< "automatic_tax": { -< "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", -< "properties": { -< "enabled": { -< "type": "boolean" -< } -< }, -< "required": [ -< "enabled" -< ], -< "title": "automatic_tax_config", -< "type": "object" -< }, -< "billing_cycle_anchor": { -< "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", -< "enum": [ -< "now", -< "unchanged" -< ], -< "maxLength": 5000, -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "billing_thresholds": { -< "anyOf": [ -< { -< "properties": { -< "amount_gte": { -< "type": "integer" -< }, -< "reset_billing_cycle_anchor": { -< "type": "boolean" -< } -< }, -< "title": "billing_thresholds_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." -< }, -< "cancel_at": { -< "anyOf": [ -< { -< "format": "unix-time", -< "type": "integer" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." -< }, -< "cancel_at_period_end": { -< "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", -< "type": "boolean" -< }, -< "collection_method": { -< "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.", -< "enum": [ -< "charge_automatically", -< "send_invoice" -< ], -< "type": "string" -< }, -< "coupon": { -< "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", -< "maxLength": 5000, -< "type": "string" -< }, -< "days_until_due": { -< "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.", -< "type": "integer" -< }, -< "default_payment_method": { -< "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).", -< "maxLength": 5000, -< "type": "string" -< }, -< "default_source": { -< "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `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).", -< "maxLength": 5000, -< "type": "string" -< }, -< "default_tax_rates": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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. Pass an empty string to remove previously-defined tax rates." -< }, -< "expand": { -< "description": "Specifies which fields in the response should be expanded.", -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "items": { -< "description": "A list of up to 20 subscription items, each with an attached price.", -< "items": { -< "properties": { -< "billing_thresholds": { -< "anyOf": [ -< { -< "properties": { -< "usage_gte": { -< "type": "integer" -< } -< }, -< "required": [ -< "usage_gte" -< ], -< "title": "item_billing_thresholds_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "clear_usage": { -< "type": "boolean" -< }, -< "deleted": { -< "type": "boolean" -< }, -< "id": { -< "maxLength": 5000, -< "type": "string" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "price": { -< "maxLength": 5000, -< "type": "string" -< }, -< "price_data": { -< "properties": { -< "currency": { -< "type": "string" -< }, -< "product": { -< "maxLength": 5000, -< "type": "string" -< }, -< "recurring": { -< "properties": { -< "interval": { -< "enum": [ -< "day", -< "month", -< "week", -< "year" -< ], -< "type": "string" -< }, -< "interval_count": { -< "type": "integer" -< } -< }, -< "required": [ -< "interval" -< ], -< "title": "recurring_adhoc", -< "type": "object" -< }, -< "tax_behavior": { -< "enum": [ -< "exclusive", -< "inclusive", -< "unspecified" -< ], -< "type": "string" -< }, -< "unit_amount": { -< "type": "integer" -< }, -< "unit_amount_decimal": { -< "format": "decimal", -< "type": "string" -< } -< }, -< "required": [ -< "currency", -< "product", -< "recurring" -< ], -< "title": "recurring_price_data", -< "type": "object" -< }, -< "quantity": { -< "type": "integer" -< }, -< "tax_rates": { -< "anyOf": [ -< { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< } -< }, -< "title": "subscription_item_update_params", -< "type": "object" -< }, -< "type": "array" -< }, -< "metadata": { -< "anyOf": [ -< { -< "additionalProperties": { -< "type": "string" -< }, -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -< }, -< "off_session": { -< "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", -< "type": "boolean" -< }, -< "pause_collection": { -< "anyOf": [ -< { -< "properties": { -< "behavior": { -< "enum": [ -< "keep_as_draft", -< "mark_uncollectible", -< "void" -< ], -< "type": "string" -< }, -< "resumes_at": { -< "format": "unix-time", -< "type": "integer" -< } -< }, -< "required": [ -< "behavior" -< ], -< "title": "pause_collection_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "If specified, payment collection for this subscription will be paused." -< }, -< "payment_behavior": { -< "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", -< "enum": [ -< "allow_incomplete", -< "default_incomplete", -< "error_if_incomplete", -< "pending_if_incomplete" -< ], -< "type": "string" -< }, -< "payment_settings": { -< "description": "Payment settings to pass to invoices created by the subscription.", -< "properties": { -< "payment_method_options": { -< "properties": { -< "acss_debit": { -< "anyOf": [ -< { -< "properties": { -< "mandate_options": { -< "properties": { -< "transaction_type": { -< "enum": [ -< "business", -< "personal" -< ], -< "type": "string" -< } -< }, -< "title": "mandate_options_param", -< "type": "object" -< }, -< "verification_method": { -< "enum": [ -< "automatic", -< "instant", -< "microdeposits" -< ], -< "type": "string", -< "x-stripeBypassValidation": true -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "bancontact": { -< "anyOf": [ -< { -< "properties": { -< "preferred_language": { -< "enum": [ -< "de", -< "en", -< "fr", -< "nl" -< ], -< "type": "string" -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "card": { -< "anyOf": [ -< { -< "properties": { -< "mandate_options": { -< "properties": { -< "amount": { -< "type": "integer" -< }, -< "amount_type": { -< "enum": [ -< "fixed", -< "maximum" -< ], -< "type": "string" -< }, -< "description": { -< "maxLength": 200, -< "type": "string" -< } -< }, -< "title": "mandate_options_param", -< "type": "object" -< }, -< "network": { -< "enum": [ -< "amex", -< "cartes_bancaires", -< "diners", -< "discover", -< "interac", -< "jcb", -< "mastercard", -< "unionpay", -< "unknown", -< "visa" -< ], -< "maxLength": 5000, -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "request_three_d_secure": { -< "enum": [ -< "any", -< "automatic" -< ], -< "type": "string" -< } -< }, -< "title": "subscription_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "customer_balance": { -< "anyOf": [ -< { -< "properties": { -< "bank_transfer": { -< "properties": { -< "eu_bank_transfer": { -< "properties": { -< "country": { -< "maxLength": 5000, -< "type": "string" -< } -< }, -< "required": [ -< "country" -< ], -< "title": "eu_bank_transfer_param", -< "type": "object" -< }, -< "type": { -< "type": "string" -< } -< }, -< "title": "bank_transfer_param", -< "type": "object" -< }, -< "funding_type": { -< "type": "string" -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "konbini": { -< "anyOf": [ -< { -< "properties": {}, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "us_bank_account": { -< "anyOf": [ -< { -< "properties": { -< "financial_connections": { -< "properties": { -< "permissions": { -< "items": { -< "enum": [ -< "balances", -< "ownership", -< "payment_method", -< "transactions" -< ], -< "maxLength": 5000, -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "type": "array" -< } -< }, -< "title": "invoice_linked_account_options_param", -< "type": "object" -< }, -< "verification_method": { -< "enum": [ -< "automatic", -< "instant", -< "microdeposits" -< ], -< "type": "string", -< "x-stripeBypassValidation": true -< } -< }, -< "title": "invoice_payment_method_options_param", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< } -< }, -< "title": "payment_method_options", -< "type": "object" -< }, -< "payment_method_types": { -< "anyOf": [ -< { -< "items": { -< "enum": [ -< "ach_credit_transfer", -< "ach_debit", -< "acss_debit", -< "au_becs_debit", -< "bacs_debit", -< "bancontact", -< "boleto", -< "card", -< "customer_balance", -< "fpx", -< "giropay", -< "grabpay", -< "ideal", -< "konbini", -< "link", -< "paynow", -< "promptpay", -< "sepa_debit", -< "sofort", -< "us_bank_account", -< "wechat_pay" -< ], -< "type": "string", -< "x-stripeBypassValidation": true -< }, -< "type": "array" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ] -< }, -< "save_default_payment_method": { -< "enum": [ -< "off", -< "on_subscription" -< ], -< "type": "string" -< } -< }, -< "title": "payment_settings", -< "type": "object" -< }, -< "pending_invoice_item_interval": { -< "anyOf": [ -< { -< "properties": { -< "interval": { -< "enum": [ -< "day", -< "month", -< "week", -< "year" -< ], -< "type": "string" -< }, -< "interval_count": { -< "type": "integer" -< } -< }, -< "required": [ -< "interval" -< ], -< "title": "pending_invoice_item_interval_params", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "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." -< }, -< "promotion_code": { -< "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", -< "maxLength": 5000, -< "type": "string" -< }, -< "proration_behavior": { -< "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes.", -< "enum": [ -< "always_invoice", -< "create_prorations", -< "none" -< ], -< "type": "string" -< }, -< "proration_date": { -< "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.", -< "format": "unix-time", -< "type": "integer" -< }, -< "transfer_data": { -< "anyOf": [ -< { -< "properties": { -< "amount_percent": { -< "type": "number" -< }, -< "destination": { -< "type": "string" -< } -< }, -< "required": [ -< "destination" -< ], -< "title": "transfer_data_specs", -< "type": "object" -< }, -< { -< "enum": [ -< "" -< ], -< "type": "string" -< } -< ], -< "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value." -< }, -< "trial_end": { -< "anyOf": [ -< { -< "enum": [ -< "now" -< ], -< "maxLength": 5000, -< "type": "string" -< }, -< { -< "format": "unix-time", -< "type": "integer" -< } -< ], -< "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`." -< }, -< "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. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", -< "type": "boolean" -< } -< }, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/subscription" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -< "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { -< "delete": { -< "description": "Removes the currently applied discount on a customer.
", -< "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "subscription_exposed_id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/deleted_discount" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< }, -< "get": { -< "description": "", -< "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount", -< "parameters": [ -< { -< "in": "path", -< "name": "customer", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "subscription_exposed_id", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/discount" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -63387a66489 -> "description": "Minimum value to filter by (exclusive)", -63390a66493 -> "description": "Minimum value to filter by (inclusive)", -63393a66497 -> "description": "Maximum value to filter by (exclusive)", -63396a66501 -> "description": "Maximum value to filter by (inclusive)", -63647a66753 -> "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. Has a maximum character count of 20,000.", -63651a66758 -> "description": "The billing address provided by the customer.", -63655a66763 -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.", -63658a66767 -> "description": "An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.", -63662a66772 -> "description": "A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000.", -63666a66777 -> "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.", -63669a66781 -> "description": "The email address of the customer.", -63673a66786 -> "description": "The name of the customer.", -63677a66791 -> "description": "The IP address that the customer used when making the purchase.", -63681a66796 -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.", -63684a66800 -> "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.", -63687a66804 -> "description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000.", -63691a66809 -> "description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.", -63695a66814 -> "description": "A description of the product or service that was sold. Has a maximum character count of 20,000.", -63699a66819 -> "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.", -63702a66823 -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.", -63705a66827 -> "description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.", -63709a66832 -> "description": "A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000.", -63713a66837 -> "description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.", -63717a66842 -> "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.", -63720a66846 -> "description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.", -63724a66851 -> "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.", -63728a66856 -> "description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.", -63732a66861 -> "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.", -63735a66865 -> "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.", -63739a66870 -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.", -63742a66874 -> "description": "Any additional evidence or statements. Has a maximum character count of 20,000.", -64023a67156 -> "description": "Minimum value to filter by (exclusive)", -64026a67160 -> "description": "Minimum value to filter by (inclusive)", -64029a67164 -> "description": "Maximum value to filter by (exclusive)", -64032a67168 -> "description": "Maximum value to filter by (inclusive)", -64479a67616 -> "description": "Minimum value to filter by (exclusive)", -64482a67620 -> "description": "Minimum value to filter by (inclusive)", -64485a67624 -> "description": "Maximum value to filter by (exclusive)", -64488a67628 -> "description": "Maximum value to filter by (inclusive)", -64922a68063 -> "description": "Minimum value to filter by (exclusive)", -64925a68067 -> "description": "Minimum value to filter by (inclusive)", -64928a68071 -> "description": "Maximum value to filter by (exclusive)", -64931a68075 -> "description": "Maximum value to filter by (inclusive)", -65128a68273 -> "description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.", -65131a68277 -> "description": "A future timestamp after which the link will no longer be usable.", -65149c68295,68296 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -65296a68444 -> "description": "The ID of the Stripe account whose accounts will be retrieved.", -65300a68449 -> "description": "The ID of the Stripe customer whose accounts will be retrieved.", -65842a68992 -> "description": "The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.", -65846a68997 -> "description": "The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.", -65850a69002 -> "description": "Type of account holder to collect accounts for.", -65875a69028 -> "description": "List of countries from which to collect accounts.", -66026a69180 -> "description": "Minimum value to filter by (exclusive)", -66029a69184 -> "description": "Minimum value to filter by (inclusive)", -66032a69188 -> "description": "Maximum value to filter by (exclusive)", -66035a69192 -> "description": "Maximum value to filter by (inclusive)", -66278a69436 -> "description": "Minimum value to filter by (exclusive)", -66281a69440 -> "description": "Minimum value to filter by (inclusive)", -66284a69444 -> "description": "Maximum value to filter by (exclusive)", -66287a69448 -> "description": "Maximum value to filter by (inclusive)", -66482a69644 -> "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", -66493a69656 -> "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", -66496a69660 -> "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", -66499a69664 -> "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", -66512c69677,69678 -< ] ---- -> ], -> "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)." -66689a69856 -> "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", -66700a69868 -> "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.", -66703a69872 -> "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", -66706a69876 -> "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).", -66719c69889,69890 -< ] ---- -> ], -> "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)." -66913a70085 -> "description": "Minimum value to filter by (exclusive)", -66916a70089 -> "description": "Minimum value to filter by (inclusive)", -66919a70093 -> "description": "Maximum value to filter by (exclusive)", -66922a70097 -> "description": "Maximum value to filter by (inclusive)", -67154a70330 -> "description": "ID of the coupon to create a new discount for.", -67158a70335 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -67210a70388 -> "description": "The end of the period, which must be greater than or equal to the start.", -67214a70393 -> "description": "The start of the period.", -67234a70414 -> "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).", -67237a70418 -> "description": "The ID of the product that this price will belong to.", -67241a70423 -> "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.", -67249a70432 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -67252a70436 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -67534a70719 -> "description": "ID of the coupon to create a new discount for.", -67538a70724 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -67585a70772 -> "description": "The end of the period, which must be greater than or equal to the start.", -67589a70777 -> "description": "The start of the period.", -67609a70798 -> "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).", -67612a70802 -> "description": "The ID of the product that this price will belong to.", -67616a70807 -> "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.", -67624a70816 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -67627a70820 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -67752a70946 -> "description": "Minimum value to filter by (exclusive)", -67755a70950 -> "description": "Minimum value to filter by (inclusive)", -67758a70954 -> "description": "Maximum value to filter by (exclusive)", -67761a70958 -> "description": "Maximum value to filter by (inclusive)", -67795a70993 -> "description": "Minimum value to filter by (exclusive)", -67798a70997 -> "description": "Minimum value to filter by (inclusive)", -67801a71001 -> "description": "Maximum value to filter by (exclusive)", -67804a71005 -> "description": "Maximum value to filter by (inclusive)", -68051a71253 -> "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", -68078a71281 -> "description": "The name of the custom field. This may be up to 30 characters.", -68082a71286 -> "description": "The value of the custom field. This may be up to 30 characters.", -68142a71347 -> "description": "ID of the coupon to create a new discount for.", -68146a71352 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -68186a71393 -> "description": "The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted", -68193a71401 -> "description": "The `id` of the invoice that will be cloned.", -68229a71438 -> "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.", -68233a71443 -> "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.", -68239a71450 -> "description": "Additional fields for Mandate creation", -68241a71453 -> "description": "Transaction type of the mandate.", -68252a71465 -> "description": "Verification method for the intent", -68271c71484,71485 -< ] ---- -> ], -> "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." -68277a71492 -> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", -68296c71511,71512 -< ] ---- -> ], -> "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." -68302a71519 -> "description": "Installment configuration for payments attempted on this invoice (Mexico Only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", -68304a71522 -> "description": "Setting to true enables installments for this invoice.\nSetting to false will prevent any selected plan from applying to a payment.", -68311a71530 -> "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", -68314a71534 -> "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", -68320a71541 -> "description": "Type of installment plan, one of `fixed_count`.", -68341c71562,71563 -< ] ---- -> ], -> "description": "The selected installment plan to use for this invoice." -68347a71570 -> "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.", -68364c71587,71588 -< ] ---- -> ], -> "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." -68370a71595 -> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", -68372a71598 -> "description": "Configuration for eu_bank_transfer funding type.", -68374a71601 -> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.", -68385a71613 -> "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", -68392a71621 -> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", -68405c71634,71635 -< ] ---- -> ], -> "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." -68420c71650,71651 -< ] ---- -> ], -> "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." -68426a71658 -> "description": "Additional fields for Financial Connections Session creation", -68428a71661 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -68446a71680 -> "description": "Verification method for the intent", -68465c71699,71700 -< ] ---- -> ], -> "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." -68492a71728 -> "sepa_credit_transfer", -68509c71745,71746 -< ] ---- -> ], -> "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)." -68528a71766 -> "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", -68562a71801 -> "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.", -68565a71805 -> "description": "ID of an existing, connected Stripe account.", -68711a71952 -> "next_page", -68751a71993 -> "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", -68807a72050 -> "description": "City, district, suburb, town, or village.", -68811a72055 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -68815a72060 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -68819a72065 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -68823a72070 -> "description": "ZIP or postal code.", -68827a72075 -> "description": "State, county, province, or region.", -68841c72089,72090 -< ] ---- -> ], -> "description": "The customer's address." -68847a72097 -> "description": "Customer shipping address.", -68849a72100 -> "description": "City, district, suburb, town, or village.", -68853a72105 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -68857a72110 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -68861a72115 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -68865a72120 -> "description": "ZIP or postal code.", -68869a72125 -> "description": "State, county, province, or region.", -68877a72134 -> "description": "Customer name.", -68881a72139 -> "description": "Customer phone (including extension).", -68899c72157,72158 -< ] ---- -> ], -> "description": "The customer's shipping information. Appears on invoices emailed to this customer." -68901a72161 -> "description": "Tax details about the customer.", -68914c72174,72175 -< ] ---- -> ], -> "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." -68920a72182 -> "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", -68929a72192 -> "description": "The customer's tax IDs.", -68932a72196 -> "description": "Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `bg_uic`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ph_tin`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`", -68990a72255 -> "description": "Value of the tax ID.", -69020a72286 -> "description": "ID of the coupon to create a new discount for.", -69024a72291 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -69068a72336 -> "description": "The integer amount in cents (or local equivalent) of previewed invoice item.", -69071a72340 -> "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). Only applicable to new invoice items.", -69074a72344 -> "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", -69078a72349 -> "description": "Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.", -69086a72358 -> "description": "ID of the coupon to create a new discount for.", -69090a72363 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -69106c72379,72380 -< ] ---- -> ], -> "description": "The coupons to redeem into discounts for the invoice item in the preview." -69108a72383 -> "description": "The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.", -69126c72401,72402 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -69128a72405 -> "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice.", -69130a72408 -> "description": "The end of the period, which must be greater than or equal to the start.", -69134a72413 -> "description": "The start of the period.", -69146a72426 -> "description": "The ID of the price object.", -69150a72431 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -69152a72434 -> "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).", -69155a72438 -> "description": "The ID of the product that this price will belong to.", -69159a72443 -> "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.", -69167a72452 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -69170a72456 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -69182a72469 -> "description": "Non-negative integer. The quantity of units for the invoice item.", -69185a72473 -> "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.", -69204c72492,72493 -< ] ---- -> ], -> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." -69221c72510,72511 -< ] ---- -> ], -> "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item." -69223a72514 -> "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.", -69226a72518 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -69364a72657 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -69380c72673,72674 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." -69382a72677 -> "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", -69385a72681 -> "description": "A flag that, if set to `true`, will delete the specified item.", -69388a72685 -> "description": "Subscription item to update.", -69406c72703,72709 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -> }, -> "plan": { -> "description": "Plan ID for this item, as a string.", -> "maxLength": 5000, -> "type": "string" -69408a72712 -> "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", -69412a72717 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -69414a72720 -> "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).", -69417a72724 -> "description": "The ID of the product that this price will belong to.", -69421a72729 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -69423a72732 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -69432a72742 -> "description": "The number of intervals between subscription billings. 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).", -69442a72753 -> "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.", -69450a72762 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -69453a72766 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -69466a72780 -> "description": "Quantity for this item.", -69484c72798,72799 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." -69615a72931 -> "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", -69671a72988 -> "description": "City, district, suburb, town, or village.", -69675a72993 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -69679a72998 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -69683a73003 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -69687a73008 -> "description": "ZIP or postal code.", -69691a73013 -> "description": "State, county, province, or region.", -69705c73027,73028 -< ] ---- -> ], -> "description": "The customer's address." -69711a73035 -> "description": "Customer shipping address.", -69713a73038 -> "description": "City, district, suburb, town, or village.", -69717a73043 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -69721a73048 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -69725a73053 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -69729a73058 -> "description": "ZIP or postal code.", -69733a73063 -> "description": "State, county, province, or region.", -69741a73072 -> "description": "Customer name.", -69745a73077 -> "description": "Customer phone (including extension).", -69763c73095,73096 -< ] ---- -> ], -> "description": "The customer's shipping information. Appears on invoices emailed to this customer." -69765a73099 -> "description": "Tax details about the customer.", -69778c73112,73113 -< ] ---- -> ], -> "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." -69784a73120 -> "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", -69793a73130 -> "description": "The customer's tax IDs.", -69796a73134 -> "description": "Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `bg_uic`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ph_tin`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`", -69854a73193 -> "description": "Value of the tax ID.", -69884a73224 -> "description": "ID of the coupon to create a new discount for.", -69888a73229 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -69943a73285 -> "description": "The integer amount in cents (or local equivalent) of previewed invoice item.", -69946a73289 -> "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). Only applicable to new invoice items.", -69949a73293 -> "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", -69953a73298 -> "description": "Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.", -69961a73307 -> "description": "ID of the coupon to create a new discount for.", -69965a73312 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -69981c73328,73329 -< ] ---- -> ], -> "description": "The coupons to redeem into discounts for the invoice item in the preview." -69983a73332 -> "description": "The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.", -70001c73350,73351 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -70003a73354 -> "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice.", -70005a73357 -> "description": "The end of the period, which must be greater than or equal to the start.", -70009a73362 -> "description": "The start of the period.", -70021a73375 -> "description": "The ID of the price object.", -70025a73380 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -70027a73383 -> "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).", -70030a73387 -> "description": "The ID of the product that this price will belong to.", -70034a73392 -> "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.", -70042a73401 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -70045a73405 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -70057a73418 -> "description": "Non-negative integer. The quantity of units for the invoice item.", -70060a73422 -> "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.", -70079c73441,73442 -< ] ---- -> ], -> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." -70096c73459,73460 -< ] ---- -> ], -> "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item." -70098a73463 -> "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.", -70101a73467 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -70260a73627 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -70276c73643,73644 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." -70278a73647 -> "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", -70281a73651 -> "description": "A flag that, if set to `true`, will delete the specified item.", -70284a73655 -> "description": "Subscription item to update.", -70302c73673,73679 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -> }, -> "plan": { -> "description": "Plan ID for this item, as a string.", -> "maxLength": 5000, -> "type": "string" -70304a73682 -> "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", -70308a73687 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -70310a73690 -> "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).", -70313a73694 -> "description": "The ID of the product that this price will belong to.", -70317a73699 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -70319a73702 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -70328a73712 -> "description": "The number of intervals between subscription billings. 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).", -70338a73723 -> "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.", -70346a73732 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -70349a73736 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -70362a73750 -> "description": "Quantity for this item.", -70380c73768,73769 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." -70748a74138 -> "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", -70771a74162 -> "description": "The name of the custom field. This may be up to 30 characters.", -70775a74167 -> "description": "The value of the custom field. This may be up to 30 characters.", -70840a74233 -> "description": "ID of the coupon to create a new discount for.", -70844a74238 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -70915a74310 -> "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.", -70919a74315 -> "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.", -70925a74322 -> "description": "Additional fields for Mandate creation", -70927a74325 -> "description": "Transaction type of the mandate.", -70938a74337 -> "description": "Verification method for the intent", -70957c74356,74357 -< ] ---- -> ], -> "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." -70963a74364 -> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", -70982c74383,74384 -< ] ---- -> ], -> "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." -70988a74391 -> "description": "Installment configuration for payments attempted on this invoice (Mexico Only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).", -70990a74394 -> "description": "Setting to true enables installments for this invoice.\nSetting to false will prevent any selected plan from applying to a payment.", -70997a74402 -> "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", -71000a74406 -> "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", -71006a74413 -> "description": "Type of installment plan, one of `fixed_count`.", -71027c74434,74435 -< ] ---- -> ], -> "description": "The selected installment plan to use for this invoice." -71033a74442 -> "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.", -71050c74459,74460 -< ] ---- -> ], -> "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." -71056a74467 -> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", -71058a74470 -> "description": "Configuration for eu_bank_transfer funding type.", -71060a74473 -> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.", -71071a74485 -> "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", -71078a74493 -> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", -71091c74506,74507 -< ] ---- -> ], -> "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." -71106c74522,74523 -< ] ---- -> ], -> "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." -71112a74530 -> "description": "Additional fields for Financial Connections Session creation", -71114a74533 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -71132a74552 -> "description": "Verification method for the intent", -71151c74571,74572 -< ] ---- -> ], -> "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." -71178a74600 -> "sepa_credit_transfer", -71195c74617,74618 -< ] ---- -> ], -> "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)." -71205a74629 -> "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.", -71235a74660 -> "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.", -71238a74664 -> "description": "ID of an existing, connected Stripe account.", -71827a75254 -> "description": "Minimum value to filter by (exclusive)", -71830a75258 -> "description": "Minimum value to filter by (inclusive)", -71833a75262 -> "description": "Maximum value to filter by (exclusive)", -71836a75266 -> "description": "Maximum value to filter by (inclusive)", -72335a75766 -> "description": "Minimum value to filter by (exclusive)", -72338a75770 -> "description": "Minimum value to filter by (inclusive)", -72341a75774 -> "description": "Maximum value to filter by (exclusive)", -72344a75778 -> "description": "Maximum value to filter by (inclusive)", -72566a76001 -> "description": "The cardholder’s billing address.", -72568a76004 -> "description": "City, district, suburb, town, or village.", -72572a76009 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -72576a76014 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -72580a76019 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -72584a76024 -> "description": "ZIP or postal code.", -72588a76029 -> "description": "State, county, province, or region.", -72612a76054 -> "description": "The entity's business ID number.", -72635a76078 -> "description": "The date of birth of this cardholder.", -72637a76081 -> "description": "The day of birth, between 1 and 31.", -72640a76085 -> "description": "The month of birth, between 1 and 12.", -72643a76089 -> "description": "The four-digit year of birth.", -72655a76102 -> "description": "The first name of this cardholder. This field cannot contain any special characters or numbers.", -72658a76106 -> "description": "The last name of this cardholder. This field cannot contain any special characters or numbers.", -72661a76110 -> "description": "Government-issued ID document for this cardholder.", -72663a76113 -> "description": "An identifying document, either a passport or local ID card.", -72665a76116 -> "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`.", -72669a76121 -> "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`.", -72707a76160 -> "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`.", -73004a76458 -> "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`.", -73301a76756 -> "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", -73304a76760 -> "description": "Maximum amount allowed to spend per interval.", -73307a76764 -> "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.", -73604a77062 -> "description": "Interval (or event) to which the amount applies.", -73625a77084 -> "description": "Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.", -73802a77262 -> "description": "The cardholder’s billing address.", -73804a77265 -> "description": "City, district, suburb, town, or village.", -73808a77270 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -73812a77275 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -73816a77280 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -73820a77285 -> "description": "ZIP or postal code.", -73824a77290 -> "description": "State, county, province, or region.", -73848a77315 -> "description": "The entity's business ID number.", -73871a77339 -> "description": "The date of birth of this cardholder.", -73873a77342 -> "description": "The day of birth, between 1 and 31.", -73876a77346 -> "description": "The month of birth, between 1 and 12.", -73879a77350 -> "description": "The four-digit year of birth.", -73891a77363 -> "description": "The first name of this cardholder. This field cannot contain any special characters or numbers.", -73894a77367 -> "description": "The last name of this cardholder. This field cannot contain any special characters or numbers.", -73897a77371 -> "description": "Government-issued ID document for this cardholder.", -73899a77374 -> "description": "An identifying document, either a passport or local ID card.", -73901a77377 -> "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`.", -73905a77382 -> "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`.", -73939a77417 -> "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`.", -74236a77715 -> "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`.", -74533a78013 -> "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", -74536a78017 -> "description": "Maximum amount allowed to spend per interval.", -74539a78021 -> "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.", -74836a78319 -> "description": "Interval (or event) to which the amount applies.", -74857a78341 -> "description": "Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.", -74929a78414 -> "description": "Minimum value to filter by (exclusive)", -74932a78418 -> "description": "Minimum value to filter by (inclusive)", -74935a78422 -> "description": "Maximum value to filter by (exclusive)", -74938a78426 -> "description": "Maximum value to filter by (inclusive)", -75206a78695 -> "description": "The address that the card is shipped to.", -75208a78698 -> "description": "City, district, suburb, town, or village.", -75212a78703 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -75216a78708 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -75220a78713 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -75224a78718 -> "description": "ZIP or postal code.", -75228a78723 -> "description": "State, county, province, or region.", -75242a78738 -> "description": "Customs information for the shipment.", -75244a78741 -> "description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.", -75252a78750 -> "description": "The name printed on the shipping label when shipping the card.", -75256a78755 -> "description": "Phone number of the recipient of the shipment.", -75259a78759 -> "description": "Whether a signature is required for card delivery.", -75262a78763 -> "description": "Shipment service.", -75271a78773 -> "description": "Packaging options.", -75289a78792 -> "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`.", -75586a79090 -> "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`.", -75883a79388 -> "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).", -75886a79392 -> "description": "Maximum amount allowed to spend per interval.", -75889a79396 -> "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.", -76186a79694 -> "description": "Interval (or event) to which the amount applies.", -76404a79913 -> "description": "The card's desired new PIN, encrypted under Stripe's public key.", -76415a79925 -> "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`.", -76712a80223 -> "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`.", -77009a80521 -> "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).", -77012a80525 -> "description": "Maximum amount allowed to spend per interval.", -77015a80529 -> "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.", -77312a80827 -> "description": "Interval (or event) to which the amount applies.", -77393a80909 -> "description": "Minimum value to filter by (exclusive)", -77396a80913 -> "description": "Minimum value to filter by (inclusive)", -77399a80917 -> "description": "Maximum value to filter by (exclusive)", -77402a80921 -> "description": "Maximum value to filter by (inclusive)", -77613c81132,81133 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -77627c81147,81148 -< ] ---- -> ], -> "description": "Date when order was canceled." -77640c81161,81162 -< ] ---- -> ], -> "description": "Whether the cardholder was provided with a cancellation policy." -77642a81165 -> "description": "Reason for canceling the order.", -77658c81181,81182 -< ] ---- -> ], -> "description": "Date when the cardholder expected to receive the product." -77660a81185 -> "description": "Explanation of why the cardholder is disputing this transaction.", -77664a81190 -> "description": "Description of the merchandise or service that was purchased.", -77668a81195 -> "description": "Whether the product was a merchandise or service.", -77676a81204 -> "description": "Result of cardholder's attempt to return the product.", -77696c81224,81225 -< ] ---- -> ], -> "description": "Date when the product was returned or attempted to be returned." -77708c81237,81238 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'canceled'." -77725c81255,81256 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -77738c81269,81270 -< ] ---- -> ], -> "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." -77751c81283,81284 -< ] ---- -> ], -> "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." -77764c81297,81298 -< ] ---- -> ], -> "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." -77766a81301 -> "description": "Explanation of why the cardholder is disputing this transaction.", -77770a81306 -> "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.", -77784c81320,81321 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'duplicate'." -77801c81338,81339 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -77803a81342 -> "description": "Explanation of why the cardholder is disputing this transaction.", -77817c81356,81357 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'fraudulent'." -77834c81374,81375 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -77836a81378 -> "description": "Explanation of why the cardholder is disputing this transaction.", -77852c81394,81395 -< ] ---- -> ], -> "description": "Date when the product was received." -77854a81398 -> "description": "Description of the cardholder's attempt to return the product.", -77858a81403 -> "description": "Result of cardholder's attempt to return the product.", -77878c81423,81424 -< ] ---- -> ], -> "description": "Date when the product was returned or attempted to be returned." -77890c81436,81437 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'merchandise_not_as_described'." -77907c81454,81455 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -77921c81469,81470 -< ] ---- -> ], -> "description": "Date when the cardholder expected to receive the product." -77923a81473 -> "description": "Explanation of why the cardholder is disputing this transaction.", -77927a81478 -> "description": "Description of the merchandise or service that was purchased.", -77931a81483 -> "description": "Whether the product was a merchandise or service.", -77949c81501,81502 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'not_received'." -77966c81519,81520 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -77968a81523 -> "description": "Explanation of why the cardholder is disputing this transaction.", -77972a81528 -> "description": "Description of the merchandise or service that was purchased.", -77976a81533 -> "description": "Whether the product was a merchandise or service.", -77994c81551,81552 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'other'." -77996a81555 -> "description": "The reason for filing the dispute. The evidence should be submitted in the field of the same name.", -78024c81583,81584 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78038c81598,81599 -< ] ---- -> ], -> "description": "Date when order was canceled." -78040a81602 -> "description": "Reason for canceling the order.", -78044a81607 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78060c81623,81624 -< ] ---- -> ], -> "description": "Date when the product was received." -78072c81636,81637 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'service_not_as_described'." -78101a81667 -> "description": "The ID of the ReceivedDebit to initiate an Issuings dispute for.", -78267c81833,81834 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78281c81848,81849 -< ] ---- -> ], -> "description": "Date when order was canceled." -78294c81862,81863 -< ] ---- -> ], -> "description": "Whether the cardholder was provided with a cancellation policy." -78296a81866 -> "description": "Reason for canceling the order.", -78312c81882,81883 -< ] ---- -> ], -> "description": "Date when the cardholder expected to receive the product." -78314a81886 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78318a81891 -> "description": "Description of the merchandise or service that was purchased.", -78322a81896 -> "description": "Whether the product was a merchandise or service.", -78330a81905 -> "description": "Result of cardholder's attempt to return the product.", -78350c81925,81926 -< ] ---- -> ], -> "description": "Date when the product was returned or attempted to be returned." -78362c81938,81939 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'canceled'." -78379c81956,81957 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78392c81970,81971 -< ] ---- -> ], -> "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." -78405c81984,81985 -< ] ---- -> ], -> "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." -78418c81998,81999 -< ] ---- -> ], -> "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." -78420a82002 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78424a82007 -> "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.", -78438c82021,82022 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'duplicate'." -78455c82039,82040 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78457a82043 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78471c82057,82058 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'fraudulent'." -78488c82075,82076 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78490a82079 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78506c82095,82096 -< ] ---- -> ], -> "description": "Date when the product was received." -78508a82099 -> "description": "Description of the cardholder's attempt to return the product.", -78512a82104 -> "description": "Result of cardholder's attempt to return the product.", -78532c82124,82125 -< ] ---- -> ], -> "description": "Date when the product was returned or attempted to be returned." -78544c82137,82138 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'merchandise_not_as_described'." -78561c82155,82156 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78575c82170,82171 -< ] ---- -> ], -> "description": "Date when the cardholder expected to receive the product." -78577a82174 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78581a82179 -> "description": "Description of the merchandise or service that was purchased.", -78585a82184 -> "description": "Whether the product was a merchandise or service.", -78603c82202,82203 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'not_received'." -78620c82220,82221 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78622a82224 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78626a82229 -> "description": "Description of the merchandise or service that was purchased.", -78630a82234 -> "description": "Whether the product was a merchandise or service.", -78648c82252,82253 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'other'." -78650a82256 -> "description": "The reason for filing the dispute. The evidence should be submitted in the field of the same name.", -78678c82284,82285 -< ] ---- -> ], -> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." -78692c82299,82300 -< ] ---- -> ], -> "description": "Date when order was canceled." -78694a82303 -> "description": "Reason for canceling the order.", -78698a82308 -> "description": "Explanation of why the cardholder is disputing this transaction.", -78714c82324,82325 -< ] ---- -> ], -> "description": "Date when the product was received." -78726c82337,82338 -< ] ---- -> ], -> "description": "Evidence provided when `reason` is 'service_not_as_described'." -78876,79178d82487 -< "/v1/issuing/settlements": { -< "get": { -< "description": "Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing Settlement object.
Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
Retrieves the details of a Financial Connections Session
Returns a list of Financial Connections Account objects.
Retrieves the details of an Financial Connections Account.
Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
Lists all owners for a given Account
Refreshes the data associated with a Financial Connections Account.
Returns a list of PaymentMethods attached to the StripeAccount. For listing a customer’s payment methods, you should use List a Customer’s PaymentMethods
", ---- -> "description": "Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
", -92086a95564 -> "card_present", -92330a95809 -> "description": "Customer's bank account number.", -92334a95814 -> "description": "Institution number of the customer's bank.", -92338a95819 -> "description": "Transit number of the customer's bank.", -92372a95854 -> "description": "The account number for the bank account.", -92376a95859 -> "description": "Bank-State-Branch number of the bank account.", -92391a95875 -> "description": "Account number of the bank account that the funds will be debited from.", -92395a95880 -> "description": "Sort code of the bank account. (e.g., `10-20-30`)", -92416a95902 -> "description": "City, district, suburb, town, or village.", -92420a95907 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -92424a95912 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -92428a95917 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -92432a95922 -> "description": "ZIP or postal code.", -92436a95927 -> "description": "State, county, province, or region.", -92450c95941,95942 -< ] ---- -> ], -> "description": "Billing address." -92463c95955,95956 -< ] ---- -> ], -> "description": "Email address." -92465a95959 -> "description": "Full name.", -92469a95964 -> "description": "Billing phone number (including extension).", -92486a95982 -> "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", -92501a95998 -> "description": "The card's CVC. It is highly recommended to always include this value.", -92505a96003 -> "description": "Two-digit number representing the card's expiration month.", -92508a96007 -> "description": "Four-digit number representing the card's expiration year.", -92511a96011 -> "description": "The card number, as a string without any separators.", -92522c96022,96025 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "CardDetails" -> } -92535c96038,96041 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "Token" -> } -92555a96062 -> "description": "The customer's bank.", -92603a96111,96119 -> "account_holder_type": { -> "description": "Account holder type for FPX transaction", -> "enum": [ -> "company", -> "individual" -> ], -> "maxLength": 5000, -> "type": "string" -> }, -92604a96121 -> "description": "The customer's bank.", -92655a96173 -> "description": "The customer's bank.", -92687a96206 -> "description": "Customer's date of birth", -92689a96209 -> "description": "The day of birth, between 1 and 31.", -92692a96213 -> "description": "The month of birth, between 1 and 12.", -92695a96217 -> "description": "The four-digit year of birth.", -92739a96262 -> "description": "The customer's bank.", -92800a96324 -> "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", -92811a96336 -> "description": "IBAN of the bank account.", -92825a96351 -> "description": "Two-letter ISO code representing the country the bank account is located in.", -92881a96408 -> "description": "Account holder type: individual or company.", -92888a96416 -> "description": "Account number of the bank account.", -92892a96421 -> "description": "Account type: checkings or savings. Defaults to checking if omitted.", -92899a96429 -> "description": "The ID of a Financial Connections Account to use as a payment method.", -92903a96434 -> "description": "Routing number of the bank account.", -93033a96565,96580 -> "acss_debit": { -> "explode": true, -> "style": "deepObject" -> }, -> "affirm": { -> "explode": true, -> "style": "deepObject" -> }, -> "au_becs_debit": { -> "explode": true, -> "style": "deepObject" -> }, -> "bacs_debit": { -> "explode": true, -> "style": "deepObject" -> }, -93037a96585,96588 -> "blik": { -> "explode": true, -> "style": "deepObject" -> }, -93053a96605,96608 -> "sepa_debit": { -> "explode": true, -> "style": "deepObject" -> }, -93061a96617,96640 -> "acss_debit": { -> "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.", -> "properties": {}, -> "title": "update_param", -> "type": "object" -> }, -> "affirm": { -> "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.", -> "properties": {}, -> "title": "param", -> "type": "object" -> }, -> "au_becs_debit": { -> "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.", -> "properties": {}, -> "title": "update_param", -> "type": "object" -> }, -> "bacs_debit": { -> "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.", -> "properties": {}, -> "title": "update_param", -> "type": "object" -> }, -93069a96649 -> "description": "City, district, suburb, town, or village.", -93073a96654 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -93077a96659 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -93081a96664 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -93085a96669 -> "description": "ZIP or postal code.", -93089a96674 -> "description": "State, county, province, or region.", -93103c96688,96689 -< ] ---- -> ], -> "description": "Billing address." -93116c96702,96703 -< ] ---- -> ], -> "description": "Email address." -93118a96706 -> "description": "Full name.", -93122a96711 -> "description": "Billing phone number (including extension).", -93129a96719,96724 -> "blik": { -> "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.", -> "properties": {}, -> "title": "param", -> "type": "object" -> }, -93133a96729 -> "description": "Two-digit number representing the card's expiration month.", -93136a96733 -> "description": "Four-digit number representing the card's expiration year.", -93173a96771,96776 -> "sepa_debit": { -> "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.", -> "properties": {}, -> "title": "update_param", -> "type": "object" -> }, -93177a96781 -> "description": "Bank account type.", -93375a96980 -> "description": "Minimum value to filter by (exclusive)", -93378a96984 -> "description": "Minimum value to filter by (inclusive)", -93381a96988 -> "description": "Maximum value to filter by (exclusive)", -93384a96992 -> "description": "Maximum value to filter by (inclusive)", -93407a97016 -> "description": "Minimum value to filter by (exclusive)", -93410a97020 -> "description": "Minimum value to filter by (inclusive)", -93413a97024 -> "description": "Maximum value to filter by (exclusive)", -93416a97028 -> "description": "Maximum value to filter by (inclusive)", -94008a97621 -> "description": "Minimum value to filter by (exclusive)", -94011a97625 -> "description": "Minimum value to filter by (inclusive)", -94014a97629 -> "description": "Maximum value to filter by (exclusive)", -94017a97633 -> "description": "Maximum value to filter by (inclusive)", -94283a97900 -> "description": "Whether the product is currently available for purchase. Defaults to `true`.", -94286a97904 -> "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", -94293a97912 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -94296a97916 -> "description": "The product's name, meant to be displayable to the customer.", -94300a97921 -> "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.", -94304a97926 -> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", -94308a97931 -> "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.", -94330a97954 -> "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", -94333a97958 -> "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", -94337a97963 -> "description": "The per unit billing amount for each individual unit for which this tier applies.", -94340a97967 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -94356c97983,97984 -< ] ---- -> ], -> "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." -94378a98007 -> "description": "Divide usage by this number.", -94381a98011 -> "description": "After division, either round the result `up` or `down`.", -94691a98322 -> "description": "Minimum value to filter by (exclusive)", -94694a98326 -> "description": "Minimum value to filter by (inclusive)", -94697a98330 -> "description": "Maximum value to filter by (exclusive)", -94700a98334 -> "description": "Maximum value to filter by (inclusive)", -94794a98429 -> "description": "Filter by billing frequency. Either `day`, `week`, `month` or `year`.", -94803a98439 -> "description": "Filter by the usage type for this price. Can be either `metered` or `licensed`.", -94977a98614 -> "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", -94979a98617 -> "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", -94982a98621 -> "description": "The maximum unit amount the customer can specify for this item.", -94985a98625 -> "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", -94988a98629 -> "description": "The starting unit amount which can be updated by the customer.", -94998a98640 -> "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.", -95006a98649 -> "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", -95009a98653 -> "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", -95012a98657 -> "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", -95016a98662 -> "description": "The per unit billing amount for each individual unit for which this tier applies.", -95019a98666 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -95035c98682,98683 -< ] ---- -> ], -> "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." -95046a98695 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -95049a98699 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -95063a98714 -> "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", -95066a98718 -> "description": "The maximum unit amount the customer can specify for this item.", -95069a98722 -> "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", -95072a98726 -> "description": "The starting unit amount which can be updated by the customer.", -95115a98770 -> "description": "Whether the product is currently available for purchase. Defaults to `true`.", -95118a98774 -> "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", -95125a98782 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -95128a98786 -> "description": "The product's name, meant to be displayable to the customer.", -95132a98791 -> "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.", -95136a98796 -> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", -95140a98801 -> "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.", -95154a98816 -> "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`.", -95163a98826 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -95172a98836,98840 -> "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", -> "type": "integer" -> }, -> "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).", -95175a98844 -> "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`.", -95202a98872 -> "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", -95205a98876 -> "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", -95209a98881 -> "description": "The per unit billing amount for each individual unit for which this tier applies.", -95212a98885 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -95228c98901,98902 -< ] ---- -> ], -> "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." -95254a98929 -> "description": "Divide usage by this number.", -95257a98933 -> "description": "After division, either round the result `up` or `down`.", -95420a99097 -> "next_page", -95543a99221,99224 -> }, -> "recurring": { -> "explode": true, -> "style": "deepObject" -95558a99240 -> "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", -95560a99243 -> "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", -95563a99247 -> "description": "The maximum unit amount the customer can specify for this item.", -95566a99251 -> "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", -95569a99255 -> "description": "The starting unit amount which can be updated by the customer.", -95579a99266 -> "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.", -95587a99275 -> "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", -95590a99279 -> "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", -95593a99283 -> "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", -95597a99288 -> "description": "The per unit billing amount for each individual unit for which this tier applies.", -95600a99292 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -95616c99308,99309 -< ] ---- -> ], -> "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." -95627a99321 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -95630a99325 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -95683a99379,99399 -> "recurring": { -> "anyOf": [ -> { -> "properties": { -> "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": "integer" -> } -> }, -> "title": "update_recurring_params", -> "type": "object" -> }, -> { -> "enum": [ -> "" -> ], -> "type": "string" -> } -> ], -> "description": "The recurring components of a price such as `interval` and `usage_type`." -> }, -95753a99470 -> "description": "Minimum value to filter by (exclusive)", -95756a99474 -> "description": "Minimum value to filter by (inclusive)", -95759a99478 -> "description": "Maximum value to filter by (exclusive)", -95762a99482 -> "description": "Maximum value to filter by (inclusive)", -95848a99569,99582 -> "description": "Only return products of this type.", -> "in": "query", -> "name": "type", -> "required": false, -> "schema": { -> "enum": [ -> "good", -> "service" -> ], -> "type": "string" -> }, -> "style": "form" -> }, -> { -95939a99674,99681 -> "attributes": { -> "explode": true, -> "style": "deepObject" -> }, -> "deactivate_on": { -> "explode": true, -> "style": "deepObject" -> }, -95967a99710,99730 -> "attributes": { -> "description": "A list of up to 5 alphanumeric attributes. Should only be set if type=`good`.", -> "items": { -> "maxLength": 5000, -> "type": "string" -> }, -> "type": "array" -> }, -> "caption": { -> "description": "A short one-line description of the product, meant to be displayable to the customer. May only be set if type=`good`.", -> "maxLength": 5000, -> "type": "string" -> }, -> "deactivate_on": { -> "description": "An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if type=`good`.", -> "items": { -> "maxLength": 5000, -> "type": "string" -> }, -> "type": "array" -> }, -95971a99735 -> "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).", -95977a99742 -> "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", -95979a99745 -> "description": "Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.", -95982a99749 -> "description": "The maximum unit amount the customer can specify for this item.", -95985a99753 -> "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", -95988a99757 -> "description": "The starting unit amount which can be updated by the customer.", -95998a99768 -> "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.", -96006a99777 -> "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", -96009a99781 -> "description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.", -96012a99785 -> "description": "Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.", -96016a99790 -> "description": "The per unit billing amount for each individual unit for which this tier applies.", -96019a99794 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -96035c99810,99811 -< ] ---- -> ], -> "description": "Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier." -96046a99823 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -96049a99827 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -96056a99835 -> "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", -96059a99839 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -96061a99842 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -96070a99852 -> "description": "The number of intervals between subscription billings. 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).", -96080a99863 -> "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.", -96088a99872 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", -96091a99876 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -96142a99928 -> "description": "Height, in inches. Maximum precision is 2 decimal places.", -96145a99932 -> "description": "Length, in inches. Maximum precision is 2 decimal places.", -96148a99936 -> "description": "Weight, in ounces. Maximum precision is 2 decimal places.", -96151a99940 -> "description": "Width, in inches. Maximum precision is 2 decimal places.", -96176a99966,99973 -> "type": { -> "description": "The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.", -> "enum": [ -> "good", -> "service" -> ], -> "type": "string" -> }, -96326a100124 -> "next_page", -96489a100288,100295 -> "attributes": { -> "explode": true, -> "style": "deepObject" -> }, -> "deactivate_on": { -> "explode": true, -> "style": "deepObject" -> }, -96521a100328,100358 -> "attributes": { -> "anyOf": [ -> { -> "items": { -> "maxLength": 5000, -> "type": "string" -> }, -> "type": "array" -> }, -> { -> "enum": [ -> "" -> ], -> "type": "string" -> } -> ], -> "description": "A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `[\"color\", \"size\"]`). If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product." -> }, -> "caption": { -> "description": "A short one-line description of the product, meant to be displayable to the customer. May only be set if `type=good`.", -> "maxLength": 5000, -> "type": "string" -> }, -> "deactivate_on": { -> "description": "An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if `type=good`.", -> "items": { -> "maxLength": 5000, -> "type": "string" -> }, -> "type": "array" -> }, -96583a100421 -> "description": "Height, in inches. Maximum precision is 2 decimal places.", -96586a100425 -> "description": "Length, in inches. Maximum precision is 2 decimal places.", -96589a100429 -> "description": "Weight, in ounces. Maximum precision is 2 decimal places.", -96592a100433 -> "description": "Width, in inches. Maximum precision is 2 decimal places.", -96734a100576 -> "description": "Minimum value to filter by (exclusive)", -96737a100580 -> "description": "Minimum value to filter by (inclusive)", -96740a100584 -> "description": "Maximum value to filter by (exclusive)", -96743a100588 -> "description": "Maximum value to filter by (inclusive)", -96960a100806 -> "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", -96966a100813 -> "description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", -96969a100817 -> "description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices", -96972a100821 -> "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", -96975a100825 -> "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount", -97153a101004 -> "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", -97159a101011 -> "description": "Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", -97454a101307 -> "description": "Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.", -97505a101359 -> "description": "ID of the coupon to create a new discount for.", -97509a101364 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -97549a101405 -> "description": "Whether this quote is a revision of the previous quote.", -97552a101409 -> "description": "The `id` of the quote that will be cloned.", -97571a101429 -> "description": "Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", -97582a101441 -> "description": "The ID of the price object. One of `price` or `price_data` is required.", -97586a101446 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", -97588a101449 -> "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).", -97591a101453 -> "description": "The ID of the product that this price will belong to.", -97595a101458 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -97597a101461 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -97606a101471 -> "description": "The number of intervals between subscription billings. 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).", -97616a101482 -> "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.", -97624a101491 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -97627a101495 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -97639a101508 -> "description": "The quantity of the line item.", -97657c101526,101527 -< ] ---- -> ], -> "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item." -97689a101560 -> "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", -97712c101583,101584 -< ] ---- -> ], -> "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted." -97725c101597,101598 -< ] ---- -> ], -> "description": "Integer representing the number of trial period days before the customer is charged for the first time." -97740a101614 -> "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.", -97743a101618 -> "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. There must be at least 1 line item with a recurring price to use this field.", -97746a101622 -> "description": "ID of an existing, connected Stripe account.", -97965a101842 -> "description": "Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.", -98016a101894 -> "description": "ID of the coupon to create a new discount for.", -98020a101899 -> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", -98065a101945 -> "description": "Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", -98076a101957 -> "description": "The ID of an existing line item on the quote.", -98080a101962 -> "description": "The ID of the price object. One of `price` or `price_data` is required.", -98084a101967 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", -98086a101970 -> "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).", -98089a101974 -> "description": "The ID of the product that this price will belong to.", -98093a101979 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -98095a101982 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -98104a101992 -> "description": "The number of intervals between subscription billings. 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).", -98114a102003 -> "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.", -98122a102012 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -98125a102016 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -98137a102029 -> "description": "The quantity of the line item.", -98155c102047,102048 -< ] ---- -> ], -> "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item." -98187a102081 -> "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", -98210c102104,102105 -< ] ---- -> ], -> "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted." -98223c102118,102119 -< ] ---- -> ], -> "description": "Integer representing the number of trial period days before the customer is charged for the first time." -98233a102130 -> "description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.", -98236a102134 -> "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. There must be at least 1 line item with a recurring price to use this field.", -98239a102138 -> "description": "ID of an existing, connected Stripe account.", -99065a102965 -> "description": "Minimum value to filter by (exclusive)", -99068a102969 -> "description": "Minimum value to filter by (inclusive)", -99071a102973 -> "description": "Maximum value to filter by (exclusive)", -99074a102977 -> "description": "Maximum value to filter by (inclusive)", -99453a103357 -> "description": "Minimum value to filter by (exclusive)", -99456a103361 -> "description": "Minimum value to filter by (inclusive)", -99459a103365 -> "description": "Maximum value to filter by (exclusive)", -99462a103369 -> "description": "Maximum value to filter by (inclusive)", -99919a103827 -> "description": "Minimum value to filter by (exclusive)", -99922a103831 -> "description": "Minimum value to filter by (inclusive)", -99925a103835 -> "description": "Maximum value to filter by (exclusive)", -99928a103839 -> "description": "Maximum value to filter by (inclusive)", -100425a104337 -> "description": "Minimum value to filter by (exclusive)", -100428a104341 -> "description": "Minimum value to filter by (inclusive)", -100431a104345 -> "description": "Maximum value to filter by (exclusive)", -100434a104349 -> "description": "Maximum value to filter by (inclusive)", -100598a104514 -> "description": "The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set.", -100605a104522 -> "description": "Connected account ID to filter for in the report run.", -100608a104526 -> "description": "Currency of objects to be included in the report run.", -100611a104530 -> "description": "Ending timestamp of data to be included in the report run (exclusive).", -100615a104535 -> "description": "Starting timestamp of data to be included in the report run.", -100619a104540 -> "description": "Payout ID by which to filter the report run.", -100622a104544 -> "description": "Category of balance transactions to be included in the report run.", -100663a104586 -> "description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.", -101550a105474 -> "description": "Minimum value to filter by (exclusive)", -101553a105478 -> "description": "Minimum value to filter by (inclusive)", -101556a105482 -> "description": "Maximum value to filter by (exclusive)", -101559a105486 -> "description": "Maximum value to filter by (inclusive)", -101843a105771 -> "description": "Minimum value to filter by (exclusive)", -101846a105775 -> "description": "Minimum value to filter by (inclusive)", -101849a105779 -> "description": "Maximum value to filter by (exclusive)", -101852a105783 -> "description": "Maximum value to filter by (inclusive)", -102023a105955 -> "description": "Minimum value to filter by (exclusive)", -102026a105959 -> "description": "Minimum value to filter by (inclusive)", -102029a105963 -> "description": "Maximum value to filter by (exclusive)", -102032a105967 -> "description": "Maximum value to filter by (inclusive)", -102271a106207 -> "description": "This hash contains details about the customer acceptance of the Mandate.", -102273a106210 -> "description": "The time at which the customer accepted the Mandate.", -102277a106215 -> "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.", -102282a106221 -> "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", -102284a106224 -> "description": "The IP address from which the Mandate was accepted by the customer.", -102287a106228 -> "description": "The user agent of the browser from which the Mandate was accepted by the customer.", -102299a106241 -> "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", -102340a106283 -> "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", -102342a106286 -> "description": "Customer's bank account number.", -102346a106291 -> "description": "Institution number of the customer's bank.", -102350a106296 -> "description": "Transit number of the customer's bank.", -102363a106310 -> "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", -102368a106316 -> "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", -102373a106322 -> "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", -102378a106328 -> "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", -102380a106331 -> "description": "The account number for the bank account.", -102384a106336 -> "description": "Bank-State-Branch number of the bank account.", -102396a106349 -> "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", -102398a106352 -> "description": "Account number of the bank account that the funds will be debited from.", -102402a106357 -> "description": "Sort code of the bank account. (e.g., `10-20-30`)", -102410a106366 -> "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", -102415a106372 -> "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", -102421a106379 -> "description": "City, district, suburb, town, or village.", -102425a106384 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -102429a106389 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -102433a106394 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -102437a106399 -> "description": "ZIP or postal code.", -102441a106404 -> "description": "State, county, province, or region.", -102455c106418,106419 -< ] ---- -> ], -> "description": "Billing address." -102468c106432,106433 -< ] ---- -> ], -> "description": "Email address." -102470a106436 -> "description": "Full name.", -102474a106441 -> "description": "Billing phone number (including extension).", -102482a106450 -> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", -102487a106456 -> "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", -102489a106459 -> "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", -102500a106471 -> "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", -102505a106477 -> "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", -102507a106480 -> "description": "The customer's bank.", -102545a106519 -> "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", -102546a106521,106529 -> "account_holder_type": { -> "description": "Account holder type for FPX transaction", -> "enum": [ -> "company", -> "individual" -> ], -> "maxLength": 5000, -> "type": "string" -> }, -102547a106531 -> "description": "The customer's bank.", -102583a106568 -> "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", -102588a106574 -> "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", -102593a106580 -> "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", -102595a106583 -> "description": "The customer's bank.", -102618a106607 -> "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", -102623a106613 -> "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", -102625a106616 -> "description": "Customer's date of birth", -102627a106619 -> "description": "The day of birth, between 1 and 31.", -102630a106623 -> "description": "The month of birth, between 1 and 12.", -102633a106627 -> "description": "The four-digit year of birth.", -102649a106644 -> "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", -102654a106650 -> "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", -102662a106659 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -102665a106663 -> "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", -102670a106669 -> "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", -102672a106672 -> "description": "The customer's bank.", -102707a106708 -> "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", -102712a106714 -> "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", -102717a106720 -> "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", -102722a106726 -> "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", -102724a106729 -> "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", -102732a106738 -> "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", -102734a106741 -> "description": "IBAN of the bank account.", -102745a106753 -> "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", -102747a106756 -> "description": "Two-letter ISO code representing the country the bank account is located in.", -102765a106775 -> "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.", -102798a106809 -> "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", -102800a106812 -> "description": "Account holder type: individual or company.", -102807a106820 -> "description": "Account number of the bank account.", -102811a106825 -> "description": "Account type: checkings or savings. Defaults to checking if omitted.", -102818a106833 -> "description": "The ID of a Financial Connections Account to use as a payment method.", -102822a106838 -> "description": "Routing number of the bank account.", -102830a106847 -> "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", -102845a106863 -> "description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.", -102847a106866 -> "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).", -102854a106874 -> "description": "Additional fields for Mandate creation", -102867c106887,106888 -< ] ---- -> ], -> "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." -102869a106891 -> "description": "List of Stripe products where this mandate can be selected automatically.", -102879a106902 -> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", -102883a106907 -> "description": "Payment schedule for the mandate.", -102891a106916 -> "description": "Transaction type of the mandate.", -102902a106928 -> "description": "Verification method for the intent", -102915a106942 -> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", -102917a106945 -> "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", -102925a106954 -> "description": "Configuration for any card setup attempted on this SetupIntent.", -102927a106957 -> "description": "Configuration options for setting up an eMandate for cards issued in India.", -102929a106960 -> "description": "Amount to be charged for future payments.", -102932a106964 -> "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", -102939a106972 -> "description": "Currency in which future payments will be charged. 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).", -102942a106976 -> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", -102946a106981 -> "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", -102950a106986 -> "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", -102960a106997 -> "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", -102963a107001 -> "description": "Unique identifier for the mandate or subscription.", -102967a107006 -> "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", -102971a107011 -> "description": "Specifies the type of mandates supported. Possible values are `india`.", -102991a107032,107035 -> "moto": { -> "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", -> "type": "boolean" -> }, -102992a107037 -> "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.", -103009a107055 -> "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.", -103022a107069 -> "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", -103024a107072 -> "description": "Token used for persistent Link logins.", -103032a107081 -> "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", -103034a107084 -> "description": "Additional fields for Mandate creation", -103043a107094 -> "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", -103045a107097 -> "description": "Additional fields for Financial Connections Session creation", -103047a107100 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -103061a107115 -> "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", -103069a107124 -> "description": "Additional fields for network related functions", -103071a107127 -> "description": "Triggers validations to run across the selected networks", -103085a107142 -> "description": "Verification method for the intent", -103117a107175 -> "description": "Amount the customer is granting permission to collect later. 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).", -103120a107179 -> "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).", -103353a107413 -> "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", -103355a107416 -> "description": "Customer's bank account number.", -103359a107421 -> "description": "Institution number of the customer's bank.", -103363a107426 -> "description": "Transit number of the customer's bank.", -103376a107440 -> "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", -103381a107446 -> "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", -103386a107452 -> "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", -103391a107458 -> "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", -103393a107461 -> "description": "The account number for the bank account.", -103397a107466 -> "description": "Bank-State-Branch number of the bank account.", -103409a107479 -> "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", -103411a107482 -> "description": "Account number of the bank account that the funds will be debited from.", -103415a107487 -> "description": "Sort code of the bank account. (e.g., `10-20-30`)", -103423a107496 -> "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", -103428a107502 -> "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", -103434a107509 -> "description": "City, district, suburb, town, or village.", -103438a107514 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -103442a107519 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -103446a107524 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -103450a107529 -> "description": "ZIP or postal code.", -103454a107534 -> "description": "State, county, province, or region.", -103468c107548,107549 -< ] ---- -> ], -> "description": "Billing address." -103481c107562,107563 -< ] ---- -> ], -> "description": "Email address." -103483a107566 -> "description": "Full name.", -103487a107571 -> "description": "Billing phone number (including extension).", -103495a107580 -> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", -103500a107586 -> "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", -103502a107589 -> "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", -103513a107601 -> "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", -103518a107607 -> "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", -103520a107610 -> "description": "The customer's bank.", -103558a107649 -> "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", -103559a107651,107659 -> "account_holder_type": { -> "description": "Account holder type for FPX transaction", -> "enum": [ -> "company", -> "individual" -> ], -> "maxLength": 5000, -> "type": "string" -> }, -103560a107661 -> "description": "The customer's bank.", -103596a107698 -> "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", -103601a107704 -> "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", -103606a107710 -> "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", -103608a107713 -> "description": "The customer's bank.", -103631a107737 -> "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", -103636a107743 -> "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", -103638a107746 -> "description": "Customer's date of birth", -103640a107749 -> "description": "The day of birth, between 1 and 31.", -103643a107753 -> "description": "The month of birth, between 1 and 12.", -103646a107757 -> "description": "The four-digit year of birth.", -103662a107774 -> "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", -103667a107780 -> "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", -103675a107789 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -103678a107793 -> "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", -103683a107799 -> "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", -103685a107802 -> "description": "The customer's bank.", -103720a107838 -> "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", -103725a107844 -> "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", -103730a107850 -> "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", -103735a107856 -> "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", -103737a107859 -> "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", -103745a107868 -> "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", -103747a107871 -> "description": "IBAN of the bank account.", -103758a107883 -> "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", -103760a107886 -> "description": "Two-letter ISO code representing the country the bank account is located in.", -103778a107905 -> "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.", -103811a107939 -> "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", -103813a107942 -> "description": "Account holder type: individual or company.", -103820a107950 -> "description": "Account number of the bank account.", -103824a107955 -> "description": "Account type: checkings or savings. Defaults to checking if omitted.", -103831a107963 -> "description": "The ID of a Financial Connections Account to use as a payment method.", -103835a107968 -> "description": "Routing number of the bank account.", -103843a107977 -> "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", -103858a107993 -> "description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.", -103860a107996 -> "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).", -103867a108004 -> "description": "Additional fields for Mandate creation", -103880c108017,108018 -< ] ---- -> ], -> "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." -103882a108021 -> "description": "List of Stripe products where this mandate can be selected automatically.", -103892a108032 -> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", -103896a108037 -> "description": "Payment schedule for the mandate.", -103904a108046 -> "description": "Transaction type of the mandate.", -103915a108058 -> "description": "Verification method for the intent", -103928a108072 -> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", -103930a108075 -> "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", -103938a108084 -> "description": "Configuration for any card setup attempted on this SetupIntent.", -103940a108087 -> "description": "Configuration options for setting up an eMandate for cards issued in India.", -103942a108090 -> "description": "Amount to be charged for future payments.", -103945a108094 -> "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", -103952a108102 -> "description": "Currency in which future payments will be charged. 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).", -103955a108106 -> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", -103959a108111 -> "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", -103963a108116 -> "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", -103973a108127 -> "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", -103976a108131 -> "description": "Unique identifier for the mandate or subscription.", -103980a108136 -> "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", -103984a108141 -> "description": "Specifies the type of mandates supported. Possible values are `india`.", -104004a108162,108165 -> "moto": { -> "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", -> "type": "boolean" -> }, -104005a108167 -> "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.", -104022a108185 -> "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.", -104035a108199 -> "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", -104037a108202 -> "description": "Token used for persistent Link logins.", -104045a108211 -> "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", -104047a108214 -> "description": "Additional fields for Mandate creation", -104056a108224 -> "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", -104058a108227 -> "description": "Additional fields for Financial Connections Session creation", -104060a108230 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -104074a108245 -> "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", -104082a108254 -> "description": "Additional fields for network related functions", -104084a108257 -> "description": "Triggers validations to run across the selected networks", -104098a108272 -> "description": "Verification method for the intent", -104271,104275d108444 -< "client_secret": { -< "description": "The client secret of the SetupIntent.", -< "maxLength": 5000, -< "type": "string" -< }, -104288a108458 -> "description": "This hash contains details about the customer acceptance of the Mandate.", -104290a108461 -> "description": "The time at which the customer accepted the Mandate.", -104294a108466 -> "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.", -104299a108472 -> "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", -104301a108475 -> "description": "The IP address from which the Mandate was accepted by the customer.", -104304a108479 -> "description": "The user agent of the browser from which the Mandate was accepted by the customer.", -104316a108492 -> "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", -104340a108517 -> "description": "This hash contains details about the customer acceptance of the Mandate.", -104342a108520 -> "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", -104344a108523 -> "description": "The IP address from which the Mandate was accepted by the customer.", -104347a108527 -> "description": "The user agent of the browser from which the Mandate was accepted by the customer.", -104355a108536 -> "description": "The type of customer acceptance information included with the Mandate.", -104375c108556,108559 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "MandateDataPublishableKey" -> } -104388a108573 -> "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", -104390a108576 -> "description": "Customer's bank account number.", -104394a108581 -> "description": "Institution number of the customer's bank.", -104398a108586 -> "description": "Transit number of the customer's bank.", -104411a108600 -> "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", -104416a108606 -> "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", -104421a108612 -> "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", -104426a108618 -> "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", -104428a108621 -> "description": "The account number for the bank account.", -104432a108626 -> "description": "Bank-State-Branch number of the bank account.", -104444a108639 -> "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", -104446a108642 -> "description": "Account number of the bank account that the funds will be debited from.", -104450a108647 -> "description": "Sort code of the bank account. (e.g., `10-20-30`)", -104458a108656 -> "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", -104463a108662 -> "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", -104469a108669 -> "description": "City, district, suburb, town, or village.", -104473a108674 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -104477a108679 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -104481a108684 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -104485a108689 -> "description": "ZIP or postal code.", -104489a108694 -> "description": "State, county, province, or region.", -104503c108708,108709 -< ] ---- -> ], -> "description": "Billing address." -104516c108722,108723 -< ] ---- -> ], -> "description": "Email address." -104518a108726 -> "description": "Full name.", -104522a108731 -> "description": "Billing phone number (including extension).", -104530a108740 -> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", -104535a108746 -> "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", -104537a108749 -> "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", -104548a108761 -> "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", -104553a108767 -> "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", -104555a108770 -> "description": "The customer's bank.", -104593a108809 -> "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", -104594a108811,108819 -> "account_holder_type": { -> "description": "Account holder type for FPX transaction", -> "enum": [ -> "company", -> "individual" -> ], -> "maxLength": 5000, -> "type": "string" -> }, -104595a108821 -> "description": "The customer's bank.", -104631a108858 -> "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", -104636a108864 -> "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", -104641a108870 -> "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", -104643a108873 -> "description": "The customer's bank.", -104666a108897 -> "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", -104671a108903 -> "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", -104673a108906 -> "description": "Customer's date of birth", -104675a108909 -> "description": "The day of birth, between 1 and 31.", -104678a108913 -> "description": "The month of birth, between 1 and 12.", -104681a108917 -> "description": "The four-digit year of birth.", -104697a108934 -> "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", -104702a108940 -> "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", -104710a108949 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -104713a108953 -> "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", -104718a108959 -> "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", -104720a108962 -> "description": "The customer's bank.", -104755a108998 -> "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", -104760a109004 -> "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", -104765a109010 -> "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", -104770a109016 -> "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", -104772a109019 -> "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", -104780a109028 -> "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", -104782a109031 -> "description": "IBAN of the bank account.", -104793a109043 -> "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", -104795a109046 -> "description": "Two-letter ISO code representing the country the bank account is located in.", -104813a109065 -> "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.", -104846a109099 -> "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", -104848a109102 -> "description": "Account holder type: individual or company.", -104855a109110 -> "description": "Account number of the bank account.", -104859a109115 -> "description": "Account type: checkings or savings. Defaults to checking if omitted.", -104866a109123 -> "description": "The ID of a Financial Connections Account to use as a payment method.", -104870a109128 -> "description": "Routing number of the bank account.", -104878a109137 -> "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", -104893a109153 -> "description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.", -104895a109156 -> "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).", -104902a109164 -> "description": "Additional fields for Mandate creation", -104915c109177,109178 -< ] ---- -> ], -> "description": "A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent." -104917a109181 -> "description": "List of Stripe products where this mandate can be selected automatically.", -104927a109192 -> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.", -104931a109197 -> "description": "Payment schedule for the mandate.", -104939a109206 -> "description": "Transaction type of the mandate.", -104950a109218 -> "description": "Verification method for the intent", -104963a109232 -> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", -104965a109235 -> "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", -104973a109244 -> "description": "Configuration for any card setup attempted on this SetupIntent.", -104975a109247 -> "description": "Configuration options for setting up an eMandate for cards issued in India.", -104977a109250 -> "description": "Amount to be charged for future payments.", -104980a109254 -> "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", -104987a109262 -> "description": "Currency in which future payments will be charged. 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).", -104990a109266 -> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", -104994a109271 -> "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.", -104998a109276 -> "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.", -105008a109287 -> "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.", -105011a109291 -> "description": "Unique identifier for the mandate or subscription.", -105015a109296 -> "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.", -105019a109301 -> "description": "Specifies the type of mandates supported. Possible values are `india`.", -105039a109322,109325 -> "moto": { -> "description": "When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.", -> "type": "boolean" -> }, -105040a109327 -> "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.", -105057a109345 -> "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.", -105070a109359 -> "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", -105072a109362 -> "description": "Token used for persistent Link logins.", -105080a109371 -> "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", -105082a109374 -> "description": "Additional fields for Mandate creation", -105091a109384 -> "description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.", -105093a109387 -> "description": "Additional fields for Financial Connections Session creation", -105095a109390 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -105109a109405 -> "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.", -105117a109414 -> "description": "Additional fields for network related functions", -105119a109417 -> "description": "Triggers validations to run across the selected networks", -105133a109432 -> "description": "Verification method for the intent", -105224,105228d109522 -< "client_secret": { -< "description": "The client secret of the SetupIntent.", -< "maxLength": 5000, -< "type": "string" -< }, -105298a109593 -> "description": "Minimum value to filter by (exclusive)", -105301a109597 -> "description": "Minimum value to filter by (inclusive)", -105304a109601 -> "description": "Maximum value to filter by (exclusive)", -105307a109605 -> "description": "Maximum value to filter by (inclusive)", -105481a109780 -> "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.", -105483a109783 -> "description": "A unit of time.", -105493a109794 -> "description": "Must be greater than 0.", -105504a109806 -> "description": "The lower bound of the estimated range. If empty, represents no lower bound.", -105506a109809 -> "description": "A unit of time.", -105516a109820 -> "description": "Must be greater than 0.", -105547a109852 -> "description": "A non-negative integer in cents representing how much to charge.", -105550a109856 -> "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).", -105556a109863 -> "description": "A non-negative integer in cents representing how much to charge.", -105559a109867 -> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", -105573a109882 -> "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", -105765a110075 -> "description": "A non-negative integer in cents representing how much to charge.", -105768a110079 -> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.", -105779a110091 -> "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).", -106290a110603 -> "description": "The count of inventory available. Required if `type` is `finite`.", -106293a110607 -> "description": "Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`.", -106301a110616 -> "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`.", -106327a110643 -> "description": "Height, in inches. Maximum precision is 2 decimal places.", -106330a110647 -> "description": "Length, in inches. Maximum precision is 2 decimal places.", -106333a110651 -> "description": "Weight, in ounces. Maximum precision is 2 decimal places.", -106336a110655 -> "description": "Width, in inches. Maximum precision is 2 decimal places.", -106595a110915 -> "description": "The count of inventory available. Required if `type` is `finite`.", -106598a110919 -> "description": "Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`.", -106606a110928 -> "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`.", -106640a110963 -> "description": "Height, in inches. Maximum precision is 2 decimal places.", -106643a110967 -> "description": "Length, in inches. Maximum precision is 2 decimal places.", -106646a110971 -> "description": "Weight, in ounces. Maximum precision is 2 decimal places.", -106649a110975 -> "description": "Width, in inches. Maximum precision is 2 decimal places.", -106786a111113 -> "description": "The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.", -106788a111116 -> "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", -106792a111121 -> "description": "The IP address from which the mandate was accepted or refused by the customer.", -106795a111125 -> "description": "The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`", -106797a111128 -> "description": "An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.", -106807a111139 -> "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", -106809a111142 -> "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", -106813a111147 -> "description": "The IP address from which the mandate was accepted or refused by the customer.", -106816a111151 -> "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", -106824a111160 -> "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", -106834a111171 -> "description": "The type of acceptance information included with the mandate. Either `online` or `offline`", -106842a111180 -> "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", -106864c111202,111203 -< ] ---- -> ], -> "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)" -106866a111206 -> "description": "The currency specified by the mandate. (Must match `currency` of the source)", -106869a111210 -> "description": "The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)", -106878a111220 -> "description": "The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).", -106907a111250 -> "description": "Owner's address.", -106909a111253 -> "description": "City, district, suburb, town, or village.", -106913a111258 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -106917a111263 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -106921a111268 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -106925a111273 -> "description": "ZIP or postal code.", -106929a111278 -> "description": "State, county, province, or region.", -106937a111287 -> "description": "Owner's email address.", -106940a111291 -> "description": "Owner's full name.", -106944a111296 -> "description": "Owner's phone number.", -106955a111308 -> "description": "The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.", -106971a111325 -> "description": "The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application.", -106984a111339 -> "description": "List of items constituting the order.", -106997a111353 -> "description": "The ID of the SKU being ordered.", -107001a111358 -> "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.", -107020a111378 -> "description": "Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.", -107022a111381 -> "description": "Shipping address.", -107024a111384 -> "description": "City, district, suburb, town, or village.", -107028a111389 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -107032a111394 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -107036a111399 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -107040a111404 -> "description": "ZIP or postal code.", -107044a111409 -> "description": "State, county, province, or region.", -107055a111421 -> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", -107059a111426 -> "description": "Recipient name.", -107063a111431 -> "description": "Recipient phone (including extension).", -107067a111436 -> "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.", -107272a111642 -> "description": "The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.", -107274a111645 -> "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", -107278a111650 -> "description": "The IP address from which the mandate was accepted or refused by the customer.", -107281a111654 -> "description": "The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`", -107283a111657 -> "description": "An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`.", -107293a111668 -> "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", -107295a111671 -> "description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.", -107299a111676 -> "description": "The IP address from which the mandate was accepted or refused by the customer.", -107302a111680 -> "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", -107310a111689 -> "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", -107320a111700 -> "description": "The type of acceptance information included with the mandate. Either `online` or `offline`", -107328a111709 -> "description": "The user agent of the browser from which the mandate was accepted or refused by the customer.", -107350c111731,111732 -< ] ---- -> ], -> "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)" -107352a111735 -> "description": "The currency specified by the mandate. (Must match `currency` of the source)", -107355a111739 -> "description": "The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)", -107364a111749 -> "description": "The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).", -107399a111785 -> "description": "Owner's address.", -107401a111788 -> "description": "City, district, suburb, town, or village.", -107405a111793 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -107409a111798 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -107413a111803 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -107417a111808 -> "description": "ZIP or postal code.", -107421a111813 -> "description": "State, county, province, or region.", -107429a111822 -> "description": "Owner's email address.", -107432a111826 -> "description": "Owner's full name.", -107436a111831 -> "description": "Owner's phone number.", -107447a111843 -> "description": "List of items constituting the order.", -107460a111857 -> "description": "The ID of the SKU being ordered.", -107464a111862 -> "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.", -107483a111882 -> "description": "Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.", -107485a111885 -> "description": "Shipping address.", -107487a111888 -> "description": "City, district, suburb, town, or village.", -107491a111893 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -107495a111898 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -107499a111903 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -107503a111908 -> "description": "ZIP or postal code.", -107507a111913 -> "description": "State, county, province, or region.", -107518a111925 -> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", -107522a111930 -> "description": "Recipient name.", -107526a111935 -> "description": "Recipient phone (including extension).", -107530a111940 -> "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.", -107576,107653d111985 -< "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { -< "get": { -< "description": "Retrieves a new Source MandateNotification.
", -< "operationId": "GetSourcesSourceMandateNotificationsMandateNotification", -< "parameters": [ -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "mandate_notification", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "source", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/source_mandate_notification" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -107789,107866d112120 -< "/v1/sources/{source}/source_transactions/{source_transaction}": { -< "get": { -< "description": "Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.
", -< "operationId": "GetSourcesSourceSourceTransactionsSourceTransaction", -< "parameters": [ -< { -< "description": "Specifies which fields in the response should be expanded.", -< "explode": true, -< "in": "query", -< "name": "expand", -< "required": false, -< "schema": { -< "items": { -< "maxLength": 5000, -< "type": "string" -< }, -< "type": "array" -< }, -< "style": "deepObject" -< }, -< { -< "in": "path", -< "name": "source", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< }, -< { -< "in": "path", -< "name": "source_transaction", -< "required": true, -< "schema": { -< "maxLength": 5000, -< "type": "string" -< }, -< "style": "simple" -< } -< ], -< "requestBody": { -< "content": { -< "application/x-www-form-urlencoded": { -< "encoding": {}, -< "schema": { -< "additionalProperties": false, -< "properties": {}, -< "type": "object" -< } -< } -< }, -< "required": false -< }, -< "responses": { -< "200": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/source_transaction" -< } -< } -< }, -< "description": "Successful response." -< }, -< "default": { -< "content": { -< "application/json": { -< "schema": { -< "$ref": "#/components/schemas/error" -< } -< } -< }, -< "description": "Error response." -< } -< } -< } -< }, -108118a112373 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -108161a112417,112421 -> "plan": { -> "description": "The identifier of the plan to add to the subscription.", -> "maxLength": 5000, -> "type": "string" -> }, -108170a112431 -> "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).", -108173a112435 -> "description": "The ID of the product that this price will belong to.", -108177a112440 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -108179a112443 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -108188a112453 -> "description": "The number of intervals between subscription billings. 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).", -108198a112464 -> "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.", -108206a112473 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -108209a112477 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -108481a112750 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -108538a112808,112812 -> "plan": { -> "description": "The identifier of the new plan for this subscription item.", -> "maxLength": 5000, -> "type": "string" -> }, -108547a112822 -> "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).", -108550a112826 -> "description": "The ID of the product that this price will belong to.", -108554a112831 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -108556a112834 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -108565a112844 -> "description": "The number of intervals between subscription billings. 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).", -108575a112855 -> "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.", -108583a112864 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -108586a112868 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -108915a113198 -> "description": "Minimum value to filter by (exclusive)", -108918a113202 -> "description": "Minimum value to filter by (inclusive)", -108921a113206 -> "description": "Maximum value to filter by (exclusive)", -108924a113210 -> "description": "Maximum value to filter by (inclusive)", -108948a113235 -> "description": "Minimum value to filter by (exclusive)", -108951a113239 -> "description": "Minimum value to filter by (inclusive)", -108954a113243 -> "description": "Maximum value to filter by (exclusive)", -108957a113247 -> "description": "Maximum value to filter by (inclusive)", -108981a113272 -> "description": "Minimum value to filter by (exclusive)", -108984a113276 -> "description": "Minimum value to filter by (inclusive)", -108987a113280 -> "description": "Maximum value to filter by (exclusive)", -108990a113284 -> "description": "Maximum value to filter by (inclusive)", -109061a113356 -> "description": "Minimum value to filter by (exclusive)", -109064a113360 -> "description": "Minimum value to filter by (inclusive)", -109067a113364 -> "description": "Maximum value to filter by (exclusive)", -109070a113368 -> "description": "Maximum value to filter by (inclusive)", -109217a113516 -> "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", -109220a113520 -> "description": "Default settings for automatic tax computation.", -109222a113523 -> "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", -109232a113534 -> "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", -109243a113546 -> "description": "Monetary threshold that triggers the subscription to advance to a new billing period", -109246a113550 -> "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.", -109259c113563,113564 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." -109261a113567 -> "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 and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", -109268a113575 -> "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.", -109272a113580 -> "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", -109276a113585 -> "description": "All invoices will be billed using the specified settings.", -109278a113588 -> "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`.", -109296c113606,113607 -< ] ---- -> ], -> "description": "The account on behalf of which to charge, for each of the associated subscription's invoices." -109302a113614 -> "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.", -109305a113618 -> "description": "ID of an existing, connected Stripe account.", -109321c113634,113635 -< ] ---- -> ], -> "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices." -109371a113686 -> "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.", -109374a113690 -> "description": "The ID of the price object.", -109378a113695 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -109380a113698 -> "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).", -109383a113702 -> "description": "The ID of the product that this price will belong to.", -109387a113707 -> "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.", -109395a113716 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -109398a113720 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -109410a113733 -> "description": "Quantity for this item. Defaults to 1.", -109428c113751,113752 -< ] ---- -> ], -> "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." -109432c113756,113759 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "AddInvoiceItem" -> } -109436a113764 -> "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", -109439a113768 -> "description": "Automatic tax settings for this phase.", -109441a113771 -> "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", -109451a113782 -> "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", -109462a113794 -> "description": "Monetary threshold that triggers the subscription to advance to a new billing period", -109465a113798 -> "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.", -109478c113811,113812 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." -109480a113815 -> "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 and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", -109487a113823 -> "description": "The identifier of the coupon to apply to this phase of the subscription schedule.", -109491a113828 -> "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).", -109494a113832 -> "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.", -109513c113851,113852 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." -109515a113855 -> "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", -109519a113860 -> "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.", -109523a113865 -> "description": "All invoices will be billed using the specified settings.", -109525a113868 -> "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`.", -109532a113876 -> "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", -109539a113884 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -109555c113900,113906 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." -> }, -> "plan": { -> "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", -> "maxLength": 5000, -> "type": "string" -109557a113909 -> "description": "The ID of the price object.", -109561a113914 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -109563a113917 -> "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).", -109566a113921 -> "description": "The ID of the product that this price will belong to.", -109570a113926 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -109572a113929 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -109581a113939 -> "description": "The number of intervals between subscription billings. 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).", -109591a113950 -> "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.", -109599a113959 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -109602a113963 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -109615a113977 -> "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", -109633c113995,113996 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." -109641a114005 -> "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.", -109647a114012 -> "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.", -109650a114016 -> "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", -109653a114020 -> "description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`.", -109661a114029 -> "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", -109663a114032 -> "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.", -109666a114036 -> "description": "ID of an existing, connected Stripe account.", -109676a114047 -> "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", -109679a114051 -> "description": "Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`", -109847a114220 -> "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", -109850a114224 -> "description": "Default settings for automatic tax computation.", -109852a114227 -> "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", -109862a114238 -> "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", -109873a114250 -> "description": "Monetary threshold that triggers the subscription to advance to a new billing period", -109876a114254 -> "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.", -109889c114267,114268 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." -109891a114271 -> "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 and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", -109898a114279 -> "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.", -109902a114284 -> "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", -109906a114289 -> "description": "All invoices will be billed using the specified settings.", -109908a114292 -> "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`.", -109926c114310,114311 -< ] ---- -> ], -> "description": "The account on behalf of which to charge, for each of the associated subscription's invoices." -109932a114318 -> "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.", -109935a114322 -> "description": "ID of an existing, connected Stripe account.", -109951c114338,114339 -< ] ---- -> ], -> "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices." -109996a114385 -> "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.", -109999a114389 -> "description": "The ID of the price object.", -110003a114394 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -110005a114397 -> "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).", -110008a114401 -> "description": "The ID of the product that this price will belong to.", -110012a114406 -> "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.", -110020a114415 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -110023a114419 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -110035a114432 -> "description": "Quantity for this item. Defaults to 1.", -110053c114450,114451 -< ] ---- -> ], -> "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." -110057c114455,114458 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "AddInvoiceItem" -> } -110061a114463 -> "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).", -110064a114467 -> "description": "Automatic tax settings for this phase.", -110066a114470 -> "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", -110076a114481 -> "description": "Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", -110087a114493 -> "description": "Monetary threshold that triggers the subscription to advance to a new billing period", -110090a114497 -> "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.", -110103c114510,114511 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." -110105a114514 -> "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 and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", -110112a114522 -> "description": "The identifier of the coupon to apply to this phase of the subscription schedule.", -110115a114526,114529 -> "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" -> }, -110116a114531 -> "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.", -110135c114550,114551 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." -110137a114554 -> "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", -110153c114570,114571 -< ] ---- -> ], -> "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set." -110155a114574 -> "description": "All invoices will be billed using the specified settings.", -110157a114577 -> "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`.", -110164a114585 -> "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", -110171a114593 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -110187c114609,114615 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." -> }, -> "plan": { -> "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", -> "maxLength": 5000, -> "type": "string" -110189a114618 -> "description": "The ID of the price object.", -110193a114623 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -110195a114626 -> "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).", -110198a114630 -> "description": "The ID of the product that this price will belong to.", -110202a114635 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -110204a114638 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -110213a114648 -> "description": "The number of intervals between subscription billings. 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).", -110223a114659 -> "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.", -110231a114668 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -110234a114672 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -110247a114686 -> "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", -110265c114704,114705 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." -110273a114714 -> "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.", -110279a114721 -> "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.", -110282a114725 -> "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", -110285a114729 -> "description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`.", -110305c114749,114750 -< ] ---- -> ], -> "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase." -110307a114753 -> "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", -110309a114756 -> "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.", -110312a114760 -> "description": "ID of an existing, connected Stripe account.", -110322a114771 -> "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", -110337c114786,114787 -< ] ---- -> ], -> "description": "Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`" -110562a115013 -> "description": "Minimum value to filter by (exclusive)", -110565a115017 -> "description": "Minimum value to filter by (inclusive)", -110568a115021 -> "description": "Maximum value to filter by (exclusive)", -110571a115025 -> "description": "Maximum value to filter by (inclusive)", -110594a115049 -> "description": "Minimum value to filter by (exclusive)", -110597a115053 -> "description": "Minimum value to filter by (inclusive)", -110600a115057 -> "description": "Maximum value to filter by (exclusive)", -110603a115061 -> "description": "Maximum value to filter by (inclusive)", -110626a115085 -> "description": "Minimum value to filter by (exclusive)", -110629a115089 -> "description": "Minimum value to filter by (inclusive)", -110632a115093 -> "description": "Maximum value to filter by (exclusive)", -110635a115097 -> "description": "Maximum value to filter by (inclusive)", -110696a115159,115169 -> "description": "The ID of the plan whose subscriptions will be retrieved.", -> "in": "query", -> "name": "plan", -> "required": false, -> "schema": { -> "maxLength": 5000, -> "type": "string" -> }, -> "style": "form" -> }, -> { -110887a115361 -> "description": "The ID of the price object.", -110891a115366 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -110893a115369 -> "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).", -110896a115373 -> "description": "The ID of the product that this price will belong to.", -110900a115378 -> "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.", -110908a115387 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -110911a115391 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -110923a115404 -> "description": "Quantity for this item. Defaults to 1.", -110941c115422,115423 -< ] ---- -> ], -> "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." -110945c115427,115430 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "AddInvoiceItem" -> } -110956a115442 -> "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", -110981a115468 -> "description": "Monetary threshold that triggers the subscription to advance to a new billing period", -110984a115472 -> "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.", -111084a115573 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -111100c115589,115590 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." -111105a115596 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -111107a115599,115603 -> "plan": { -> "description": "Plan ID for this item, as a string.", -> "maxLength": 5000, -> "type": "string" -> }, -111108a115605 -> "description": "The ID of the price object.", -111112a115610 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -111114a115613 -> "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).", -111117a115617 -> "description": "The ID of the product that this price will belong to.", -111121a115622 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -111123a115625 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -111132a115635 -> "description": "The number of intervals between subscription billings. 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).", -111142a115646 -> "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.", -111150a115655 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -111153a115659 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -111166a115673 -> "description": "Quantity for this item.", -111184c115691,115692 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." -111240a115749 -> "description": "Payment-method-specific configuration to provide to invoices created by the subscription.", -111246a115756 -> "description": "Additional fields for Mandate creation", -111248a115759 -> "description": "Transaction type of the mandate.", -111259a115771 -> "description": "Verification method for the intent", -111278c115790,115791 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." -111284a115798 -> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", -111303c115817,115818 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." -111309a115825 -> "description": "Configuration options for setting up an eMandate for cards issued in India.", -111311a115828 -> "description": "Amount to be charged for future payments.", -111314a115832 -> "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", -111321a115840 -> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", -111329a115849 -> "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", -111346a115867 -> "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.", -111363c115884,115885 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." -111369a115892 -> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", -111371a115895 -> "description": "Configuration for eu_bank_transfer funding type.", -111373a115898 -> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.", -111384a115910 -> "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", -111391a115918 -> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", -111404c115931,115932 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." -111419c115947,115948 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." -111425a115955 -> "description": "Additional fields for Financial Connections Session creation", -111427a115958 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -111445a115977 -> "description": "Verification method for the intent", -111464c115996,115997 -< ] ---- -> ], -> "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." -111491a116025 -> "sepa_credit_transfer", -111508c116042,116043 -< ] ---- -> ], -> "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)." -111510a116046 -> "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", -111525a116062 -> "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.", -111534a116072 -> "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).", -111570a116109 -> "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.", -111573a116113 -> "description": "ID of an existing, connected Stripe account.", -111746a116287 -> "next_page", -111996a116538 -> "description": "The ID of the price object.", -112000a116543 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -112002a116546 -> "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).", -112005a116550 -> "description": "The ID of the product that this price will belong to.", -112009a116555 -> "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.", -112017a116564 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -112020a116568 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -112032a116581 -> "description": "Quantity for this item. Defaults to 1.", -112050c116599,116600 -< ] ---- -> ], -> "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." -112054c116604,116607 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "AddInvoiceItem" -> } -112065a116619 -> "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", -112089a116644 -> "description": "Monetary threshold that triggers the subscription to advance to a new billing period", -112092a116648 -> "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.", -112193a116750 -> "description": "Usage threshold that triggers the subscription to advance to a new billing period", -112209c116766,116767 -< ] ---- -> ], -> "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." -112211a116770 -> "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", -112214a116774 -> "description": "A flag that, if set to `true`, will delete the specified item.", -112217a116778 -> "description": "Subscription item to update.", -112235c116796,116802 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -> }, -> "plan": { -> "description": "Plan ID for this item, as a string.", -> "maxLength": 5000, -> "type": "string" -112237a116805 -> "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", -112241a116810 -> "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", -112243a116813 -> "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).", -112246a116817 -> "description": "The ID of the product that this price will belong to.", -112250a116822 -> "description": "The recurring components of a price such as `interval` and `interval_count`.", -112252a116825 -> "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", -112261a116835 -> "description": "The number of intervals between subscription billings. 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).", -112271a116846 -> "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.", -112279a116855 -> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", -112282a116859 -> "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", -112295a116873 -> "description": "Quantity for this item.", -112313c116891,116892 -< ] ---- -> ], -> "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." -112360a116940 -> "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.", -112368a116949 -> "description": "The time after which the subscription will resume collecting payments.", -112401a116983 -> "description": "Payment-method-specific configuration to provide to invoices created by the subscription.", -112407a116990 -> "description": "Additional fields for Mandate creation", -112409a116993 -> "description": "Transaction type of the mandate.", -112420a117005 -> "description": "Verification method for the intent", -112439c117024,117025 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent." -112445a117032 -> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.", -112464c117051,117052 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent." -112470a117059 -> "description": "Configuration options for setting up an eMandate for cards issued in India.", -112472a117062 -> "description": "Amount to be charged for future payments.", -112475a117066 -> "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.", -112482a117074 -> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.", -112490a117083 -> "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.", -112507a117101 -> "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.", -112524c117118,117119 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent." -112530a117126 -> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.", -112532a117129 -> "description": "Configuration for eu_bank_transfer funding type.", -112534a117132 -> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.", -112545a117144 -> "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", -112552a117152 -> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.", -112565c117165,117166 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent." -112580c117181,117182 -< ] ---- -> ], -> "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." -112586a117189 -> "description": "Additional fields for Financial Connections Session creation", -112588a117192 -> "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", -112606a117211 -> "description": "Verification method for the intent", -112625c117230,117231 -< ] ---- -> ], -> "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent." -112652a117259 -> "sepa_credit_transfer", -112669c117276,117277 -< ] ---- -> ], -> "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)." -112671a117280 -> "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", -112686a117296 -> "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.", -112695a117306 -> "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).", -112737a117349 -> "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.", -112740a117353 -> "description": "ID of an existing, connected Stripe account.", -113079a117693 -> "description": "Minimum value to filter by (exclusive)", -113082a117697 -> "description": "Minimum value to filter by (inclusive)", -113085a117701 -> "description": "Maximum value to filter by (exclusive)", -113088a117705 -> "description": "Maximum value to filter by (inclusive)", -113726c118343,118344 -< ] ---- -> ], -> "description": "A File ID representing an image you would like displayed on the reader." -113744a118363 -> "description": "Tipping configuration for AUD", -113746a118366 -> "description": "Fixed amounts displayed when collecting a tip", -113752a118373 -> "description": "Percentages displayed when collecting a tip", -113758a118380 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113765a118388 -> "description": "Tipping configuration for CAD", -113767a118391 -> "description": "Fixed amounts displayed when collecting a tip", -113773a118398 -> "description": "Percentages displayed when collecting a tip", -113779a118405 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113786a118413 -> "description": "Tipping configuration for CHF", -113788a118416 -> "description": "Fixed amounts displayed when collecting a tip", -113794a118423 -> "description": "Percentages displayed when collecting a tip", -113800a118430 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113807a118438 -> "description": "Tipping configuration for CZK", -113809a118441 -> "description": "Fixed amounts displayed when collecting a tip", -113815a118448 -> "description": "Percentages displayed when collecting a tip", -113821a118455 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113828a118463 -> "description": "Tipping configuration for DKK", -113830a118466 -> "description": "Fixed amounts displayed when collecting a tip", -113836a118473 -> "description": "Percentages displayed when collecting a tip", -113842a118480 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113849a118488 -> "description": "Tipping configuration for EUR", -113851a118491 -> "description": "Fixed amounts displayed when collecting a tip", -113857a118498 -> "description": "Percentages displayed when collecting a tip", -113863a118505 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113870a118513 -> "description": "Tipping configuration for GBP", -113872a118516 -> "description": "Fixed amounts displayed when collecting a tip", -113878a118523 -> "description": "Percentages displayed when collecting a tip", -113884a118530 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113891a118538 -> "description": "Tipping configuration for HKD", -113893a118541 -> "description": "Fixed amounts displayed when collecting a tip", -113899a118548 -> "description": "Percentages displayed when collecting a tip", -113905a118555 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113912a118563 -> "description": "Tipping configuration for MYR", -113914a118566 -> "description": "Fixed amounts displayed when collecting a tip", -113920a118573 -> "description": "Percentages displayed when collecting a tip", -113926a118580 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113933a118588 -> "description": "Tipping configuration for NOK", -113935a118591 -> "description": "Fixed amounts displayed when collecting a tip", -113941a118598 -> "description": "Percentages displayed when collecting a tip", -113947a118605 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113954a118613 -> "description": "Tipping configuration for NZD", -113956a118616 -> "description": "Fixed amounts displayed when collecting a tip", -113962a118623 -> "description": "Percentages displayed when collecting a tip", -113968a118630 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113975a118638 -> "description": "Tipping configuration for SEK", -113977a118641 -> "description": "Fixed amounts displayed when collecting a tip", -113983a118648 -> "description": "Percentages displayed when collecting a tip", -113989a118655 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -113996a118663 -> "description": "Tipping configuration for SGD", -113998a118666 -> "description": "Fixed amounts displayed when collecting a tip", -114004a118673 -> "description": "Percentages displayed when collecting a tip", -114010a118680 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114017a118688 -> "description": "Tipping configuration for USD", -114019a118691 -> "description": "Fixed amounts displayed when collecting a tip", -114025a118698 -> "description": "Percentages displayed when collecting a tip", -114031a118705 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114065c118739,118740 -< ] ---- -> ], -> "description": "A File ID representing an image you would like displayed on the reader." -114281c118956,118957 -< ] ---- -> ], -> "description": "A File ID representing an image you would like displayed on the reader." -114308a118985 -> "description": "Tipping configuration for AUD", -114310a118988 -> "description": "Fixed amounts displayed when collecting a tip", -114316a118995 -> "description": "Percentages displayed when collecting a tip", -114322a119002 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114329a119010 -> "description": "Tipping configuration for CAD", -114331a119013 -> "description": "Fixed amounts displayed when collecting a tip", -114337a119020 -> "description": "Percentages displayed when collecting a tip", -114343a119027 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114350a119035 -> "description": "Tipping configuration for CHF", -114352a119038 -> "description": "Fixed amounts displayed when collecting a tip", -114358a119045 -> "description": "Percentages displayed when collecting a tip", -114364a119052 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114371a119060 -> "description": "Tipping configuration for CZK", -114373a119063 -> "description": "Fixed amounts displayed when collecting a tip", -114379a119070 -> "description": "Percentages displayed when collecting a tip", -114385a119077 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114392a119085 -> "description": "Tipping configuration for DKK", -114394a119088 -> "description": "Fixed amounts displayed when collecting a tip", -114400a119095 -> "description": "Percentages displayed when collecting a tip", -114406a119102 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114413a119110 -> "description": "Tipping configuration for EUR", -114415a119113 -> "description": "Fixed amounts displayed when collecting a tip", -114421a119120 -> "description": "Percentages displayed when collecting a tip", -114427a119127 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114434a119135 -> "description": "Tipping configuration for GBP", -114436a119138 -> "description": "Fixed amounts displayed when collecting a tip", -114442a119145 -> "description": "Percentages displayed when collecting a tip", -114448a119152 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114455a119160 -> "description": "Tipping configuration for HKD", -114457a119163 -> "description": "Fixed amounts displayed when collecting a tip", -114463a119170 -> "description": "Percentages displayed when collecting a tip", -114469a119177 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114476a119185 -> "description": "Tipping configuration for MYR", -114478a119188 -> "description": "Fixed amounts displayed when collecting a tip", -114484a119195 -> "description": "Percentages displayed when collecting a tip", -114490a119202 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114497a119210 -> "description": "Tipping configuration for NOK", -114499a119213 -> "description": "Fixed amounts displayed when collecting a tip", -114505a119220 -> "description": "Percentages displayed when collecting a tip", -114511a119227 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114518a119235 -> "description": "Tipping configuration for NZD", -114520a119238 -> "description": "Fixed amounts displayed when collecting a tip", -114526a119245 -> "description": "Percentages displayed when collecting a tip", -114532a119252 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114539a119260 -> "description": "Tipping configuration for SEK", -114541a119263 -> "description": "Fixed amounts displayed when collecting a tip", -114547a119270 -> "description": "Percentages displayed when collecting a tip", -114553a119277 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114560a119285 -> "description": "Tipping configuration for SGD", -114562a119288 -> "description": "Fixed amounts displayed when collecting a tip", -114568a119295 -> "description": "Percentages displayed when collecting a tip", -114574a119302 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114581a119310 -> "description": "Tipping configuration for USD", -114583a119313 -> "description": "Fixed amounts displayed when collecting a tip", -114589a119320 -> "description": "Percentages displayed when collecting a tip", -114595a119327 -> "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed", -114630c119362,119363 -< ] ---- -> ], -> "description": "A File ID representing an image you would like displayed on the reader." -114894a119628 -> "description": "City, district, suburb, town, or village.", -114898a119633 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -114902a119638 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -114906a119643 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -114910a119648 -> "description": "ZIP or postal code.", -114914a119653 -> "description": "State, county, province, or region.", -115158a119898 -> "description": "City, district, suburb, town, or village.", -115162a119903 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -115166a119908 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -115170a119913 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -115174a119918 -> "description": "ZIP or postal code.", -115178a119923 -> "description": "State, county, province, or region.", -115860a120606 -> "description": "Override showing a tipping selection screen on this transaction.", -115863a120610 -> "description": "Tipping configuration for this transaction.", -115865a120613 -> "description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).", -116025a120774 -> "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).", -116028a120778 -> "description": "Array of line items that were purchased.", -116031a120782 -> "description": "The price of the item in cents.", -116034a120786 -> "description": "The description or name of the item.", -116038a120791 -> "description": "The quantity of the line item being purchased.", -116052a120806 -> "description": "The amount of tax in cents.", -116055a120810 -> "description": "Total balance of cart due in cents.", -116569a121325 -> "description": "Card Number", -117053a121810 -> "description": "Reason for the failure.", -117417a122175 -> "description": "The return code to be set on the OutboundPayment object.", -117644a122403 -> "description": "Reason for the return.", -117742a122502 -> "description": "The source type.", -117748a122509 -> "description": "Optional fields for `us_bank_account`.", -117750a122512 -> "description": "The bank account holder's name.", -117754a122517 -> "description": "The bank account number.", -117758a122522 -> "description": "The bank account's routing number.", -117866a122631 -> "description": "The source type.", -117872a122638 -> "description": "Optional fields for `us_bank_account`.", -117874a122641 -> "description": "The bank account holder's name.", -117878a122646 -> "description": "The bank account number.", -117882a122651 -> "description": "The bank account's routing number.", -117984a122754 -> "description": "The business type.", -117994a122765 -> "description": "Information about the company or business.", -117996a122768 -> "description": "The company's primary address.", -117998a122771 -> "description": "City, district, suburb, town, or village.", -118002a122776 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118006a122781 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -118010a122786 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -118014a122791 -> "description": "ZIP or postal code.", -118018a122796 -> "description": "State, county, province, or region.", -118026a122805 -> "description": "The Kana variation of the company's primary address (Japan only).", -118028a122808 -> "description": "City or ward.", -118032a122813 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118036a122818 -> "description": "Block or building number.", -118040a122823 -> "description": "Building details.", -118044a122828 -> "description": "Postal code.", -118048a122833 -> "description": "Prefecture.", -118052a122838 -> "description": "Town or cho-me.", -118060a122847 -> "description": "The Kanji variation of the company's primary address (Japan only).", -118062a122850 -> "description": "City or ward.", -118066a122855 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118070a122860 -> "description": "Block or building number.", -118074a122865 -> "description": "Building details.", -118078a122870 -> "description": "Postal code.", -118082a122875 -> "description": "Prefecture.", -118086a122880 -> "description": "Town or cho-me.", -118094a122889 -> "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", -118097a122893 -> "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement.", -118100a122897 -> "description": "The company's legal name.", -118104a122902 -> "description": "The Kana variation of the company's legal name (Japan only).", -118108a122907 -> "description": "The Kanji variation of the company's legal name (Japan only).", -118112a122912 -> "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement.", -118115a122916 -> "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.", -118117a122919 -> "description": "The Unix timestamp marking when the beneficial owner attestation was made.", -118121a122924 -> "description": "The IP address from which the beneficial owner attestation was made.", -118124a122928 -> "description": "The user agent of the browser from which the beneficial owner attestation was made.", -118132a122937 -> "description": "Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.", -118135a122941 -> "description": "The company's phone number (used for verification).", -118139a122946 -> "description": "The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).", -118143a122951 -> "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.", -118170a122979 -> "description": "The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)", -118174a122984 -> "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).", -118178a122989 -> "description": "The VAT number of the company.", -118182a122994 -> "description": "Information on the verification state of the company.", -118184a122997 -> "description": "A document verifying the business.", -118186a123000 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118190a123005 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118206a123022 -> "description": "Information about the person represented by the account.", -118208a123025 -> "description": "The individual's primary address.", -118210a123028 -> "description": "City, district, suburb, town, or village.", -118214a123033 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118218a123038 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -118222a123043 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -118226a123048 -> "description": "ZIP or postal code.", -118230a123053 -> "description": "State, county, province, or region.", -118238a123062 -> "description": "The Kana variation of the the individual's primary address (Japan only).", -118240a123065 -> "description": "City or ward.", -118244a123070 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118248a123075 -> "description": "Block or building number.", -118252a123080 -> "description": "Building details.", -118256a123085 -> "description": "Postal code.", -118260a123090 -> "description": "Prefecture.", -118264a123095 -> "description": "Town or cho-me.", -118272a123104 -> "description": "The Kanji variation of the the individual's primary address (Japan only).", -118274a123107 -> "description": "City or ward.", -118278a123112 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118282a123117 -> "description": "Block or building number.", -118286a123122 -> "description": "Building details.", -118290a123127 -> "description": "Postal code.", -118294a123132 -> "description": "Prefecture.", -118298a123137 -> "description": "Town or cho-me.", -118310a123150 -> "description": "The day of birth, between 1 and 31.", -118313a123154 -> "description": "The month of birth, between 1 and 12.", -118316a123158 -> "description": "The four-digit year of birth.", -118334c123176,123177 -< ] ---- -> ], -> "description": "The individual's date of birth." -118336a123180 -> "description": "The individual's email address.", -118339a123184 -> "description": "The individual's first name.", -118343a123189 -> "description": "The Kana variation of the the individual's first name (Japan only).", -118347a123194 -> "description": "The Kanji variation of the individual's first name (Japan only).", -118366c123213,123214 -< ] ---- -> ], -> "description": "A list of alternate names or aliases that the individual is known by." -118368a123217 -> "description": "The individual's gender (International regulations require either \"male\" or \"female\").", -118371a123221 -> "description": "The government-issued ID number of the individual, as appropriate for the representative’s country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -118375a123226 -> "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -118379a123231 -> "description": "The individual's last name.", -118383a123236 -> "description": "The Kana variation of the individual's last name (Japan only).", -118387a123241 -> "description": "The Kanji variation of the individual's last name (Japan only).", -118391a123246 -> "description": "The individual's maiden name.", -118409c123264,123265 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -118411a123268 -> "description": "The individual's phone number.", -118414a123272 -> "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.", -118421a123280 -> "description": "The individual's registered address.", -118423a123283 -> "description": "City, district, suburb, town, or village.", -118427a123288 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118431a123293 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -118435a123298 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -118439a123303 -> "description": "ZIP or postal code.", -118443a123308 -> "description": "State, county, province, or region.", -118451a123317 -> "description": "The last four digits of the individual's Social Security Number (U.S. only).", -118455a123322 -> "description": "The individual's verification document information.", -118457a123325 -> "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", -118459a123328 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118463a123333 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118471a123342 -> "description": "An identifying document, either a passport or local ID card.", -118473a123345 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118477a123350 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118493a123367 -> "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/docs/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", -118503a123378 -> "description": "The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.", -118507a123383 -> "description": "The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.", -118515a123392 -> "description": "The account number for the bank account, in string form. Must be a checking account.", -118519a123397 -> "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", -118529a123408 -> "description": "The country in which the bank account is located.", -118533a123413 -> "description": "The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)", -118536a123417 -> "description": "The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required.", -118608c123489,123492 -< "type": "object" ---- -> "type": "object", -> "x-stripeParam": { -> "class_name": "Card" -> } -118625a123510 -> "description": "The CVC value, in string form.", -118647a123533 -> "description": "The person's address.", -118649a123536 -> "description": "City, district, suburb, town, or village.", -118653a123541 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118657a123546 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -118661a123551 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -118665a123556 -> "description": "ZIP or postal code.", -118669a123561 -> "description": "State, county, province, or region.", -118677a123570 -> "description": "The Kana variation of the person's address (Japan only).", -118679a123573 -> "description": "City or ward.", -118683a123578 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118687a123583 -> "description": "Block or building number.", -118691a123588 -> "description": "Building details.", -118695a123593 -> "description": "Postal code.", -118699a123598 -> "description": "Prefecture.", -118703a123603 -> "description": "Town or cho-me.", -118711a123612 -> "description": "The Kanji variation of the person's address (Japan only).", -118713a123615 -> "description": "City or ward.", -118717a123620 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118721a123625 -> "description": "Block or building number.", -118725a123630 -> "description": "Building details.", -118729a123635 -> "description": "Postal code.", -118733a123640 -> "description": "Prefecture.", -118737a123645 -> "description": "Town or cho-me.", -118749a123658 -> "description": "The day of birth, between 1 and 31.", -118752a123662 -> "description": "The month of birth, between 1 and 12.", -118755a123666 -> "description": "The four-digit year of birth.", -118773c123684,123685 -< ] ---- -> ], -> "description": "The person's date of birth." -118775a123688 -> "description": "Documents that may be submitted to satisfy various informational requests.", -118777a123691 -> "description": "One or more documents that demonstrate proof that this person is authorized to represent the company.", -118779a123694 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -118790a123706 -> "description": "One or more documents showing the person's passport page with photo and personal data.", -118792a123709 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -118803a123721 -> "description": "One or more documents showing the person's visa required for living in the country where they are residing.", -118805a123724 -> "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", -118820a123740 -> "description": "The person's email address.", -118823a123744 -> "description": "The person's first name.", -118827a123749 -> "description": "The Kana variation of the person's first name (Japan only).", -118831a123754 -> "description": "The Kanji variation of the person's first name (Japan only).", -118850c123773,123774 -< ] ---- -> ], -> "description": "A list of alternate names or aliases that the person is known by." -118852a123777 -> "description": "The person's gender (International regulations require either \"male\" or \"female\").", -118855a123781 -> "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -118859a123786 -> "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).", -118863a123791 -> "description": "The person's last name.", -118867a123796 -> "description": "The Kana variation of the person's last name (Japan only).", -118871a123801 -> "description": "The Kanji variation of the person's last name (Japan only).", -118875a123806 -> "description": "The person's maiden name.", -118893c123824,123825 -< ] ---- -> ], -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." -118895a123828 -> "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.", -118899a123833 -> "description": "The person's phone number.", -118902a123837 -> "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.", -118906a123842 -> "description": "The person's registered address.", -118908a123845 -> "description": "City, district, suburb, town, or village.", -118912a123850 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -118916a123855 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -118920a123860 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -118924a123865 -> "description": "ZIP or postal code.", -118928a123870 -> "description": "State, county, province, or region.", -118936a123879 -> "description": "The relationship that this person has with the account's legal entity.", -118938a123882 -> "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", -118941a123886 -> "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", -118944a123890 -> "description": "Whether the person is an owner of the account’s legal entity.", -118958c123904,123905 -< ] ---- -> ], -> "description": "The percent owned by the person of the account's legal entity." -118960a123908 -> "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.", -118963a123912 -> "description": "The person's title (e.g., CEO, Support Engineer).", -118971a123921 -> "description": "The last four digits of the person's Social Security number (U.S. only).", -118974a123925 -> "description": "The person's verification status.", -118976a123928 -> "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.", -118978a123931 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118982a123936 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118990a123945 -> "description": "An identifying document, either a passport or local ID card.", -118992a123948 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -118996a123953 -> "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`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.", -119015a123973 -> "description": "The `id_number` for the PII, in string form.", -119137a124096 -> "description": "Minimum value to filter by (exclusive)", -119140a124100 -> "description": "Minimum value to filter by (inclusive)", -119143a124104 -> "description": "Maximum value to filter by (exclusive)", -119146a124108 -> "description": "Maximum value to filter by (inclusive)", -119170a124133 -> "description": "Minimum value to filter by (exclusive)", -119173a124137 -> "description": "Minimum value to filter by (inclusive)", -119176a124141 -> "description": "Maximum value to filter by (exclusive)", -119179a124145 -> "description": "Maximum value to filter by (inclusive)", -119676a124643 -> "description": "Minimum value to filter by (exclusive)", -119679a124647 -> "description": "Minimum value to filter by (inclusive)", -119682a124651 -> "description": "Maximum value to filter by (exclusive)", -119685a124655 -> "description": "Maximum value to filter by (inclusive)", -121147a126118 -> "description": "Minimum value to filter by (exclusive)", -121150a126122 -> "description": "Minimum value to filter by (inclusive)", -121153a126126 -> "description": "Maximum value to filter by (exclusive)", -121156a126130 -> "description": "Maximum value to filter by (inclusive)", -121332a126307 -> "description": "Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.", -121334a126310 -> "description": "Whether the FinancialAccount should have the Feature.", -121344a126321 -> "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", -121346a126324 -> "description": "Whether the FinancialAccount should have the Feature.", -121356a126335 -> "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", -121358a126338 -> "description": "Adds an ABA FinancialAddress to the FinancialAccount.", -121360a126341 -> "description": "Whether the FinancialAccount should have the Feature.", -121374a126356 -> "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", -121376a126359 -> "description": "Enables ACH Debits via the InboundTransfers API.", -121378a126362 -> "description": "Whether the FinancialAccount should have the Feature.", -121392a126377 -> "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", -121394a126380 -> "description": "Whether the FinancialAccount should have the Feature.", -121404a126391 -> "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", -121406a126394 -> "description": "Enables ACH transfers via the OutboundPayments API.", -121408a126397 -> "description": "Whether the FinancialAccount should have the Feature.", -121418a126408 -> "description": "Enables US domestic wire tranfers via the OutboundPayments API.", -121420a126411 -> "description": "Whether the FinancialAccount should have the Feature.", -121434a126426 -> "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", -121436a126429 -> "description": "Enables ACH transfers via the OutboundTransfers API.", -121438a126432 -> "description": "Whether the FinancialAccount should have the Feature.", -121448a126443 -> "description": "Enables US domestic wire tranfers via the OutboundTransfers API.", -121450a126446 -> "description": "Whether the FinancialAccount should have the Feature.", -121478a126475 -> "description": "Restricts all inbound money movement.", -121485a126483 -> "description": "Restricts all outbound money movement.", -121655a126654 -> "description": "Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.", -121657a126657 -> "description": "Whether the FinancialAccount should have the Feature.", -121667a126668 -> "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", -121669a126671 -> "description": "Whether the FinancialAccount should have the Feature.", -121679a126682 -> "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", -121681a126685 -> "description": "Adds an ABA FinancialAddress to the FinancialAccount.", -121683a126688 -> "description": "Whether the FinancialAccount should have the Feature.", -121697a126703 -> "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", -121699a126706 -> "description": "Enables ACH Debits via the InboundTransfers API.", -121701a126709 -> "description": "Whether the FinancialAccount should have the Feature.", -121715a126724 -> "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", -121717a126727 -> "description": "Whether the FinancialAccount should have the Feature.", -121727a126738 -> "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", -121729a126741 -> "description": "Enables ACH transfers via the OutboundPayments API.", -121731a126744 -> "description": "Whether the FinancialAccount should have the Feature.", -121741a126755 -> "description": "Enables US domestic wire tranfers via the OutboundPayments API.", -121743a126758 -> "description": "Whether the FinancialAccount should have the Feature.", -121757a126773 -> "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", -121759a126776 -> "description": "Enables ACH transfers via the OutboundTransfers API.", -121761a126779 -> "description": "Whether the FinancialAccount should have the Feature.", -121771a126790 -> "description": "Enables US domestic wire tranfers via the OutboundTransfers API.", -121773a126793 -> "description": "Whether the FinancialAccount should have the Feature.", -121801a126822 -> "description": "Restricts all inbound money movement.", -121808a126830 -> "description": "Restricts all outbound money movement.", -121975a126998 -> "description": "Whether the FinancialAccount should have the Feature.", -121988a127012 -> "description": "Whether the FinancialAccount should have the Feature.", -122009a127034 -> "description": "Adds an ABA FinancialAddress to the FinancialAccount.", -122011a127037 -> "description": "Whether the FinancialAccount should have the Feature.", -122028a127055 -> "description": "Enables ACH Debits via the InboundTransfers API.", -122030a127058 -> "description": "Whether the FinancialAccount should have the Feature.", -122047a127076 -> "description": "Whether the FinancialAccount should have the Feature.", -122060a127090 -> "description": "Enables ACH transfers via the OutboundPayments API.", -122062a127093 -> "description": "Whether the FinancialAccount should have the Feature.", -122072a127104 -> "description": "Enables US domestic wire tranfers via the OutboundPayments API.", -122074a127107 -> "description": "Whether the FinancialAccount should have the Feature.", -122091a127125 -> "description": "Enables ACH transfers via the OutboundTransfers API.", -122093a127128 -> "description": "Whether the FinancialAccount should have the Feature.", -122103a127139 -> "description": "Enables US domestic wire tranfers via the OutboundTransfers API.", -122105a127142 -> "description": "Whether the FinancialAccount should have the Feature.", -122755a127793 -> "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", -122761a127800 -> "description": "City, district, suburb, town, or village.", -122765a127805 -> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", -122769a127810 -> "description": "Address line 1 (e.g., street, PO Box, or company name).", -122773a127815 -> "description": "Address line 2 (e.g., apartment, suite, unit, or building).", -122777a127820 -> "description": "ZIP or postal code.", -122781a127825 -> "description": "State, county, province, or region.", -122795c127839,127840 -< ] ---- -> ], -> "description": "Billing address." -122808c127853,127854 -< ] ---- -> ], -> "description": "Email address." -122810a127857 -> "description": "Full name.", -122814a127862 -> "description": "Billing phone number (including extension).", -122822a127871 -> "description": "Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.", -122828a127878 -> "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", -122831a127882 -> "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.", -122838a127890 -> "description": "Required hash if type is set to `us_bank_account`.", -122840a127893 -> "description": "Account holder type: individual or company.", -122847a127901 -> "description": "Account number of the bank account.", -122851a127906 -> "description": "Account type: checkings or savings. Defaults to checking if omitted.", -122858a127914 -> "description": "The ID of a Financial Connections Account to use as a payment method.", -122862a127919 -> "description": "Routing number of the bank account.", -122884a127942 -> "description": "The US bank account network that must be used for this OutboundPayment. If not set, we will default to the PaymentMethod's preferred network.", -122901c127959,127960 -< ] ---- -> ], -> "description": "Optional fields for `us_bank_account`." -122910a127970 -> "description": "IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`.", -122913a127974 -> "description": "`True` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.", -123318a128380 -> "description": "Designate the OutboundTransfer as using a US bank account network configuration.", -123335c128397,128398 -< ] ---- -> ], -> "description": "Optional fields for `us_bank_account`." -123595a128659 -> "description": "The source flow type.", -124015a129080 -> "description": "Minimum value to filter by (exclusive)", -124018a129084 -> "description": "Minimum value to filter by (inclusive)", -124021a129088 -> "description": "Maximum value to filter by (exclusive)", -124024a129092 -> "description": "Maximum value to filter by (inclusive)", -124047a129116 -> "description": "Minimum value to filter by (exclusive)", -124050a129120 -> "description": "Minimum value to filter by (inclusive)", -124053a129124 -> "description": "Maximum value to filter by (exclusive)", -124056a129128 -> "description": "Maximum value to filter by (inclusive)", -124309a129382 -> "description": "Minimum value to filter by (exclusive)", -124312a129386 -> "description": "Minimum value to filter by (inclusive)", -124315a129390 -> "description": "Maximum value to filter by (exclusive)", -124318a129394 -> "description": "Maximum value to filter by (inclusive)", -124431a129508 -> "description": "Minimum value to filter by (exclusive)", -124434a129512 -> "description": "Minimum value to filter by (inclusive)", -124437a129516 -> "description": "Maximum value to filter by (exclusive)", -124440a129520 -> "description": "Maximum value to filter by (inclusive)", -124450c129530,129531 -< ] ---- -> ], -> "description": "Returns Transactions with `posted_at` within the specified range." diff --git a/out.log b/out.log deleted file mode 100644 index 3ee3b9f8c..000000000 --- a/out.log +++ /dev/null @@ -1,236 +0,0 @@ -[cargo-make] INFO - cargo make 0.35.0 -[cargo-make] INFO - Project: async-stripe -[cargo-make] INFO - Build File: Makefile.toml -[cargo-make] INFO - Task: openapi-install -[cargo-make] INFO - Profile: development -[cargo-make] INFO - Running Task: legacy-migration -[cargo-make] INFO - Execute Command: "rm" "-rf" "spec3.sdk.json" "out" -[cargo-make] INFO - Execute Command: "cargo" "run" "spec3.sdk.json" "--fetch" "current" -[2m2023-03-06T20:20:30.089552Z[0m [32m INFO[0m [2mstripe_openapi_codegen[0m[2m:[0m generating code for spec3.sdk.json to out -[2m2023-03-06T20:20:30.107468Z[0m [32m INFO[0m [2mstripe_openapi_codegen::spec_fetch[0m[2m:[0m Fetching OpenAPI spec version v223 -[2m2023-03-06T20:20:34.462535Z[0m [32m INFO[0m [2mstripe_openapi_codegen::spec_fetch[0m[2m:[0m Wrote OpenAPI spec to spec3.sdk.json -[2m2023-03-06T20:20:34.870998Z[0m [32m INFO[0m [2mstripe_openapi_codegen[0m[2m:[0m Finished parsing spec - flattenedAPISections: {"intro":{"title":"Introduction","group_title":"Topics","group_anchor":"topics","anchor":"intro","section_anchor":"intro","subsection_anchors":[],"path":"/","gate":false,"display_on_load":true,"data":{"merchant":false,"test_key":"sk_test_4eC39HqLyjWDarjtT1zdp7dc","user_email":null,"login_as":null,"section_type":"override","section_tag":"intro","version":null}},"authentication":{"title":"Authentication","group_title":"Topics","group_anchor":"topics","anchor":"authentication","section_anchor":"authentication","subsection_anchors":[],"path":"/authentication","gate":false,"display_on_load":true,"data":{"example_explicit_api_key":"","merchant":false,"request":"curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:\n# The colon prevents curl from asking for a password.","test_key":"sk_test_4eC39HqLyjWDarjtT1zdp7dc","section_type":"override","section_tag":"authentication","version":null}},"connected_accounts":{"title":"Connected Accounts","group_title":"Topics","group_anchor":"topics","anchor":"connected_accounts","section_anchor":"connected_accounts","subsection_anchors":[],"path":"/connected_accounts","gate":false,"display_on_load":true,"data":{"example_explicit_account":"curl https://api.stripe.com/v1/charges/ch_3Mik892eZvKYlo2C1PpFTUfK \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -H \"Stripe-Account: acct_1032D82eZvKYlo2C\" \\\n -G \n","section_type":"override","section_tag":"connected_accounts","version":null}},"errors":{"title":"Errors","group_title":"Topics","group_anchor":"topics","anchor":"errors","section_anchor":"errors","subsection_anchors":["error_handling"],"path":"/errors","gate":false,"display_on_load":true,"data":{"changes":{},"specs":{"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`","undocumented":false,"html":"The type of error returned. One of \u003Ccode\u003Eapi_error\u003C/code\u003E, \u003Ccode\u003Ecard_error\u003C/code\u003E, \u003Ccode\u003Eidempotency_error\u003C/code\u003E, or \u003Ccode\u003Einvalid_request_error\u003C/code\u003E"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For card errors, the ID of the failed charge.","undocumented":false,"html":"For card errors, the ID of the failed charge."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"charge","less_common":true},"code":{"name":"code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For some errors that could be handled programmatically, a short string indicating the [error code](/docs/error-codes) reported.","undocumented":false,"html":"For some errors that could be handled programmatically, a short string indicating the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"code"},"decline_code":{"name":"decline_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](/docs/declines#issuer-declines) if they provide one.","undocumented":false,"html":"For card errors resulting from a card issuer decline, a short string indicating the \u003Ca href=\"/docs/declines#issuer-declines\"\u003Ecard issuer’s reason for the decline\u003C/a\u003E if they provide one."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"decline_code"},"doc_url":{"name":"doc_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A URL to more information about the [error code](/docs/error-codes) reported.","undocumented":false,"html":"A URL to more information about the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"doc_url","less_common":true},"message":{"name":"message","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.","undocumented":false,"html":"A human-readable message providing more details about the error. For card errors, these messages can be shown to your users."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"message"},"param":{"name":"param","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"param"},"payment_intent":{"name":"payment_intent","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The PaymentIntent object for errors returned on a request involving a PaymentIntent.","undocumented":false,"html":"The PaymentIntent object for errors returned on a request involving a PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_intent","subspec":{"id":{"name":"id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Unique identifier for the object.","undocumented":false,"html":"Unique identifier for the object."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"id"},"object":{"name":"object","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"String representing the object's type. Objects of the same type share the same value.","undocumented":false,"html":"String representing the object’s type. Objects of the same type share the same value."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"object","less_common":true},"amount":{"name":"amount","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](/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](/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).","undocumented":false,"html":"Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the \u003Ca href=\"/docs/currencies#zero-decimal\"\u003Esmallest currency unit\u003C/a\u003E (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 \u003Ca href=\"/docs/currencies#minimum-and-maximum-charge-amounts\"\u003Eequivalent in charge currency\u003C/a\u003E. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount"},"amount_capturable":{"name":"amount_capturable","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Amount that can be captured from this PaymentIntent.","undocumented":false,"html":"Amount that can be captured from this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_capturable","less_common":true},"amount_details":{"name":"amount_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Details about items included in the amount","undocumented":false,"html":"Details about items included in the amount"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"tip":{"name":"tip","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Portion of the amount that corresponds to a tip.\n","undocumented":false,"html":"Portion of the amount that corresponds to a tip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount":{"name":"amount","check":"nonnegative_integer","validation":"positive integer or zero","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Portion of the amount that corresponds to a tip.\n","undocumented":false,"html":"Portion of the amount that corresponds to a tip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount"}},"object_type":"tip"}},"object_type":"amount_details","less_common":true},"amount_received":{"name":"amount_received","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Amount that was collected by this PaymentIntent.","undocumented":false,"html":"Amount that was collected by this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_received","less_common":true},"application":{"name":"application","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the Connect application that created the PaymentIntent.","undocumented":false,"html":"ID of the Connect application that created the PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"Connect only","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["application"],"object_type":"application","less_common":true},"application_fee_amount":{"name":"application_fee_amount","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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](/docs/payments/connected-accounts).\n","undocumented":false,"html":"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 \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"Connect only","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"application_fee_amount","less_common":true},"automatic_payment_methods":{"name":"automatic_payment_methods","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)","undocumented":false,"html":"Settings to configure compatible payment methods from the \u003Ca href=\"https://dashboard.stripe.com/settings/payment_methods\"\u003EStripe Dashboard\u003C/a\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"enabled":{"name":"enabled","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Automatically calculates compatible payment methods","undocumented":false,"html":"Automatically calculates compatible payment methods"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"enabled"}},"object_type":"automatic_payment_methods"},"canceled_at":{"name":"canceled_at","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.","undocumented":false,"html":"Populated when \u003Ccode\u003Estatus\u003C/code\u003E is \u003Ccode\u003Ecanceled\u003C/code\u003E, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"canceled_at","less_common":true},"cancellation_reason":{"name":"cancellation_reason","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`).","undocumented":false,"html":"Reason for cancellation of this PaymentIntent, either user-provided (\u003Ccode\u003Eduplicate\u003C/code\u003E, \u003Ccode\u003Efraudulent\u003C/code\u003E, \u003Ccode\u003Erequested_by_customer\u003C/code\u003E, or \u003Ccode\u003Eabandoned\u003C/code\u003E) or generated by Stripe internally (\u003Ccode\u003Efailed_invoice\u003C/code\u003E, \u003Ccode\u003Evoid_invoice\u003C/code\u003E, or \u003Ccode\u003Eautomatic\u003C/code\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cancellation_reason","less_common":true},"capture_method":{"name":"capture_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Controls when the funds will be captured from the customer's account.\n","undocumented":false,"html":"Controls when the funds will be captured from the customer’s account."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"automatic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"(Default) Stripe automatically captures funds when the customer authorizes the payment.","undocumented":false,"html":"(Default) Stripe automatically captures funds when the customer authorizes the payment."}},"manual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Place a hold on the funds when the customer authorizes the payment, but [don't capture the funds until later](/docs/payments/capture-later). (Not all payment methods support this.)","undocumented":false,"html":"Place a hold on the funds when the customer authorizes the payment, but \u003Ca href=\"/docs/payments/capture-later\"\u003Edon’t capture the funds until later\u003C/a\u003E. (Not all payment methods support this.)"}}},"object_type":"capture_method","less_common":true},"client_secret":{"name":"client_secret","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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, 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](/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.","undocumented":false,"html":"The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \u003C/p\u003E\n\n\u003Cp\u003EThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\u003C/p\u003E\n\n\u003Cp\u003ERefer to our docs to \u003Ca href=\"/docs/payments/accept-a-payment?ui=elements\"\u003Eaccept a payment\u003C/a\u003E and learn about how \u003Ccode\u003Eclient_secret\u003C/code\u003E should be handled."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"client_secret"},"confirmation_method":{"name":"confirmation_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"","undocumented":false,"html":""},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"automatic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"(Default) PaymentIntent can be confirmed using a publishable key. After `next_action`s are handled, no additional confirmation is required to complete the payment.","undocumented":false,"html":"(Default) PaymentIntent can be confirmed using a publishable key. After \u003Ccode\u003Enext_action\u003C/code\u003Es are handled, no additional confirmation is required to complete the payment."}},"manual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All payment attempts must be made using a secret key. The PaymentIntent returns to the `requires_confirmation` state after handling `next_action`s, and requires your server to initiate each payment attempt with an explicit confirmation.","undocumented":false,"html":"All payment attempts must be made using a secret key. The PaymentIntent returns to the \u003Ccode\u003Erequires_confirmation\u003C/code\u003E state after handling \u003Ccode\u003Enext_action\u003C/code\u003Es, and requires your server to initiate each payment attempt with an explicit confirmation."}}},"object_type":"confirmation_method","less_common":true},"created":{"name":"created","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Time at which the object was created. Measured in seconds since the Unix epoch.","undocumented":false,"html":"Time at which the object was created. Measured in seconds since the Unix epoch."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"created","less_common":true},"currency":{"name":"currency","check":"currency","validation":"currency","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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).","undocumented":false,"html":"Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"currency"},"customer":{"name":"customer","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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](#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.\n","undocumented":false,"html":"ID of the Customer this PaymentIntent belongs to, if one exists.\u003C/p\u003E\n\n\u003Cp\u003EPayment methods attached to other Customers cannot be used with this PaymentIntent.\u003C/p\u003E\n\n\u003Cp\u003EIf present in combination with \u003Ca href=\"#payment_intent_object-setup_future_usage\"\u003Esetup_future_usage\u003C/a\u003E, 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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["customer"],"object_type":"customer"},"description":{"name":"description","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An arbitrary string attached to the object. Often useful for displaying to users.","undocumented":false,"html":"An arbitrary string attached to the object. Often useful for displaying to users."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"description"},"invoice":{"name":"invoice","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the invoice that created this PaymentIntent, if it exists.","undocumented":false,"html":"ID of the invoice that created this PaymentIntent, if it exists."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["invoice"],"object_type":"invoice","less_common":true},"last_payment_error":{"name":"last_payment_error","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.","undocumented":false,"html":"The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`","undocumented":false,"html":"The type of error returned. One of \u003Ccode\u003Eapi_error\u003C/code\u003E, \u003Ccode\u003Ecard_error\u003C/code\u003E, \u003Ccode\u003Eidempotency_error\u003C/code\u003E, or \u003Ccode\u003Einvalid_request_error\u003C/code\u003E"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For card errors, the ID of the failed charge.","undocumented":false,"html":"For card errors, the ID of the failed charge."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"charge","less_common":true},"code":{"name":"code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For some errors that could be handled programmatically, a short string indicating the [error code](/docs/error-codes) reported.","undocumented":false,"html":"For some errors that could be handled programmatically, a short string indicating the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"code"},"decline_code":{"name":"decline_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](/docs/declines#issuer-declines) if they provide one.","undocumented":false,"html":"For card errors resulting from a card issuer decline, a short string indicating the \u003Ca href=\"/docs/declines#issuer-declines\"\u003Ecard issuer’s reason for the decline\u003C/a\u003E if they provide one."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"decline_code"},"doc_url":{"name":"doc_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A URL to more information about the [error code](/docs/error-codes) reported.","undocumented":false,"html":"A URL to more information about the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"doc_url","less_common":true},"message":{"name":"message","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.","undocumented":false,"html":"A human-readable message providing more details about the error. For card errors, these messages can be shown to your users."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"message"},"param":{"name":"param","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"param"},"payment_method":{"name":"payment_method","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The PaymentMethod object for errors returned on a request involving a PaymentMethod.","undocumented":false,"html":"The PaymentMethod object for errors returned on a request involving a PaymentMethod."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"id":{"name":"id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Unique identifier for the object.","undocumented":false,"html":"Unique identifier for the object."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"id"},"object":{"name":"object","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"String representing the object's type. Objects of the same type share the same value.","undocumented":false,"html":"String representing the object’s type. Objects of the same type share the same value."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"object","less_common":true},"acss_debit":{"name":"acss_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eacss_debit\u003C/code\u003E PaymentMethod, this hash contains details about the ACSS Debit payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Name of the bank associated with the bank account.","undocumented":false,"html":"Name of the bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"institution_number":{"name":"institution_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Institution number of the bank account.","undocumented":false,"html":"Institution number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"institution_number"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"transit_number":{"name":"transit_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transit number of the bank account.","undocumented":false,"html":"Transit number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"transit_number"}},"object_type":"acss_debit","less_common":true},"affirm":{"name":"affirm","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eaffirm\u003C/code\u003E PaymentMethod, this hash contains details about the Affirm payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"affirm","less_common":true},"afterpay_clearpay":{"name":"afterpay_clearpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003EAfterpayClearpay\u003C/code\u003E PaymentMethod, this hash contains details about the AfterpayClearpay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"afterpay_clearpay","less_common":true},"alipay":{"name":"alipay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003EAlipay\u003C/code\u003E PaymentMethod, this hash contains details about the Alipay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"alipay","less_common":true},"au_becs_debit":{"name":"au_becs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.","undocumented":false,"html":"If this is an \u003Ccode\u003Eau_becs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bsb_number":{"name":"bsb_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Six-digit number identifying bank and branch associated with this bank account.","undocumented":false,"html":"Six-digit number identifying bank and branch associated with this bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bsb_number"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"}},"object_type":"au_becs_debit","less_common":true},"bacs_debit":{"name":"bacs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.","undocumented":false,"html":"If this is a \u003Ccode\u003Ebacs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the Bacs Direct Debit bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"sort_code":{"name":"sort_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Sort code of the bank account. (e.g., `10-20-30`)","undocumented":false,"html":"Sort code of the bank account. (e.g., \u003Ccode\u003E10-20-30\u003C/code\u003E)"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"sort_code"}},"object_type":"bacs_debit","less_common":true},"bancontact":{"name":"bancontact","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ebancontact\u003C/code\u003E PaymentMethod, this hash contains details about the Bancontact payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"bancontact","less_common":true},"billing_details":{"name":"billing_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","undocumented":false,"html":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"address":{"name":"address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing address.","undocumented":false,"html":"Billing address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Email address.","undocumented":false,"html":"Email address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Full name.","undocumented":false,"html":"Full name."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"phone":{"name":"phone","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing phone number (including extension).","undocumented":false,"html":"Billing phone number (including extension)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"phone"}},"object_type":"billing_details"},"blik":{"name":"blik","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eblik\u003C/code\u003E PaymentMethod, this hash contains details about the BLIK payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"blik","less_common":true},"boleto":{"name":"boleto","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eboleto\u003C/code\u003E PaymentMethod, this hash contains details about the Boleto payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":null,"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"tax_id":{"name":"tax_id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies the customer tax id (CNPJ or CPF)","undocumented":false,"html":"Uniquely identifies the customer tax id (CNPJ or CPF)"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"tax_id"}},"object_type":"boleto","less_common":true},"card":{"name":"card","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `card` PaymentMethod, this hash contains the user's card details.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecard\u003C/code\u003E PaymentMethod, this hash contains the user’s card details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"checks":{"name":"checks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Checks on Card address and CVC if provided.","undocumented":false,"html":"Checks on Card address and CVC if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"address_line1_check":{"name":"address_line1_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a address line1 was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"address_line1_check"},"address_postal_code_check":{"name":"address_postal_code_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a address postal code was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"address_postal_code_check"},"cvc_check":{"name":"cvc_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a CVC was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cvc_check"}},"object_type":"checks"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":"card_fingerprint_read","hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"generated_from":{"name":"generated_from","check":"hash","validation":"hash","documentation":{"gate_specific":{"sdk_client_public":{"gate_specific":{},"localize_terms":[],"undocumented":true,"html":null}},"localize_terms":[],"markdown":"Details of the original PaymentMethod that created this object.","undocumented":false,"html":"Details of the original PaymentMethod that created this object."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The charge that created this object.","undocumented":false,"html":"The charge that created this object."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"charge"},"payment_method_details":{"name":"payment_method_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transaction-specific details of the payment method used in the payment.","undocumented":false,"html":"Transaction-specific details of the payment method used in the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"card_present":{"name":"card_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"This hash contains the snapshot of the `card_present` transaction-specific details which generated this `card` payment method.","undocumented":false,"html":"This hash contains the snapshot of the \u003Ccode\u003Ecard_present\u003C/code\u003E transaction-specific details which generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount_authorized":{"name":"amount_authorized","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The authorized amount","undocumented":false,"html":"The authorized amount"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_authorized"},"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"capture_before":{"name":"capture_before","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.","undocumented":false,"html":"When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"capture_before"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"emv_auth_data":{"name":"emv_auth_data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Authorization response cryptogram.","undocumented":false,"html":"Authorization response cryptogram."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"emv_auth_data"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"generated_card":{"name":"generated_card","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"generated_card"},"incremental_authorization_supported":{"name":"incremental_authorization_supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether this [PaymentIntent](/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).","undocumented":false,"html":"Whether this \u003Ca href=\"/docs/api/payment_intents\"\u003EPaymentIntent\u003C/a\u003E is eligible for incremental authorizations. Request support using \u003Ca href=\"/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support\"\u003Erequest_incremental_authorization_support\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"incremental_authorization_supported"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"network":{"name":"network","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Identifies which network this charge was processed on. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ecartes_bancaires\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"network"},"overcapture_supported":{"name":"overcapture_supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Defines whether the authorized amount can be over-captured or not","undocumented":false,"html":"Defines whether the authorized amount can be over-captured or not"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"overcapture_supported"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"},"receipt":{"name":"receipt","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A collection of fields required to be displayed on receipts. Only required for EMV transactions.","undocumented":false,"html":"A collection of fields required to be displayed on receipts. Only required for EMV transactions."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_type":{"name":"account_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of account being debited or credited","undocumented":false,"html":"The type of account being debited or credited"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"credit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A credit account, as when using a credit card","undocumented":false,"html":"A credit account, as when using a credit card"}},"checking":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A checking account, as when using a debit card","undocumented":false,"html":"A checking account, as when using a debit card"}},"prepaid":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A prepaid account, as when using a debit gift card","undocumented":false,"html":"A prepaid account, as when using a debit gift card"}},"unknown":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An unknown account","undocumented":false,"html":"An unknown account"}}},"object_type":"account_type"},"application_cryptogram":{"name":"application_cryptogram","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 9F26, cryptogram generated by the integrated circuit chip.","undocumented":false,"html":"EMV tag 9F26, cryptogram generated by the integrated circuit chip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"application_cryptogram"},"application_preferred_name":{"name":"application_preferred_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Mnenomic of the Application Identifier.","undocumented":false,"html":"Mnenomic of the Application Identifier."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"application_preferred_name"},"authorization_code":{"name":"authorization_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Identifier for this transaction.","undocumented":false,"html":"Identifier for this transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"authorization_code"},"authorization_response_code":{"name":"authorization_response_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 8A. A code returned by the card issuer.","undocumented":false,"html":"EMV tag 8A. A code returned by the card issuer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"authorization_response_code"},"cardholder_verification_method":{"name":"cardholder_verification_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How the cardholder verified ownership of the card.","undocumented":false,"html":"How the cardholder verified ownership of the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_verification_method"},"dedicated_file_name":{"name":"dedicated_file_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.","undocumented":false,"html":"EMV tag 84. Similar to the application identifier stored on the integrated circuit chip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"dedicated_file_name"},"terminal_verification_results":{"name":"terminal_verification_results","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The outcome of a series of EMV functions performed by the card reader.","undocumented":false,"html":"The outcome of a series of EMV functions performed by the card reader."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"terminal_verification_results"},"transaction_status_information":{"name":"transaction_status_information","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An indication of various EMV functions performed during the transaction.","undocumented":false,"html":"An indication of various EMV functions performed during the transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"transaction_status_information"}},"object_type":"receipt"}},"object_type":"card_present"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.","undocumented":false,"html":"The type of payment method transaction-specific details from the transaction that generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method. Always \u003Ccode\u003Ecard_present\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"}},"object_type":"payment_method_details"},"setup_attempt":{"name":"setup_attempt","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the SetupAttempt that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the SetupAttempt that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["setup_attempt"],"object_type":"setup_attempt"}},"object_type":"generated_from"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"three_d_secure_usage":{"name":"three_d_secure_usage","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains details on how this Card may be used for 3D Secure authentication.","undocumented":false,"html":"Contains details on how this Card may be used for 3D Secure authentication."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"supported":{"name":"supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether 3D Secure is supported on this card.","undocumented":false,"html":"Whether 3D Secure is supported on this card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported"}},"object_type":"three_d_secure_usage"},"wallet":{"name":"wallet","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this Card is part of a card wallet, this contains the details of the card wallet.","undocumented":false,"html":"If this Card is part of a card wallet, this contains the details of the card wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amex_express_checkout":{"name":"amex_express_checkout","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `amex_express_checkout` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"amex_express_checkout"},"apple_pay":{"name":"apple_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `apple_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Eapple_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"apple_pay"},"dynamic_last4":{"name":"dynamic_last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"(For tokenized numbers only.) The last four digits of the device account number.","undocumented":false,"html":"(For tokenized numbers only.) The last four digits of the device account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"dynamic_last4"},"google_pay":{"name":"google_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `google_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Egoogle_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"google_pay"},"masterpass":{"name":"masterpass","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `masterpass` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Emasterpass\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"billing_address":{"name":"billing_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"billing_address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"shipping_address":{"name":"shipping_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"shipping_address"}},"object_type":"masterpass"},"samsung_pay":{"name":"samsung_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `samsung_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Esamsung_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"samsung_pay"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"The type of the card wallet, one of \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E, \u003Ccode\u003Eapple_pay\u003C/code\u003E, \u003Ccode\u003Egoogle_pay\u003C/code\u003E, \u003Ccode\u003Emasterpass\u003C/code\u003E, \u003Ccode\u003Esamsung_pay\u003C/code\u003E, or \u003Ccode\u003Evisa_checkout\u003C/code\u003E. 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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"visa_checkout":{"name":"visa_checkout","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `visa_checkout` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Evisa_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"billing_address":{"name":"billing_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"billing_address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"shipping_address":{"name":"shipping_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"shipping_address"}},"object_type":"visa_checkout"}},"object_type":"wallet"}},"object_type":"card","less_common":true},"card_present":{"name":"card_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `card_present` PaymentMethod, this hash contains details about the Card Present payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecard_present\u003C/code\u003E PaymentMethod, this hash contains details about the Card Present payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"}},"object_type":"card_present","less_common":true},"created":{"name":"created","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Time at which the object was created. Measured in seconds since the Unix epoch.","undocumented":false,"html":"Time at which the object was created. Measured in seconds since the Unix epoch."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"created","less_common":true},"customer":{"name":"customer","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["customer"],"object_type":"customer"},"customer_balance":{"name":"customer_balance","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecustomer_balance\u003C/code\u003E PaymentMethod, this hash contains details about the CustomerBalance payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"customer_balance","less_common":true},"eps":{"name":"eps","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eeps\u003C/code\u003E PaymentMethod, this hash contains details about the EPS payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`, `deutsche_bank_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`.","undocumented":false,"html":"The customer’s bank. Should be one of \u003Ccode\u003Earzte_und_apotheker_bank\u003C/code\u003E, \u003Ccode\u003Eaustrian_anadi_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebank_austria\u003C/code\u003E, \u003Ccode\u003Ebankhaus_carl_spangler\u003C/code\u003E, \u003Ccode\u003Ebankhaus_schelhammer_und_schattera_ag\u003C/code\u003E, \u003Ccode\u003Ebawag_psk_ag\u003C/code\u003E, \u003Ccode\u003Ebks_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebrull_kallmus_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebtv_vier_lander_bank\u003C/code\u003E, \u003Ccode\u003Ecapital_bank_grawe_gruppe_ag\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank_ag\u003C/code\u003E, \u003Ccode\u003Edolomitenbank\u003C/code\u003E, \u003Ccode\u003Eeasybank_ag\u003C/code\u003E, \u003Ccode\u003Eerste_bank_und_sparkassen\u003C/code\u003E, \u003Ccode\u003Ehypo_alpeadriabank_international_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_noe_lb_fur_niederosterreich_u_wien\u003C/code\u003E, \u003Ccode\u003Ehypo_oberosterreich_salzburg_steiermark\u003C/code\u003E, \u003Ccode\u003Ehypo_tirol_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_vorarlberg_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_bank_burgenland_aktiengesellschaft\u003C/code\u003E, \u003Ccode\u003Emarchfelder_bank\u003C/code\u003E, \u003Ccode\u003Eoberbank_ag\u003C/code\u003E, \u003Ccode\u003Eraiffeisen_bankengruppe_osterreich\u003C/code\u003E, \u003Ccode\u003Eschoellerbank_ag\u003C/code\u003E, \u003Ccode\u003Esparda_bank_wien\u003C/code\u003E, \u003Ccode\u003Evolksbank_gruppe\u003C/code\u003E, \u003Ccode\u003Evolkskreditbank_ag\u003C/code\u003E, or \u003Ccode\u003Evr_bank_braunau\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"}},"object_type":"eps","less_common":true},"fpx":{"name":"fpx","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Efpx\u003C/code\u003E PaymentMethod, this hash contains details about the FPX payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `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`, `pb_enterprise`, or `bank_of_china`.","undocumented":false,"html":"The customer’s bank, if provided. Can be one of \u003Ccode\u003Eaffin_bank\u003C/code\u003E, \u003Ccode\u003Eagrobank\u003C/code\u003E, \u003Ccode\u003Ealliance_bank\u003C/code\u003E, \u003Ccode\u003Eambank\u003C/code\u003E, \u003Ccode\u003Ebank_islam\u003C/code\u003E, \u003Ccode\u003Ebank_muamalat\u003C/code\u003E, \u003Ccode\u003Ebank_rakyat\u003C/code\u003E, \u003Ccode\u003Ebsn\u003C/code\u003E, \u003Ccode\u003Ecimb\u003C/code\u003E, \u003Ccode\u003Ehong_leong_bank\u003C/code\u003E, \u003Ccode\u003Ehsbc\u003C/code\u003E, \u003Ccode\u003Ekfh\u003C/code\u003E, \u003Ccode\u003Emaybank2u\u003C/code\u003E, \u003Ccode\u003Eocbc\u003C/code\u003E, \u003Ccode\u003Epublic_bank\u003C/code\u003E, \u003Ccode\u003Erhb\u003C/code\u003E, \u003Ccode\u003Estandard_chartered\u003C/code\u003E, \u003Ccode\u003Euob\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank\u003C/code\u003E, \u003Ccode\u003Emaybank2e\u003C/code\u003E, \u003Ccode\u003Epb_enterprise\u003C/code\u003E, or \u003Ccode\u003Ebank_of_china\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"}},"object_type":"fpx","less_common":true},"giropay":{"name":"giropay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Egiropay\u003C/code\u003E PaymentMethod, this hash contains details about the Giropay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"giropay","less_common":true},"grabpay":{"name":"grabpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Egrabpay\u003C/code\u003E PaymentMethod, this hash contains details about the GrabPay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"grabpay","less_common":true},"ideal":{"name":"ideal","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eideal\u003C/code\u003E PaymentMethod, this hash contains details about the iDEAL payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`, `van_lanschot`, or `yoursafe`.","undocumented":false,"html":"The customer’s bank, if provided. Can be one of \u003Ccode\u003Eabn_amro\u003C/code\u003E, \u003Ccode\u003Easn_bank\u003C/code\u003E, \u003Ccode\u003Ebunq\u003C/code\u003E, \u003Ccode\u003Ehandelsbanken\u003C/code\u003E, \u003Ccode\u003Eing\u003C/code\u003E, \u003Ccode\u003Eknab\u003C/code\u003E, \u003Ccode\u003Emoneyou\u003C/code\u003E, \u003Ccode\u003Erabobank\u003C/code\u003E, \u003Ccode\u003Eregiobank\u003C/code\u003E, \u003Ccode\u003Erevolut\u003C/code\u003E, \u003Ccode\u003Esns_bank\u003C/code\u003E, \u003Ccode\u003Etriodos_bank\u003C/code\u003E, \u003Ccode\u003Evan_lanschot\u003C/code\u003E, or \u003Ccode\u003Eyoursafe\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"},"bic":{"name":"bic","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The Bank Identifier Code of the customer's bank, if the bank was provided.","undocumented":false,"html":"The Bank Identifier Code of the customer’s bank, if the bank was provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bic"}},"object_type":"ideal","less_common":true},"interac_present":{"name":"interac_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Einterac_present\u003C/code\u003E PaymentMethod, this hash contains details about the Interac Present payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `interac`, `mastercard` or `visa`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E or \u003Ccode\u003Evisa\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"preferred_locales":{"name":"preferred_locales","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.","undocumented":false,"html":"EMV tag 5F2D. Preferred languages specified by the integrated circuit chip."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred_locales"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"}},"object_type":"interac_present","less_common":true},"klarna":{"name":"klarna","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eklarna\u003C/code\u003E PaymentMethod, this hash contains details about the Klarna payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"dob":{"name":"dob","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's date of birth, if provided.","undocumented":false,"html":"The customer’s date of birth, if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":true,"subspec":{"day":{"name":"day","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The day of birth, between 1 and 31.","undocumented":false,"html":"The day of birth, between 1 and 31."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"day"},"month":{"name":"month","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The month of birth, between 1 and 12.","undocumented":false,"html":"The month of birth, between 1 and 12."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"month"},"year":{"name":"year","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The four-digit year of birth.","undocumented":false,"html":"The four-digit year of birth."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"year"}},"object_type":"dob"}},"object_type":"klarna","less_common":true},"konbini":{"name":"konbini","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ekonbini\u003C/code\u003E PaymentMethod, this hash contains details about the Konbini payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"konbini","less_common":true},"link":{"name":"link","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003ELink\u003C/code\u003E PaymentMethod, this hash contains details about the Link payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account owner's email address.","undocumented":false,"html":"Account owner’s email address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"persistent_token":{"name":"persistent_token","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Token used for persistent Link logins.","undocumented":false,"html":"Token used for persistent Link logins."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"persistent_token"}},"object_type":"link","less_common":true},"livemode":{"name":"livemode","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","undocumented":false,"html":"Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"livemode","less_common":true},"metadata":{"name":"metadata","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Set of [key-value pairs](/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.","undocumented":false,"html":"Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"metadata"},"oxxo":{"name":"oxxo","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eoxxo\u003C/code\u003E PaymentMethod, this hash contains details about the OXXO payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"oxxo","less_common":true},"p24":{"name":"p24","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ep24\u003C/code\u003E PaymentMethod, this hash contains details about the P24 payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's bank, if provided.","undocumented":false,"html":"The customer’s bank, if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"ing":{"documentation":null},"citi_handlowy":{"documentation":null},"tmobile_usbugi_bankowe":{"documentation":null},"plus_bank":{"documentation":null},"etransfer_pocztowy24":{"documentation":null},"banki_spbdzielcze":{"documentation":null},"bank_nowy_bfg_sa":{"documentation":null},"getin_bank":{"documentation":null},"blik":{"documentation":null},"noble_pay":{"documentation":null},"ideabank":{"documentation":null},"envelobank":{"documentation":null},"santander_przelew24":{"documentation":null},"nest_przelew":{"documentation":null},"mbank_mtransfer":{"documentation":null},"inteligo":{"documentation":null},"pbac_z_ipko":{"documentation":null},"bnp_paribas":{"documentation":null},"credit_agricole":{"documentation":null},"toyota_bank":{"documentation":null},"bank_pekao_sa":{"documentation":null},"volkswagen_bank":{"documentation":null},"bank_millennium":{"documentation":null},"alior_bank":{"documentation":null},"boz":{"documentation":null}},"object_type":"bank"}},"object_type":"p24","less_common":true},"paynow":{"name":"paynow","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epaynow\u003C/code\u003E PaymentMethod, this hash contains details about the PayNow payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"paynow","less_common":true},"pix":{"name":"pix","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epix\u003C/code\u003E PaymentMethod, this hash contains details about the Pix payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"pix","less_common":true},"promptpay":{"name":"promptpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epromptpay\u003C/code\u003E PaymentMethod, this hash contains details about the PromptPay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"promptpay","less_common":true},"radar_options":{"name":"radar_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Options to configure Radar. See [Radar Session](/docs/radar/radar-session) for more information.","undocumented":false,"html":"Options to configure Radar. See \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E for more information."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"session":{"name":"session","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A [Radar Session](/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.","undocumented":false,"html":"A \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"session"}},"object_type":"radar_options","less_common":true},"sepa_debit":{"name":"sepa_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.","undocumented":false,"html":"If this is a \u003Ccode\u003Esepa_debit\u003C/code\u003E PaymentMethod, this hash contains details about the SEPA debit bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_code":{"name":"bank_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank code of bank associated with the bank account.","undocumented":false,"html":"Bank code of bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_code"},"branch_code":{"name":"branch_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Branch code of bank associated with the bank account.","undocumented":false,"html":"Branch code of bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"branch_code"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter ISO code representing the country the bank account is located in.","undocumented":false,"html":"Two-letter ISO code representing the country the bank account is located in."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"generated_from":{"name":"generated_from","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Information about the object that generated this PaymentMethod.","undocumented":false,"html":"Information about the object that generated this PaymentMethod."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the Charge that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the Charge that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["charge"],"object_type":"charge"},"setup_attempt":{"name":"setup_attempt","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the SetupAttempt that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the SetupAttempt that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["setup_attempt"],"object_type":"setup_attempt"}},"object_type":"generated_from"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four characters of the IBAN.","undocumented":false,"html":"Last four characters of the IBAN."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"}},"object_type":"sepa_debit","less_common":true},"sofort":{"name":"sofort","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Esofort\u003C/code\u003E PaymentMethod, this hash contains details about the SOFORT payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter ISO code representing the country the bank account is located in.","undocumented":false,"html":"Two-letter ISO code representing the country the bank account is located in."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"}},"object_type":"sofort","less_common":true},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"acss_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Pre-authorized debit payments](/docs/payments/acss-debit) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).","undocumented":false,"html":"\u003Ca href=\"/docs/payments/acss-debit\"\u003EPre-authorized debit payments\u003C/a\u003E are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS)."}},"affirm":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Affirm](/docs/payments/affirm) is a buy now, pay later payment method in the US.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/affirm\"\u003EAffirm\u003C/a\u003E is a buy now, pay later payment method in the US."}},"afterpay_clearpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Afterpay / Clearpay](/docs/payments/afterpay-clearpay) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/afterpay-clearpay\"\u003EAfterpay / Clearpay\u003C/a\u003E is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US."}},"alipay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Alipay](/docs/payments/alipay) is a digital wallet payment method used in China.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/alipay\"\u003EAlipay\u003C/a\u003E is a digital wallet payment method used in China."}},"au_becs_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[BECS Direct Debit](/docs/payments/au-becs-debit) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).","undocumented":false,"html":"\u003Ca href=\"/docs/payments/au-becs-debit\"\u003EBECS Direct Debit\u003C/a\u003E is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS)."}},"bacs_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Bacs Direct Debit](/docs/payments/payment-methods/bacs-debit) is used to debit UK bank accounts.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/payment-methods/bacs-debit\"\u003EBacs Direct Debit\u003C/a\u003E is used to debit UK bank accounts."}},"bancontact":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Bancontact](/docs/payments/bancontact) is a bank redirect payment method used in Belgium.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/bancontact\"\u003EBancontact\u003C/a\u003E is a bank redirect payment method used in Belgium."}},"blik":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[BLIK](/docs/payments/blik) is a single-use payment method common in Poland.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/blik\"\u003EBLIK\u003C/a\u003E is a single-use payment method common in Poland."}},"boleto":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Boleto](/docs/payments/boleto) is a voucher-based payment method used in Brazil.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/boleto\"\u003EBoleto\u003C/a\u003E is a voucher-based payment method used in Brazil."}},"card":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Card payments](/docs/payments/payment-methods/overview#cards) are supported through many networks and card brands.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/payment-methods/overview#cards\"\u003ECard payments\u003C/a\u003E are supported through many networks and card brands."}},"card_present":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Stripe Terminal](/docs/terminal/payments/collect-payment) is used to collect in-person card payments.","undocumented":false,"html":"\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E is used to collect in-person card payments."}},"customer_balance":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uses a customer’s [cash balance](/docs/payments/customer-balance) for the payment.","undocumented":false,"html":"Uses a customer’s \u003Ca href=\"/docs/payments/customer-balance\"\u003Ecash balance\u003C/a\u003E for the payment."}},"eps":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[EPS](/docs/payments/eps) is an Austria-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/eps\"\u003EEPS\u003C/a\u003E is an Austria-based bank redirect payment method."}},"fpx":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[FPX](/docs/payments/fpx) is a Malaysia-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/fpx\"\u003EFPX\u003C/a\u003E is a Malaysia-based bank redirect payment method."}},"giropay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[giropay](/docs/payments/giropay) is a German bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/giropay\"\u003Egiropay\u003C/a\u003E is a German bank redirect payment method."}},"grabpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[GrabPay](/docs/payments/grabpay) is a digital wallet payment method used in Southeast Asia.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/grabpay\"\u003EGrabPay\u003C/a\u003E is a digital wallet payment method used in Southeast Asia."}},"ideal":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[iDEAL](/docs/payments/ideal) is a Netherlands-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/ideal\"\u003EiDEAL\u003C/a\u003E is a Netherlands-based bank redirect payment method."}},"interac_present":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Stripe Terminal](/docs/terminal/payments/collect-payment) accepts [Interac](/docs/terminal/payments/regional?integration-country=CA#interac-payments) debit cards for in-person payments in Canada.","undocumented":false,"html":"\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E accepts \u003Ca href=\"/docs/terminal/payments/regional?integration-country=CA#interac-payments\"\u003EInterac\u003C/a\u003E debit cards for in-person payments in Canada."}},"klarna":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Klarna](/docs/payments/klarna) is a global buy now, pay later payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/klarna\"\u003EKlarna\u003C/a\u003E is a global buy now, pay later payment method."}},"konbini":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Konbini](/docs/payments/konbini) is a cash-based voucher payment method used in Japan.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/konbini\"\u003EKonbini\u003C/a\u003E is a cash-based voucher payment method used in Japan."}},"link":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Link](/docs/payments/link) allows customers to pay with their saved payment details.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/link\"\u003ELink\u003C/a\u003E allows customers to pay with their saved payment details."}},"oxxo":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[OXXO](/docs/payments/oxxo) is a cash-based voucher payment method used in Mexico.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/oxxo\"\u003EOXXO\u003C/a\u003E is a cash-based voucher payment method used in Mexico."}},"p24":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Przelewy24](/docs/payments/p24) is a bank redirect payment method used in Poland.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/p24\"\u003EPrzelewy24\u003C/a\u003E is a bank redirect payment method used in Poland."}},"paynow":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[PayNow](/docs/payments/paynow) is a QR code payment method used in Singapore.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/paynow\"\u003EPayNow\u003C/a\u003E is a QR code payment method used in Singapore."}},"pix":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Pix](/docs/payments/pix) is an instant bank transfer payment method in Brazil.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/pix\"\u003EPix\u003C/a\u003E is an instant bank transfer payment method in Brazil."}},"promptpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[PromptPay](/docs/payments/promptpay) is an instant funds transfer service popular in Thailand.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/promptpay\"\u003EPromptPay\u003C/a\u003E is an instant funds transfer service popular in Thailand."}},"sepa_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[SEPA Direct Debit](/docs/payments/sepa-debit) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/sepa-debit\"\u003ESEPA Direct Debit\u003C/a\u003E is used to debit bank accounts within the Single Euro Payments Area (SEPA) region."}},"sofort":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Sofort](/docs/payments/sofort) is a bank redirect payment method used in Europe.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/sofort\"\u003ESofort\u003C/a\u003E is a bank redirect payment method used in Europe."}},"us_bank_account":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[ACH Direct Debit](/docs/payments/ach-debit) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/ach-debit\"\u003EACH Direct Debit\u003C/a\u003E is used to debit US bank accounts through the Automated Clearing House (ACH) payments system."}},"wechat_pay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[WeChat Pay](/docs/payments/wechat-pay) is a digital wallet payment method based in China.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/wechat-pay\"\u003EWeChat Pay\u003C/a\u003E is a digital wallet payment method based in China."}}},"object_type":"type"},"us_bank_account":{"name":"us_bank_account","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eus_bank_account\u003C/code\u003E PaymentMethod, this hash contains details about the US bank account payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_holder_type":{"name":"account_holder_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account holder type: individual or company.","undocumented":false,"html":"Account holder type: individual or company."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"individual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account belongs to an individual","undocumented":false,"html":"Account belongs to an individual"}},"company":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account belongs to a company","undocumented":false,"html":"Account belongs to a company"}}},"object_type":"account_holder_type"},"account_type":{"name":"account_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account type: checkings or savings. Defaults to checking if omitted.","undocumented":false,"html":"Account type: checkings or savings. Defaults to checking if omitted."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"checking":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account type is checking","undocumented":false,"html":"Bank account type is checking"}},"savings":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account type is savings","undocumented":false,"html":"Bank account type is savings"}}},"object_type":"account_type"},"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The name of the bank.","undocumented":false,"html":"The name of the bank."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"financial_connections_account":{"name":"financial_connections_account","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the Financial Connections Account used to create the payment method.","undocumented":false,"html":"The ID of the Financial Connections Account used to create the payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"financial_connections_account"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about US bank account networks that can be used.","undocumented":false,"html":"Contains information about US bank account networks that can be used."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network.","undocumented":false,"html":"The preferred network."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"},"supported":{"name":"supported","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All supported networks.","undocumented":false,"html":"All supported networks."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported"}},"object_type":"networks"},"routing_number":{"name":"routing_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Routing number of the bank account.","undocumented":false,"html":"Routing number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"routing_number"}},"object_type":"us_bank_account","less_common":true},"wechat_pay":{"name":"wechat_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Ewechat_pay\u003C/code\u003E PaymentMethod, this hash contains details about the wechat_pay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"wechat_pay","less_common":true}},"object_type":"payment_method","less_common":true},"payment_method_type":{"name":"payment_method_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_method_type","less_common":true}},"object_type":"last_payment_error"},"latest_charge":{"name":"latest_charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The latest charge created by this payment intent.","undocumented":false,"html":"The latest charge created by this payment intent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["charge"],"object_type":"latest_charge"},"livemode":{"name":"livemode","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","undocumented":false,"html":"Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"livemode","less_common":true},"metadata":{"name":"metadata","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Set of [key-value pairs](/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](/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).","undocumented":false,"html":"Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E 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 \u003Ca href=\"/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata\"\u003Edocumentation\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"metadata"},"next_action":{"name":"next_action","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"alipay_handle_redirect":{"name":"alipay_handle_redirect","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains instructions for authenticating a payment by redirecting your customer to Alipay App or website.","undocumented":false,"html":"Contains instructions for authenticating a payment by redirecting your customer to Alipay App or website."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"native_data":{"name":"native_data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"native_data"},"native_url":{"name":"native_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.","undocumented":false,"html":"The native URL you must redirect your customer to in order to authenticate the payment in an iOS App."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"native_url"},"return_url":{"name":"return_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.","undocumented":false,"html":"If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"return_url"},"url":{"name":"url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL you must redirect your customer to in order to authenticate the payment.","undocumented":false,"html":"The URL you must redirect your customer to in order to authenticate the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"url"}},"object_type":"alipay_handle_redirect"},"boleto_display_details":{"name":"boleto_display_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains Boleto details necessary for the customer to complete the payment.","undocumented":false,"html":"Contains Boleto details necessary for the customer to complete the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"expires_at":{"name":"expires_at","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The timestamp after which the boleto expires.","undocumented":false,"html":"The timestamp after which the boleto expires."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_at"},"hosted_voucher_url":{"name":"hosted_voucher_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.","undocumented":false,"html":"The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_voucher_url"},"number":{"name":"number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The boleto number.","undocumented":false,"html":"The boleto number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"number"},"pdf":{"name":"pdf","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL to the downloadable boleto voucher PDF.","undocumented":false,"html":"The URL to the downloadable boleto voucher PDF."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"pdf"}},"object_type":"boleto_display_details"},"card_await_notification":{"name":"card_await_notification","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains instructions for processing off session recurring payments with Indian issued cards.","undocumented":false,"html":"Contains instructions for processing off session recurring payments with Indian issued cards."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"charge_attempt_at":{"name":"charge_attempt_at","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.","undocumented":false,"html":"The time that payment will be attempted. If customer approval is required, they need to provide approval before this time."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"charge_attempt_at"},"customer_approval_required":{"name":"customer_approval_required","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.","undocumented":false,"html":"For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"customer_approval_required"}},"object_type":"card_await_notification"},"display_bank_transfer_instructions":{"name":"display_bank_transfer_instructions","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains the bank transfer details necessary for the customer to complete the payment.","undocumented":false,"html":"Contains the bank transfer details necessary for the customer to complete the payment."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount_remaining":{"name":"amount_remaining","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The remaining amount that needs to be transferred to complete the payment.","undocumented":false,"html":"The remaining amount that needs to be transferred to complete the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_remaining"},"currency":{"name":"currency","check":"currency","validation":"currency","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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).","undocumented":false,"html":"Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"currency"},"financial_addresses":{"name":"financial_addresses","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A list of financial addresses that can be used to fund the customer balance","undocumented":false,"html":"A list of financial addresses that can be used to fund the customer balance"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"iban":{"name":"iban","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An IBAN-based FinancialAddress","undocumented":false,"html":"An IBAN-based FinancialAddress"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_holder_name":{"name":"account_holder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The name of the person or business that owns the bank account","undocumented":false,"html":"The name of the person or business that owns the bank account"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"account_holder_name"},"bic":{"name":"bic","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The BIC/SWIFT code of the account.","undocumented":false,"html":"The BIC/SWIFT code of the account."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bic"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"iban":{"name":"iban","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The IBAN of the account.","undocumented":false,"html":"The IBAN of the account."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"iban"}},"object_type":"iban"},"sort_code":{"name":"sort_code","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An account number and sort code-based FinancialAddress","undocumented":false,"html":"An account number and sort code-based FinancialAddress"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_holder_name":{"name":"account_holder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The name of the person or business that owns the bank account","undocumented":false,"html":"The name of the person or business that owns the bank account"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"account_holder_name"},"account_number":{"name":"account_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The account number","undocumented":false,"html":"The account number"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"account_number"},"sort_code":{"name":"sort_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The six-digit sort code","undocumented":false,"html":"The six-digit sort code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"sort_code"}},"object_type":"sort_code"},"spei":{"name":"spei","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A SPEI-based FinancialAddress","undocumented":false,"html":"A SPEI-based FinancialAddress"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_code":{"name":"bank_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The three-digit bank code","undocumented":false,"html":"The three-digit bank code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_code"},"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The short banking institution name","undocumented":false,"html":"The short banking institution name"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"clabe":{"name":"clabe","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The CLABE number","undocumented":false,"html":"The CLABE number"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"clabe"}},"object_type":"spei"},"supported_networks":{"name":"supported_networks","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The payment networks supported by this FinancialAddress","undocumented":false,"html":"The payment networks supported by this FinancialAddress"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"bacs":{"documentation":null},"fps":{"documentation":null},"sepa":{"documentation":null},"spei":{"documentation":null},"zengin":{"documentation":null}},"object_type":"supported_networks"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of financial address","undocumented":false,"html":"The type of financial address"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"iban":{"documentation":null},"sort_code":{"documentation":null},"spei":{"documentation":null},"zengin":{"documentation":null}},"object_type":"type"},"zengin":{"name":"zengin","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A Zengin-based FinancialAddress","undocumented":false,"html":"A Zengin-based FinancialAddress"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_holder_name":{"name":"account_holder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The account holder name","undocumented":false,"html":"The account holder name"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"account_holder_name"},"account_number":{"name":"account_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The account number","undocumented":false,"html":"The account number"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"account_number"},"account_type":{"name":"account_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The bank account type. In Japan, this can only be `futsu` or `toza`.","undocumented":false,"html":"The bank account type. In Japan, this can only be \u003Ccode\u003Efutsu\u003C/code\u003E or \u003Ccode\u003Etoza\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"account_type"},"bank_code":{"name":"bank_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The bank code of the account","undocumented":false,"html":"The bank code of the account"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_code"},"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The bank name of the account","undocumented":false,"html":"The bank name of the account"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"branch_code":{"name":"branch_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The branch code of the account","undocumented":false,"html":"The branch code of the account"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"branch_code"},"branch_name":{"name":"branch_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The branch name of the account","undocumented":false,"html":"The branch name of the account"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"branch_name"}},"object_type":"zengin"}},"object_type":"financial_addresses"},"hosted_instructions_url":{"name":"hosted_instructions_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A link to a hosted page that guides your customer through completing the transfer.","undocumented":false,"html":"A link to a hosted page that guides your customer through completing the transfer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_instructions_url"},"reference":{"name":"reference","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.","undocumented":false,"html":"A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"reference"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Type of bank transfer","undocumented":false,"html":"Type of bank transfer"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"eu_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type eu_bank_transfer","undocumented":false,"html":"A bank transfer of type eu_bank_transfer"}},"gb_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type gb_bank_transfer","undocumented":false,"html":"A bank transfer of type gb_bank_transfer"}},"jp_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type jp_bank_transfer","undocumented":false,"html":"A bank transfer of type jp_bank_transfer"}},"mx_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type mx_bank_transfer","undocumented":false,"html":"A bank transfer of type mx_bank_transfer"}}},"object_type":"type"}},"object_type":"display_bank_transfer_instructions"},"konbini_display_details":{"name":"konbini_display_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains Konbini details necessary for the customer to complete the payment.","undocumented":false,"html":"Contains Konbini details necessary for the customer to complete the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"expires_at":{"name":"expires_at","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The timestamp at which the pending Konbini payment expires.","undocumented":false,"html":"The timestamp at which the pending Konbini payment expires."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_at"},"hosted_voucher_url":{"name":"hosted_voucher_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.","undocumented":false,"html":"The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_voucher_url"},"stores":{"name":"stores","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payment instruction details grouped by convenience store chain.","undocumented":false,"html":"Payment instruction details grouped by convenience store chain."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"familymart":{"name":"familymart","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"FamilyMart instruction details.","undocumented":false,"html":"FamilyMart instruction details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"confirmation_number":{"name":"confirmation_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The confirmation number.","undocumented":false,"html":"The confirmation number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"confirmation_number"},"payment_code":{"name":"payment_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The payment code.","undocumented":false,"html":"The payment code."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_code"}},"object_type":"familymart"},"lawson":{"name":"lawson","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Lawson instruction details.","undocumented":false,"html":"Lawson instruction details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"confirmation_number":{"name":"confirmation_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The confirmation number.","undocumented":false,"html":"The confirmation number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"confirmation_number"},"payment_code":{"name":"payment_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The payment code.","undocumented":false,"html":"The payment code."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_code"}},"object_type":"lawson"},"ministop":{"name":"ministop","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Ministop instruction details.","undocumented":false,"html":"Ministop instruction details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"confirmation_number":{"name":"confirmation_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The confirmation number.","undocumented":false,"html":"The confirmation number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"confirmation_number"},"payment_code":{"name":"payment_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The payment code.","undocumented":false,"html":"The payment code."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_code"}},"object_type":"ministop"},"seicomart":{"name":"seicomart","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Seicomart instruction details.","undocumented":false,"html":"Seicomart instruction details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"confirmation_number":{"name":"confirmation_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The confirmation number.","undocumented":false,"html":"The confirmation number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"confirmation_number"},"payment_code":{"name":"payment_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The payment code.","undocumented":false,"html":"The payment code."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_code"}},"object_type":"seicomart"}},"object_type":"stores"}},"object_type":"konbini_display_details"},"oxxo_display_details":{"name":"oxxo_display_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains OXXO details necessary for the customer to complete the payment.","undocumented":false,"html":"Contains OXXO details necessary for the customer to complete the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"expires_after":{"name":"expires_after","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The timestamp after which the OXXO voucher expires.","undocumented":false,"html":"The timestamp after which the OXXO voucher expires."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_after"},"hosted_voucher_url":{"name":"hosted_voucher_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.","undocumented":false,"html":"The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_voucher_url"},"number":{"name":"number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"OXXO reference number.","undocumented":false,"html":"OXXO reference number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"number"}},"object_type":"oxxo_display_details"},"paynow_display_qr_code":{"name":"paynow_display_qr_code","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The field that contains PayNow QR code info","undocumented":false,"html":"The field that contains PayNow QR code info"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"data":{"name":"data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The raw data string used to generate QR code, it should be used together with QR code library.","undocumented":false,"html":"The raw data string used to generate QR code, it should be used together with QR code library."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"data"},"hosted_instructions_url":{"name":"hosted_instructions_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.","undocumented":false,"html":"The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_instructions_url"},"image_url_png":{"name":"image_url_png","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The image_url_png string used to render QR code","undocumented":false,"html":"The image_url_png string used to render QR code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_png"},"image_url_svg":{"name":"image_url_svg","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The image_url_svg string used to render QR code","undocumented":false,"html":"The image_url_svg string used to render QR code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_svg"}},"object_type":"paynow_display_qr_code"},"pix_display_qr_code":{"name":"pix_display_qr_code","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The field that contains Pix QR code info","undocumented":false,"html":"The field that contains Pix QR code info"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"data":{"name":"data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The raw data string used to generate QR code, it should be used together with QR code library.","undocumented":false,"html":"The raw data string used to generate QR code, it should be used together with QR code library."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"data"},"expires_at":{"name":"expires_at","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The date (unix timestamp) when the PIX expires.","undocumented":false,"html":"The date (unix timestamp) when the PIX expires."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_at"},"hosted_instructions_url":{"name":"hosted_instructions_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL to the hosted pix instructions page, which allows customers to view the pix QR code.","undocumented":false,"html":"The URL to the hosted pix instructions page, which allows customers to view the pix QR code."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_instructions_url"},"image_url_png":{"name":"image_url_png","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The image_url_png string used to render png QR code","undocumented":false,"html":"The image_url_png string used to render png QR code"},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_png"},"image_url_svg":{"name":"image_url_svg","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The image_url_svg string used to render svg QR code","undocumented":false,"html":"The image_url_svg string used to render svg QR code"},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_svg"}},"object_type":"pix_display_qr_code"},"promptpay_display_qr_code":{"name":"promptpay_display_qr_code","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The field that contains PromptPay QR code info","undocumented":false,"html":"The field that contains PromptPay QR code info"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"data":{"name":"data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The raw data string used to generate QR code, it should be used together with QR code library.","undocumented":false,"html":"The raw data string used to generate QR code, it should be used together with QR code library."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"data"},"hosted_instructions_url":{"name":"hosted_instructions_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.","undocumented":false,"html":"The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_instructions_url"},"image_url_png":{"name":"image_url_png","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The PNG path used to render the QR code, can be used as the source in an HTML img tag","undocumented":false,"html":"The PNG path used to render the QR code, can be used as the source in an HTML img tag"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_png"},"image_url_svg":{"name":"image_url_svg","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The SVG path used to render the QR code, can be used as the source in an HTML img tag","undocumented":false,"html":"The SVG path used to render the QR code, can be used as the source in an HTML img tag"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_svg"}},"object_type":"promptpay_display_qr_code"},"redirect_to_url":{"name":"redirect_to_url","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains instructions for authenticating a payment by redirecting your customer to another page or application.","undocumented":false,"html":"Contains instructions for authenticating a payment by redirecting your customer to another page or application."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"return_url":{"name":"return_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.","undocumented":false,"html":"If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"return_url"},"url":{"name":"url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL you must redirect your customer to in order to authenticate the payment.","undocumented":false,"html":"The URL you must redirect your customer to in order to authenticate the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"url"}},"object_type":"redirect_to_url"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.","undocumented":false,"html":"Type of the next action to perform, one of \u003Ccode\u003Eredirect_to_url\u003C/code\u003E, \u003Ccode\u003Euse_stripe_sdk\u003C/code\u003E, \u003Ccode\u003Ealipay_handle_redirect\u003C/code\u003E, \u003Ccode\u003Eoxxo_display_details\u003C/code\u003E, or \u003Ccode\u003Everify_with_microdeposits\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"use_stripe_sdk":{"name":"use_stripe_sdk","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.","undocumented":false,"html":"When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"use_stripe_sdk"},"verify_with_microdeposits":{"name":"verify_with_microdeposits","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains details describing microdeposits verification flow.","undocumented":false,"html":"Contains details describing microdeposits verification flow."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"arrival_date":{"name":"arrival_date","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The timestamp when the microdeposits are expected to land.","undocumented":false,"html":"The timestamp when the microdeposits are expected to land."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"arrival_date"},"hosted_verification_url":{"name":"hosted_verification_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL for the hosted verification page, which allows customers to verify their bank account.","undocumented":false,"html":"The URL for the hosted verification page, which allows customers to verify their bank account."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_verification_url"},"microdeposit_type":{"name":"microdeposit_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.","undocumented":false,"html":"The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"descriptor_code":{"documentation":null},"amounts":{"documentation":null}},"object_type":"microdeposit_type"}},"object_type":"verify_with_microdeposits"},"wechat_pay_display_qr_code":{"name":"wechat_pay_display_qr_code","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The field that contains WeChat Pay QR code info","undocumented":false,"html":"The field that contains WeChat Pay QR code info"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"data":{"name":"data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The data being used to generate QR code","undocumented":false,"html":"The data being used to generate QR code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"data"},"hosted_instructions_url":{"name":"hosted_instructions_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.","undocumented":false,"html":"The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_instructions_url"},"image_data_url":{"name":"image_data_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The base64 image data for a pre-generated QR code","undocumented":false,"html":"The base64 image data for a pre-generated QR code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_data_url"},"image_url_png":{"name":"image_url_png","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The image_url_png string used to render QR code","undocumented":false,"html":"The image_url_png string used to render QR code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_png"},"image_url_svg":{"name":"image_url_svg","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The image_url_svg string used to render QR code","undocumented":false,"html":"The image_url_svg string used to render QR code"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"image_url_svg"}},"object_type":"wechat_pay_display_qr_code"},"wechat_pay_redirect_to_android_app":{"name":"wechat_pay_redirect_to_android_app","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Info required for android app to app redirect","undocumented":false,"html":"Info required for android app to app redirect"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"app_id":{"name":"app_id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"app_id is the APP ID registered on WeChat open platform","undocumented":false,"html":"app_id is the APP ID registered on WeChat open platform"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"app_id"},"nonce_str":{"name":"nonce_str","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"nonce_str is a random string","undocumented":false,"html":"nonce_str is a random string"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"nonce_str"},"package":{"name":"package","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"package is static value","undocumented":false,"html":"package is static value"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"package"},"partner_id":{"name":"partner_id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"an unique merchant ID assigned by WeChat Pay","undocumented":false,"html":"an unique merchant ID assigned by WeChat Pay"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"partner_id"},"prepay_id":{"name":"prepay_id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"an unique trading ID assigned by WeChat Pay","undocumented":false,"html":"an unique trading ID assigned by WeChat Pay"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"prepay_id"},"sign":{"name":"sign","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A signature","undocumented":false,"html":"A signature"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"sign"},"timestamp":{"name":"timestamp","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Specifies the current time in epoch format","undocumented":false,"html":"Specifies the current time in epoch format"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"timestamp"}},"object_type":"wechat_pay_redirect_to_android_app"},"wechat_pay_redirect_to_ios_app":{"name":"wechat_pay_redirect_to_ios_app","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Info required for iOS app to app redirect","undocumented":false,"html":"Info required for iOS app to app redirect"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"native_url":{"name":"native_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An universal link that redirect to WeChat Pay app","undocumented":false,"html":"An universal link that redirect to WeChat Pay app"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"native_url"}},"object_type":"wechat_pay_redirect_to_ios_app"}},"object_type":"next_action"},"on_behalf_of":{"name":"on_behalf_of","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](/docs/payments/connected-accounts) for details.","undocumented":false,"html":"The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E for details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"Connect only","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["account"],"object_type":"on_behalf_of","less_common":true},"payment_method":{"name":"payment_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the payment method used in this PaymentIntent.","undocumented":false,"html":"ID of the payment method used in this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["payment_method"],"object_type":"payment_method"},"payment_method_options":{"name":"payment_method_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payment-method-specific configuration for this PaymentIntent.","undocumented":false,"html":"Payment-method-specific configuration for this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"acss_debit":{"name":"acss_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `acss_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eacss_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"mandate_options":{"name":"mandate_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Additional fields for Mandate creation","undocumented":false,"html":"Additional fields for Mandate creation"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"custom_mandate_url":{"name":"custom_mandate_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A URL for custom mandate text","undocumented":false,"html":"A URL for custom mandate text"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"custom_mandate_url"},"interval_description":{"name":"interval_description","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.","undocumented":false,"html":"Description of the interval. Only required if the ‘payment_schedule’ parameter is ‘interval’ or ‘combined’."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval_description"},"payment_schedule":{"name":"payment_schedule","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payment schedule for the mandate.","undocumented":false,"html":"Payment schedule for the mandate."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"interval":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments are initiated at a regular pre-defined interval","undocumented":false,"html":"Payments are initiated at a regular pre-defined interval"}},"sporadic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments are initiated sporadically","undocumented":false,"html":"Payments are initiated sporadically"}},"combined":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments can be initiated at a pre-defined interval or sporadically","undocumented":false,"html":"Payments can be initiated at a pre-defined interval or sporadically"}}},"object_type":"payment_schedule"},"transaction_type":{"name":"transaction_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transaction type of the mandate.","undocumented":false,"html":"Transaction type of the mandate."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"personal":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transactions are made for personal reasons","undocumented":false,"html":"Transactions are made for personal reasons"}},"business":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transactions are made for business reasons","undocumented":false,"html":"Transactions are made for business reasons"}}},"object_type":"transaction_type"}},"object_type":"mandate_options"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"},"verification_method":{"name":"verification_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account verification method.","undocumented":false,"html":"Bank account verification method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"automatic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification with fallback to microdeposits.","undocumented":false,"html":"Instant verification with fallback to microdeposits."}},"instant":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification.","undocumented":false,"html":"Instant verification."}},"microdeposits":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Verification using microdeposits.","undocumented":false,"html":"Verification using microdeposits."}}},"object_type":"verification_method"}},"object_type":"acss_debit"},"affirm":{"name":"affirm","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `affirm`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eaffirm\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"capture_method":{"name":"capture_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Controls when the funds will be captured from the customer's account.\n","undocumented":false,"html":"Controls when the funds will be captured from the customer’s account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"manual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method."}}},"object_type":"capture_method"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"affirm"},"afterpay_clearpay":{"name":"afterpay_clearpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `afterpay_clearpay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eafterpay_clearpay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"capture_method":{"name":"capture_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Controls when the funds will be captured from the customer's account.\n","undocumented":false,"html":"Controls when the funds will be captured from the customer’s account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"manual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method."}}},"object_type":"capture_method"},"reference":{"name":"reference","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Order identifier shown to the customer 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.\n","undocumented":false,"html":"Order identifier shown to the customer 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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"reference"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"afterpay_clearpay"},"alipay":{"name":"alipay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `alipay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ealipay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"alipay"},"au_becs_debit":{"name":"au_becs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `au_becs_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eau_becs_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"au_becs_debit"},"bacs_debit":{"name":"bacs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `bacs_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ebacs_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"bacs_debit"},"bancontact":{"name":"bancontact","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `bancontact`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ebancontact\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"preferred_language":{"name":"preferred_language","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Preferred language of the Bancontact authorization page that the customer is redirected to.","undocumented":false,"html":"Preferred language of the Bancontact authorization page that the customer is redirected to."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred_language"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"bancontact"},"blik":{"name":"blik","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `blik`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eblik\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"blik"},"boleto":{"name":"boleto","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `boleto`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eboleto\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"expires_after_days":{"name":"expires_after_days","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_after_days"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"boleto"},"card":{"name":"card","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `card`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecard\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"capture_method":{"name":"capture_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Controls when the funds will be captured from the customer's account.\n","undocumented":false,"html":"Controls when the funds will be captured from the customer’s account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"manual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method."}}},"object_type":"capture_method"},"installments":{"name":"installments","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](/docs/payments/installments).\n","undocumented":false,"html":"Installment details for this payment (Mexico only).\u003C/p\u003E\n\n\u003Cp\u003EFor more information, see the \u003Ca href=\"/docs/payments/installments\"\u003Einstallments integration guide\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available_plans":{"name":"available_plans","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Installment plans that may be selected for this PaymentIntent.","undocumented":false,"html":"Installment plans that may be selected for this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"count":{"name":"count","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.","undocumented":false,"html":"For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the number of installment payments your customer will make to their credit card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"count"},"interval":{"name":"interval","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.\n","undocumented":false,"html":"For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of \u003Ccode\u003Emonth\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Type of installment plan, one of `fixed_count`.","undocumented":false,"html":"Type of installment plan, one of \u003Ccode\u003Efixed_count\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"}},"object_type":"available_plans"},"enabled":{"name":"enabled","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether Installments are enabled for this PaymentIntent.","undocumented":false,"html":"Whether Installments are enabled for this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"enabled"},"plan":{"name":"plan","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Installment plan selected for this PaymentIntent.","undocumented":false,"html":"Installment plan selected for this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"count":{"name":"count","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.","undocumented":false,"html":"For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the number of installment payments your customer will make to their credit card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"count"},"interval":{"name":"interval","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.\n","undocumented":false,"html":"For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of \u003Ccode\u003Emonth\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Type of installment plan, one of `fixed_count`.","undocumented":false,"html":"Type of installment plan, one of \u003Ccode\u003Efixed_count\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"}},"object_type":"plan"}},"object_type":"installments"},"mandate_options":{"name":"mandate_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Configuration options for setting up an eMandate for cards issued in India.","undocumented":false,"html":"Configuration options for setting up an eMandate for cards issued in India."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount":{"name":"amount","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Amount to be charged for future payments.","undocumented":false,"html":"Amount to be charged for future payments."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount"},"amount_type":{"name":"amount_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.\n","undocumented":false,"html":"One of \u003Ccode\u003Efixed\u003C/code\u003E or \u003Ccode\u003Emaximum\u003C/code\u003E. If \u003Ccode\u003Efixed\u003C/code\u003E, the \u003Ccode\u003Eamount\u003C/code\u003E param refers to the exact amount to be charged in future payments. If \u003Ccode\u003Emaximum\u003C/code\u003E, the amount charged can be up to the value passed for the \u003Ccode\u003Eamount\u003C/code\u003E param."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_type"},"description":{"name":"description","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A description of the mandate or subscription that is meant to be displayed to the customer.","undocumented":false,"html":"A description of the mandate or subscription that is meant to be displayed to the customer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"description"},"end_date":{"name":"end_date","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.\n","undocumented":false,"html":"End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"end_date"},"interval":{"name":"interval","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.\n","undocumented":false,"html":"Specifies payment frequency. One of \u003Ccode\u003Eday\u003C/code\u003E, \u003Ccode\u003Eweek\u003C/code\u003E, \u003Ccode\u003Emonth\u003C/code\u003E, \u003Ccode\u003Eyear\u003C/code\u003E, or \u003Ccode\u003Esporadic\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval"},"interval_count":{"name":"interval_count","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.\n","undocumented":false,"html":"The number of intervals between payments. For example, \u003Ccode\u003Einterval=month\u003C/code\u003E and \u003Ccode\u003Einterval_count=3\u003C/code\u003E indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when \u003Ccode\u003Einterval=sporadic\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval_count"},"reference":{"name":"reference","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Unique identifier for the mandate or subscription.","undocumented":false,"html":"Unique identifier for the mandate or subscription."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"reference"},"start_date":{"name":"start_date","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Start date of the mandate or subscription. Start date should not be lesser than yesterday.\n","undocumented":false,"html":"Start date of the mandate or subscription. Start date should not be lesser than yesterday."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"start_date"},"supported_types":{"name":"supported_types","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Specifies the type of mandates supported. Possible values are `india`.\n","undocumented":false,"html":"Specifies the type of mandates supported. Possible values are \u003Ccode\u003Eindia\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported_types"}},"object_type":"mandate_options"},"network":{"name":"network","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"network"},"request_three_d_secure":{"name":"request_three_d_secure","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](/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](/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","undocumented":false,"html":"We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and \u003Ca href=\"/docs/strong-customer-authentication\"\u003Eother requirements\u003C/a\u003E. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: \u003Ccode\u003Eautomatic\u003C/code\u003E or \u003Ccode\u003Eany\u003C/code\u003E. If not provided, defaults to \u003Ccode\u003Eautomatic\u003C/code\u003E. Read our guide on \u003Ca href=\"/docs/payments/3d-secure#manual-three-ds\"\u003Emanually requesting 3D Secure\u003C/a\u003E for more information on how this configuration interacts with Radar and our SCA Engine."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"advanced","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"request_three_d_secure"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"},"statement_descriptor_suffix_kana":{"name":"statement_descriptor_suffix_kana","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.","undocumented":false,"html":"Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the \u003Cem\u003Econcatenation\u003C/em\u003E of both prefix and suffix (including separators) will appear truncated to 22 characters."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"statement_descriptor_suffix_kana"},"statement_descriptor_suffix_kanji":{"name":"statement_descriptor_suffix_kanji","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.","undocumented":false,"html":"Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the \u003Cem\u003Econcatenation\u003C/em\u003E of both prefix and suffix (including separators) will appear truncated to 17 characters."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"statement_descriptor_suffix_kanji"}},"object_type":"card"},"card_present":{"name":"card_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `card_present`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecard_present\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"capture_method":{"name":"capture_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Controls when the funds will be captured from the customer's account.\n","undocumented":false,"html":"Controls when the funds will be captured from the customer’s account."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"manual_preferred":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `manual_preferred` if you prefer `manual` capture_method but support falling back to `automatic` based on the presented payment method.","undocumented":false,"html":"Use \u003Ccode\u003Emanual_preferred\u003C/code\u003E if you prefer \u003Ccode\u003Emanual\u003C/code\u003E capture_method but support falling back to \u003Ccode\u003Eautomatic\u003C/code\u003E based on the presented payment method."}}},"object_type":"capture_method"},"request_extended_authorization":{"name":"request_extended_authorization","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Request ability to capture this payment beyond the standard [authorization validity window](/docs/terminal/features/extended-authorizations#authorization-validity)","undocumented":false,"html":"Request ability to capture this payment beyond the standard \u003Ca href=\"/docs/terminal/features/extended-authorizations#authorization-validity\"\u003Eauthorization validity window\u003C/a\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"request_extended_authorization"},"request_incremental_authorization_support":{"name":"request_incremental_authorization_support","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Request ability to [increment](/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](/docs/api/payment_intents/confirm) response to verify support.","undocumented":false,"html":"Request ability to \u003Ca href=\"/docs/terminal/features/incremental-authorizations\"\u003Eincrement\u003C/a\u003E this PaymentIntent if the combination of MCC and card brand is eligible. Check \u003Ca href=\"/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported\"\u003Eincremental_authorization_supported\u003C/a\u003E in the \u003Ca href=\"/docs/api/payment_intents/confirm\"\u003EConfirm\u003C/a\u003E response to verify support."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"request_incremental_authorization_support"},"routing":{"name":"routing","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.","undocumented":false,"html":"Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"requested_priority":{"name":"requested_priority","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Requested routing priority","undocumented":false,"html":"Requested routing priority"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"domestic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Prioritize domestic debit network routing on payment method collection","undocumented":false,"html":"Prioritize domestic debit network routing on payment method collection"}},"international":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Prioritize international network routing on payment method collection","undocumented":false,"html":"Prioritize international network routing on payment method collection"}}},"object_type":"requested_priority"}},"object_type":"routing"}},"object_type":"card_present"},"customer_balance":{"name":"customer_balance","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `customer_balance`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecustomer_balance\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_transfer":{"name":"bank_transfer","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.\n","undocumented":false,"html":"Configuration for the bank transfer funding type, if the \u003Ccode\u003Efunding_type\u003C/code\u003E is set to \u003Ccode\u003Ebank_transfer\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"eu_bank_transfer":{"name":"eu_bank_transfer","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Configuration for eu_bank_transfer","undocumented":false,"html":"Configuration for eu_bank_transfer"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.\n","undocumented":false,"html":"The desired country code of the bank account information. Permitted values include: \u003Ccode\u003EBE\u003C/code\u003E, \u003Ccode\u003EDE\u003C/code\u003E, \u003Ccode\u003EES\u003C/code\u003E, \u003Ccode\u003EFR\u003C/code\u003E, \u003Ccode\u003EIE\u003C/code\u003E, or \u003Ccode\u003ENL\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"}},"object_type":"eu_bank_transfer"},"requested_address_types":{"name":"requested_address_types","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.\n","undocumented":false,"html":"List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\u003C/p\u003E\n\n\u003Cp\u003EPermitted values include: \u003Ccode\u003Esort_code\u003C/code\u003E, \u003Ccode\u003Ezengin\u003C/code\u003E, \u003Ccode\u003Eiban\u003C/code\u003E, or \u003Ccode\u003Espei\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"sort_code":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"sort_code bank account address type","undocumented":false,"html":"sort_code bank account address type"}},"zengin":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"zengin bank account address type","undocumented":false,"html":"zengin bank account address type"}},"sepa":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"sepa bank account address type","undocumented":false,"html":"sepa bank account address type"}},"spei":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"spei bank account address type","undocumented":false,"html":"spei bank account address type"}},"iban":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"iban bank account address type","undocumented":false,"html":"iban bank account address type"}}},"object_type":"requested_address_types"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.\n","undocumented":false,"html":"The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: \u003Ccode\u003Eeu_bank_transfer\u003C/code\u003E, \u003Ccode\u003Egb_bank_transfer\u003C/code\u003E, \u003Ccode\u003Ejp_bank_transfer\u003C/code\u003E, or \u003Ccode\u003Emx_bank_transfer\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"eu_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type eu_bank_transfer","undocumented":false,"html":"A bank transfer of type eu_bank_transfer"}},"gb_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type gb_bank_transfer","undocumented":false,"html":"A bank transfer of type gb_bank_transfer"}},"jp_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type jp_bank_transfer","undocumented":false,"html":"A bank transfer of type jp_bank_transfer"}},"mx_bank_transfer":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A bank transfer of type mx_bank_transfer","undocumented":false,"html":"A bank transfer of type mx_bank_transfer"}}},"object_type":"type"}},"object_type":"bank_transfer"},"funding_type":{"name":"funding_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.\n","undocumented":false,"html":"The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: \u003Ccode\u003Ebank_transfer\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding_type"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"customer_balance"},"eps":{"name":"eps","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `eps`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eeps\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"eps"},"fpx":{"name":"fpx","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `fpx`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Efpx\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"fpx"},"giropay":{"name":"giropay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `giropay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Egiropay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"giropay"},"grabpay":{"name":"grabpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `grabpay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Egrabpay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"grabpay"},"ideal":{"name":"ideal","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `ideal`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eideal\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"ideal"},"interac_present":{"name":"interac_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `interac_present`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Einterac_present\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"interac_present"},"klarna":{"name":"klarna","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `klarna`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eklarna\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"capture_method":{"name":"capture_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Controls when the funds will be captured from the customer's account.\n","undocumented":false,"html":"Controls when the funds will be captured from the customer’s account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"manual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method."}}},"object_type":"capture_method"},"preferred_locale":{"name":"preferred_locale","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Preferred locale of the Klarna checkout page that the customer is redirected to.","undocumented":false,"html":"Preferred locale of the Klarna checkout page that the customer is redirected to."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred_locale"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"klarna"},"konbini":{"name":"konbini","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `konbini`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ekonbini\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"confirmation_number":{"name":"confirmation_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.","undocumented":false,"html":"An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"confirmation_number"},"expires_after_days":{"name":"expires_after_days","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.","undocumented":false,"html":"The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and \u003Ccode\u003Eexpires_after_days\u003C/code\u003E set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_after_days"},"expires_at":{"name":"expires_at","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.","undocumented":false,"html":"The timestamp at which the Konbini payment instructions will expire. Only one of \u003Ccode\u003Eexpires_after_days\u003C/code\u003E or \u003Ccode\u003Eexpires_at\u003C/code\u003E may be set."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_at"},"product_description":{"name":"product_description","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A product descriptor of up to 22 characters, which will appear to customers at the convenience store.","undocumented":false,"html":"A product descriptor of up to 22 characters, which will appear to customers at the convenience store."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"product_description"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"konbini"},"link":{"name":"link","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `link`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Elink\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"capture_method":{"name":"capture_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Controls when the funds will be captured from the customer's account.\n","undocumented":false,"html":"Controls when the funds will be captured from the customer’s account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"manual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method."}}},"object_type":"capture_method"},"persistent_token":{"name":"persistent_token","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Token used for persistent Link logins.","undocumented":false,"html":"Token used for persistent Link logins."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"persistent_token"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"link"},"oxxo":{"name":"oxxo","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `oxxo`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eoxxo\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"expires_after_days":{"name":"expires_after_days","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_after_days"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"oxxo"},"p24":{"name":"p24","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `p24`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ep24\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"p24"},"paynow":{"name":"paynow","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `paynow`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Epaynow\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"paynow"},"pix":{"name":"pix","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `pix`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Epix\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"expires_after_seconds":{"name":"expires_after_seconds","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The number of seconds (between 10 and 1209600) after which Pix payment will expire.","undocumented":false,"html":"The number of seconds (between 10 and 1209600) after which Pix payment will expire."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_after_seconds"},"expires_at":{"name":"expires_at","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The timestamp at which the Pix expires.","undocumented":false,"html":"The timestamp at which the Pix expires."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_at"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"pix"},"promptpay":{"name":"promptpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `promptpay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Epromptpay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"promptpay"},"sepa_debit":{"name":"sepa_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `sepa_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Esepa_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"mandate_options":{"name":"mandate_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Additional fields for Mandate creation","undocumented":false,"html":"Additional fields for Mandate creation"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"mandate_options"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"sepa_debit"},"sofort":{"name":"sofort","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `sofort`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Esofort\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"preferred_language":{"name":"preferred_language","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Preferred language of the SOFORT authorization page that the customer is redirected to.","undocumented":false,"html":"Preferred language of the SOFORT authorization page that the customer is redirected to."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred_language"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"sofort"},"us_bank_account":{"name":"us_bank_account","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `us_bank_account`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eus_bank_account\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"financial_connections":{"name":"financial_connections","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Additional fields for Financial Connections Session creation","undocumented":false,"html":"Additional fields for Financial Connections Session creation"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"permissions":{"name":"permissions","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The list of permissions to request. The `payment_method` permission must be included.","undocumented":false,"html":"The list of permissions to request. The \u003Ccode\u003Epayment_method\u003C/code\u003E permission must be included."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"payment_method":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows the creation of a payment method from the account.","undocumented":false,"html":"Allows the creation of a payment method from the account."}},"balances":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows accessing balance data from the account.","undocumented":false,"html":"Allows accessing balance data from the account."}},"transactions":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows accessing transactions data from the account.","undocumented":false,"html":"Allows accessing transactions data from the account."}},"ownership":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows accessing ownership data from the account.","undocumented":false,"html":"Allows accessing ownership data from the account."}}},"object_type":"permissions"}},"object_type":"financial_connections"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}},"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"},"verification_method":{"name":"verification_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account verification method.","undocumented":false,"html":"Bank account verification method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"automatic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification with fallback to microdeposits.","undocumented":false,"html":"Instant verification with fallback to microdeposits."}},"instant":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification only.","undocumented":false,"html":"Instant verification only."}},"microdeposits":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices.","undocumented":false,"html":"Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices."}}},"object_type":"verification_method"}},"object_type":"us_bank_account"},"wechat_pay":{"name":"wechat_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `wechat_pay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ewechat_pay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"app_id":{"name":"app_id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The app ID registered with WeChat Pay. Only required when client is ios or android.","undocumented":false,"html":"The app ID registered with WeChat Pay. Only required when client is ios or android."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"app_id"},"client":{"name":"client","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The client type that the end customer will pay from","undocumented":false,"html":"The client type that the end customer will pay from"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"web":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The end customer will pay from web browser","undocumented":false,"html":"The end customer will pay from web browser"}},"ios":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The end customer will pay from an iOS app","undocumented":false,"html":"The end customer will pay from an iOS app"}},"android":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The end customer will pay from an Android app","undocumented":false,"html":"The end customer will pay from an Android app"}}},"object_type":"client"},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"none":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","undocumented":false,"html":"Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method."}}},"object_type":"setup_future_usage"}},"object_type":"wechat_pay"}},"object_type":"payment_method_options","less_common":true},"payment_method_types":{"name":"payment_method_types","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.","undocumented":false,"html":"The list of payment method types (e.g. card) that this PaymentIntent is allowed to use."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_method_types","less_common":true},"processing":{"name":"processing","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If present, this property tells you about the processing state of the payment.","undocumented":false,"html":"If present, this property tells you about the processing state of the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"card":{"name":"card","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the PaymentIntent's payment_method_types includes `card`, this hash contains the details on the `processing` state of the payment.\n","undocumented":false,"html":"If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecard\u003C/code\u003E, this hash contains the details on the \u003Ccode\u003Eprocessing\u003C/code\u003E state of the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"customer_notification":{"name":"customer_notification","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For recurring payments of Indian cards, this hash contains details on whether customer approval is required, and until when the payment will be in `processing` state","undocumented":false,"html":"For recurring payments of Indian cards, this hash contains details on whether customer approval is required, and until when the payment will be in \u003Ccode\u003Eprocessing\u003C/code\u003E state"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"approval_requested":{"name":"approval_requested","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.","undocumented":false,"html":"Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"approval_requested"},"completes_at":{"name":"completes_at","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If customer approval is required, they need to provide approval before this time.","undocumented":false,"html":"If customer approval is required, they need to provide approval before this time."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"completes_at"}},"object_type":"customer_notification"}},"object_type":"card"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Type of the payment method for which payment is in `processing` state, one of `card`.","undocumented":false,"html":"Type of the payment method for which payment is in \u003Ccode\u003Eprocessing\u003C/code\u003E state, one of \u003Ccode\u003Ecard\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"}},"object_type":"processing","less_common":true},"receipt_email":{"name":"receipt_email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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).","undocumented":false,"html":"Email address that the receipt for the resulting payment will be sent to. If \u003Ccode\u003Ereceipt_email\u003C/code\u003E is specified for a payment in live mode, a receipt will be sent regardless of your \u003Ca href=\"https://dashboard.stripe.com/account/emails\"\u003Eemail settings\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"receipt_email"},"review":{"name":"review","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the review associated with this PaymentIntent, if any.","undocumented":false,"html":"ID of the review associated with this PaymentIntent, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["review"],"object_type":"review","less_common":true},"setup_future_usage":{"name":"setup_future_usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n","undocumented":false,"html":"Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Use `off_session` if your customer may or may not be present in your checkout flow.","undocumented":false,"html":"Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow."}}},"object_type":"setup_future_usage"},"shipping":{"name":"shipping","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Shipping information for this PaymentIntent.","undocumented":false,"html":"Shipping information for this PaymentIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"address":{"name":"address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Shipping address.","undocumented":false,"html":"Shipping address."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"address"},"carrier":{"name":"carrier","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.","undocumented":false,"html":"The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"carrier"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Recipient name.","undocumented":false,"html":"Recipient name."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"phone":{"name":"phone","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Recipient phone (including extension).","undocumented":false,"html":"Recipient phone (including extension)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"phone"},"tracking_number":{"name":"tracking_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"tracking_number"}},"object_type":"shipping"},"statement_descriptor":{"name":"statement_descriptor","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"statement_descriptor"},"statement_descriptor_suffix":{"name":"statement_descriptor_suffix","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"statement_descriptor_suffix"},"status":{"name":"status","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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](/docs/payments/intents#intent-statuses).","undocumented":false,"html":"Status of this PaymentIntent, one of \u003Ccode\u003Erequires_payment_method\u003C/code\u003E, \u003Ccode\u003Erequires_confirmation\u003C/code\u003E, \u003Ccode\u003Erequires_action\u003C/code\u003E, \u003Ccode\u003Eprocessing\u003C/code\u003E, \u003Ccode\u003Erequires_capture\u003C/code\u003E, \u003Ccode\u003Ecanceled\u003C/code\u003E, or \u003Ccode\u003Esucceeded\u003C/code\u003E. Read more about each PaymentIntent \u003Ca href=\"/docs/payments/intents#intent-statuses\"\u003Estatus\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"status"},"transfer_data":{"name":"transfer_data","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](/docs/payments/connected-accounts) for details.","undocumented":false,"html":"The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E for details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"Connect only","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount":{"name":"amount","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](/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](/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).","undocumented":false,"html":"Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the \u003Ca href=\"/docs/currencies#zero-decimal\"\u003Esmallest currency unit\u003C/a\u003E (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 \u003Ca href=\"/docs/currencies#minimum-and-maximum-charge-amounts\"\u003Eequivalent in charge currency\u003C/a\u003E. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount"},"destination":{"name":"destination","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.\n","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["account"],"object_type":"destination"}},"object_type":"transfer_data","less_common":true},"transfer_group":{"name":"transfer_group","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](/docs/payments/connected-accounts) for details.","undocumented":false,"html":"A string that identifies the resulting payment as part of a group. See the PaymentIntents \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E for details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"Connect only","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"transfer_group","less_common":true}}},"payment_method":{"name":"payment_method","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The PaymentMethod object for errors returned on a request involving a PaymentMethod.","undocumented":false,"html":"The PaymentMethod object for errors returned on a request involving a PaymentMethod."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"id":{"name":"id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Unique identifier for the object.","undocumented":false,"html":"Unique identifier for the object."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"id"},"object":{"name":"object","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"String representing the object's type. Objects of the same type share the same value.","undocumented":false,"html":"String representing the object’s type. Objects of the same type share the same value."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"object","less_common":true},"acss_debit":{"name":"acss_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eacss_debit\u003C/code\u003E PaymentMethod, this hash contains details about the ACSS Debit payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Name of the bank associated with the bank account.","undocumented":false,"html":"Name of the bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"institution_number":{"name":"institution_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Institution number of the bank account.","undocumented":false,"html":"Institution number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"institution_number"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"transit_number":{"name":"transit_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transit number of the bank account.","undocumented":false,"html":"Transit number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"transit_number"}},"object_type":"acss_debit","less_common":true},"affirm":{"name":"affirm","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eaffirm\u003C/code\u003E PaymentMethod, this hash contains details about the Affirm payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"affirm","less_common":true},"afterpay_clearpay":{"name":"afterpay_clearpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003EAfterpayClearpay\u003C/code\u003E PaymentMethod, this hash contains details about the AfterpayClearpay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"afterpay_clearpay","less_common":true},"alipay":{"name":"alipay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003EAlipay\u003C/code\u003E PaymentMethod, this hash contains details about the Alipay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"alipay","less_common":true},"au_becs_debit":{"name":"au_becs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.","undocumented":false,"html":"If this is an \u003Ccode\u003Eau_becs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bsb_number":{"name":"bsb_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Six-digit number identifying bank and branch associated with this bank account.","undocumented":false,"html":"Six-digit number identifying bank and branch associated with this bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bsb_number"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"}},"object_type":"au_becs_debit","less_common":true},"bacs_debit":{"name":"bacs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.","undocumented":false,"html":"If this is a \u003Ccode\u003Ebacs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the Bacs Direct Debit bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"sort_code":{"name":"sort_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Sort code of the bank account. (e.g., `10-20-30`)","undocumented":false,"html":"Sort code of the bank account. (e.g., \u003Ccode\u003E10-20-30\u003C/code\u003E)"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"sort_code"}},"object_type":"bacs_debit","less_common":true},"bancontact":{"name":"bancontact","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ebancontact\u003C/code\u003E PaymentMethod, this hash contains details about the Bancontact payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"bancontact","less_common":true},"billing_details":{"name":"billing_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","undocumented":false,"html":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"address":{"name":"address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing address.","undocumented":false,"html":"Billing address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Email address.","undocumented":false,"html":"Email address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Full name.","undocumented":false,"html":"Full name."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"phone":{"name":"phone","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing phone number (including extension).","undocumented":false,"html":"Billing phone number (including extension)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"phone"}},"object_type":"billing_details"},"blik":{"name":"blik","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eblik\u003C/code\u003E PaymentMethod, this hash contains details about the BLIK payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"blik","less_common":true},"boleto":{"name":"boleto","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eboleto\u003C/code\u003E PaymentMethod, this hash contains details about the Boleto payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":null,"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"tax_id":{"name":"tax_id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies the customer tax id (CNPJ or CPF)","undocumented":false,"html":"Uniquely identifies the customer tax id (CNPJ or CPF)"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"tax_id"}},"object_type":"boleto","less_common":true},"card":{"name":"card","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `card` PaymentMethod, this hash contains the user's card details.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecard\u003C/code\u003E PaymentMethod, this hash contains the user’s card details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"checks":{"name":"checks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Checks on Card address and CVC if provided.","undocumented":false,"html":"Checks on Card address and CVC if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"address_line1_check":{"name":"address_line1_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a address line1 was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"address_line1_check"},"address_postal_code_check":{"name":"address_postal_code_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a address postal code was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"address_postal_code_check"},"cvc_check":{"name":"cvc_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a CVC was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cvc_check"}},"object_type":"checks"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":"card_fingerprint_read","hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"generated_from":{"name":"generated_from","check":"hash","validation":"hash","documentation":{"gate_specific":{"sdk_client_public":{"gate_specific":{},"localize_terms":[],"undocumented":true,"html":null}},"localize_terms":[],"markdown":"Details of the original PaymentMethod that created this object.","undocumented":false,"html":"Details of the original PaymentMethod that created this object."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The charge that created this object.","undocumented":false,"html":"The charge that created this object."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"charge"},"payment_method_details":{"name":"payment_method_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transaction-specific details of the payment method used in the payment.","undocumented":false,"html":"Transaction-specific details of the payment method used in the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"card_present":{"name":"card_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"This hash contains the snapshot of the `card_present` transaction-specific details which generated this `card` payment method.","undocumented":false,"html":"This hash contains the snapshot of the \u003Ccode\u003Ecard_present\u003C/code\u003E transaction-specific details which generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount_authorized":{"name":"amount_authorized","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The authorized amount","undocumented":false,"html":"The authorized amount"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_authorized"},"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"capture_before":{"name":"capture_before","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.","undocumented":false,"html":"When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"capture_before"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"emv_auth_data":{"name":"emv_auth_data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Authorization response cryptogram.","undocumented":false,"html":"Authorization response cryptogram."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"emv_auth_data"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"generated_card":{"name":"generated_card","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"generated_card"},"incremental_authorization_supported":{"name":"incremental_authorization_supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether this [PaymentIntent](/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).","undocumented":false,"html":"Whether this \u003Ca href=\"/docs/api/payment_intents\"\u003EPaymentIntent\u003C/a\u003E is eligible for incremental authorizations. Request support using \u003Ca href=\"/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support\"\u003Erequest_incremental_authorization_support\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"incremental_authorization_supported"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"network":{"name":"network","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Identifies which network this charge was processed on. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ecartes_bancaires\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"network"},"overcapture_supported":{"name":"overcapture_supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Defines whether the authorized amount can be over-captured or not","undocumented":false,"html":"Defines whether the authorized amount can be over-captured or not"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"overcapture_supported"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"},"receipt":{"name":"receipt","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A collection of fields required to be displayed on receipts. Only required for EMV transactions.","undocumented":false,"html":"A collection of fields required to be displayed on receipts. Only required for EMV transactions."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_type":{"name":"account_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of account being debited or credited","undocumented":false,"html":"The type of account being debited or credited"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"credit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A credit account, as when using a credit card","undocumented":false,"html":"A credit account, as when using a credit card"}},"checking":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A checking account, as when using a debit card","undocumented":false,"html":"A checking account, as when using a debit card"}},"prepaid":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A prepaid account, as when using a debit gift card","undocumented":false,"html":"A prepaid account, as when using a debit gift card"}},"unknown":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An unknown account","undocumented":false,"html":"An unknown account"}}},"object_type":"account_type"},"application_cryptogram":{"name":"application_cryptogram","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 9F26, cryptogram generated by the integrated circuit chip.","undocumented":false,"html":"EMV tag 9F26, cryptogram generated by the integrated circuit chip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"application_cryptogram"},"application_preferred_name":{"name":"application_preferred_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Mnenomic of the Application Identifier.","undocumented":false,"html":"Mnenomic of the Application Identifier."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"application_preferred_name"},"authorization_code":{"name":"authorization_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Identifier for this transaction.","undocumented":false,"html":"Identifier for this transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"authorization_code"},"authorization_response_code":{"name":"authorization_response_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 8A. A code returned by the card issuer.","undocumented":false,"html":"EMV tag 8A. A code returned by the card issuer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"authorization_response_code"},"cardholder_verification_method":{"name":"cardholder_verification_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How the cardholder verified ownership of the card.","undocumented":false,"html":"How the cardholder verified ownership of the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_verification_method"},"dedicated_file_name":{"name":"dedicated_file_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.","undocumented":false,"html":"EMV tag 84. Similar to the application identifier stored on the integrated circuit chip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"dedicated_file_name"},"terminal_verification_results":{"name":"terminal_verification_results","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The outcome of a series of EMV functions performed by the card reader.","undocumented":false,"html":"The outcome of a series of EMV functions performed by the card reader."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"terminal_verification_results"},"transaction_status_information":{"name":"transaction_status_information","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An indication of various EMV functions performed during the transaction.","undocumented":false,"html":"An indication of various EMV functions performed during the transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"transaction_status_information"}},"object_type":"receipt"}},"object_type":"card_present"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.","undocumented":false,"html":"The type of payment method transaction-specific details from the transaction that generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method. Always \u003Ccode\u003Ecard_present\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"}},"object_type":"payment_method_details"},"setup_attempt":{"name":"setup_attempt","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the SetupAttempt that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the SetupAttempt that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["setup_attempt"],"object_type":"setup_attempt"}},"object_type":"generated_from"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"three_d_secure_usage":{"name":"three_d_secure_usage","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains details on how this Card may be used for 3D Secure authentication.","undocumented":false,"html":"Contains details on how this Card may be used for 3D Secure authentication."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"supported":{"name":"supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether 3D Secure is supported on this card.","undocumented":false,"html":"Whether 3D Secure is supported on this card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported"}},"object_type":"three_d_secure_usage"},"wallet":{"name":"wallet","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this Card is part of a card wallet, this contains the details of the card wallet.","undocumented":false,"html":"If this Card is part of a card wallet, this contains the details of the card wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amex_express_checkout":{"name":"amex_express_checkout","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `amex_express_checkout` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"amex_express_checkout"},"apple_pay":{"name":"apple_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `apple_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Eapple_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"apple_pay"},"dynamic_last4":{"name":"dynamic_last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"(For tokenized numbers only.) The last four digits of the device account number.","undocumented":false,"html":"(For tokenized numbers only.) The last four digits of the device account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"dynamic_last4"},"google_pay":{"name":"google_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `google_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Egoogle_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"google_pay"},"masterpass":{"name":"masterpass","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `masterpass` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Emasterpass\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"billing_address":{"name":"billing_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"billing_address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"shipping_address":{"name":"shipping_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"shipping_address"}},"object_type":"masterpass"},"samsung_pay":{"name":"samsung_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `samsung_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Esamsung_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"samsung_pay"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"The type of the card wallet, one of \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E, \u003Ccode\u003Eapple_pay\u003C/code\u003E, \u003Ccode\u003Egoogle_pay\u003C/code\u003E, \u003Ccode\u003Emasterpass\u003C/code\u003E, \u003Ccode\u003Esamsung_pay\u003C/code\u003E, or \u003Ccode\u003Evisa_checkout\u003C/code\u003E. 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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"visa_checkout":{"name":"visa_checkout","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `visa_checkout` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Evisa_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"billing_address":{"name":"billing_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"billing_address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"shipping_address":{"name":"shipping_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"shipping_address"}},"object_type":"visa_checkout"}},"object_type":"wallet"}},"object_type":"card","less_common":true},"card_present":{"name":"card_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `card_present` PaymentMethod, this hash contains details about the Card Present payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecard_present\u003C/code\u003E PaymentMethod, this hash contains details about the Card Present payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"}},"object_type":"card_present","less_common":true},"created":{"name":"created","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Time at which the object was created. Measured in seconds since the Unix epoch.","undocumented":false,"html":"Time at which the object was created. Measured in seconds since the Unix epoch."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"created","less_common":true},"customer":{"name":"customer","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["customer"],"object_type":"customer"},"customer_balance":{"name":"customer_balance","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecustomer_balance\u003C/code\u003E PaymentMethod, this hash contains details about the CustomerBalance payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"customer_balance","less_common":true},"eps":{"name":"eps","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eeps\u003C/code\u003E PaymentMethod, this hash contains details about the EPS payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`, `deutsche_bank_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`.","undocumented":false,"html":"The customer’s bank. Should be one of \u003Ccode\u003Earzte_und_apotheker_bank\u003C/code\u003E, \u003Ccode\u003Eaustrian_anadi_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebank_austria\u003C/code\u003E, \u003Ccode\u003Ebankhaus_carl_spangler\u003C/code\u003E, \u003Ccode\u003Ebankhaus_schelhammer_und_schattera_ag\u003C/code\u003E, \u003Ccode\u003Ebawag_psk_ag\u003C/code\u003E, \u003Ccode\u003Ebks_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebrull_kallmus_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebtv_vier_lander_bank\u003C/code\u003E, \u003Ccode\u003Ecapital_bank_grawe_gruppe_ag\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank_ag\u003C/code\u003E, \u003Ccode\u003Edolomitenbank\u003C/code\u003E, \u003Ccode\u003Eeasybank_ag\u003C/code\u003E, \u003Ccode\u003Eerste_bank_und_sparkassen\u003C/code\u003E, \u003Ccode\u003Ehypo_alpeadriabank_international_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_noe_lb_fur_niederosterreich_u_wien\u003C/code\u003E, \u003Ccode\u003Ehypo_oberosterreich_salzburg_steiermark\u003C/code\u003E, \u003Ccode\u003Ehypo_tirol_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_vorarlberg_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_bank_burgenland_aktiengesellschaft\u003C/code\u003E, \u003Ccode\u003Emarchfelder_bank\u003C/code\u003E, \u003Ccode\u003Eoberbank_ag\u003C/code\u003E, \u003Ccode\u003Eraiffeisen_bankengruppe_osterreich\u003C/code\u003E, \u003Ccode\u003Eschoellerbank_ag\u003C/code\u003E, \u003Ccode\u003Esparda_bank_wien\u003C/code\u003E, \u003Ccode\u003Evolksbank_gruppe\u003C/code\u003E, \u003Ccode\u003Evolkskreditbank_ag\u003C/code\u003E, or \u003Ccode\u003Evr_bank_braunau\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"}},"object_type":"eps","less_common":true},"fpx":{"name":"fpx","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Efpx\u003C/code\u003E PaymentMethod, this hash contains details about the FPX payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `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`, `pb_enterprise`, or `bank_of_china`.","undocumented":false,"html":"The customer’s bank, if provided. Can be one of \u003Ccode\u003Eaffin_bank\u003C/code\u003E, \u003Ccode\u003Eagrobank\u003C/code\u003E, \u003Ccode\u003Ealliance_bank\u003C/code\u003E, \u003Ccode\u003Eambank\u003C/code\u003E, \u003Ccode\u003Ebank_islam\u003C/code\u003E, \u003Ccode\u003Ebank_muamalat\u003C/code\u003E, \u003Ccode\u003Ebank_rakyat\u003C/code\u003E, \u003Ccode\u003Ebsn\u003C/code\u003E, \u003Ccode\u003Ecimb\u003C/code\u003E, \u003Ccode\u003Ehong_leong_bank\u003C/code\u003E, \u003Ccode\u003Ehsbc\u003C/code\u003E, \u003Ccode\u003Ekfh\u003C/code\u003E, \u003Ccode\u003Emaybank2u\u003C/code\u003E, \u003Ccode\u003Eocbc\u003C/code\u003E, \u003Ccode\u003Epublic_bank\u003C/code\u003E, \u003Ccode\u003Erhb\u003C/code\u003E, \u003Ccode\u003Estandard_chartered\u003C/code\u003E, \u003Ccode\u003Euob\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank\u003C/code\u003E, \u003Ccode\u003Emaybank2e\u003C/code\u003E, \u003Ccode\u003Epb_enterprise\u003C/code\u003E, or \u003Ccode\u003Ebank_of_china\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"}},"object_type":"fpx","less_common":true},"giropay":{"name":"giropay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Egiropay\u003C/code\u003E PaymentMethod, this hash contains details about the Giropay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"giropay","less_common":true},"grabpay":{"name":"grabpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Egrabpay\u003C/code\u003E PaymentMethod, this hash contains details about the GrabPay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"grabpay","less_common":true},"ideal":{"name":"ideal","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eideal\u003C/code\u003E PaymentMethod, this hash contains details about the iDEAL payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`, `van_lanschot`, or `yoursafe`.","undocumented":false,"html":"The customer’s bank, if provided. Can be one of \u003Ccode\u003Eabn_amro\u003C/code\u003E, \u003Ccode\u003Easn_bank\u003C/code\u003E, \u003Ccode\u003Ebunq\u003C/code\u003E, \u003Ccode\u003Ehandelsbanken\u003C/code\u003E, \u003Ccode\u003Eing\u003C/code\u003E, \u003Ccode\u003Eknab\u003C/code\u003E, \u003Ccode\u003Emoneyou\u003C/code\u003E, \u003Ccode\u003Erabobank\u003C/code\u003E, \u003Ccode\u003Eregiobank\u003C/code\u003E, \u003Ccode\u003Erevolut\u003C/code\u003E, \u003Ccode\u003Esns_bank\u003C/code\u003E, \u003Ccode\u003Etriodos_bank\u003C/code\u003E, \u003Ccode\u003Evan_lanschot\u003C/code\u003E, or \u003Ccode\u003Eyoursafe\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"},"bic":{"name":"bic","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The Bank Identifier Code of the customer's bank, if the bank was provided.","undocumented":false,"html":"The Bank Identifier Code of the customer’s bank, if the bank was provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bic"}},"object_type":"ideal","less_common":true},"interac_present":{"name":"interac_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Einterac_present\u003C/code\u003E PaymentMethod, this hash contains details about the Interac Present payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `interac`, `mastercard` or `visa`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E or \u003Ccode\u003Evisa\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"preferred_locales":{"name":"preferred_locales","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.","undocumented":false,"html":"EMV tag 5F2D. Preferred languages specified by the integrated circuit chip."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred_locales"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"}},"object_type":"interac_present","less_common":true},"klarna":{"name":"klarna","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eklarna\u003C/code\u003E PaymentMethod, this hash contains details about the Klarna payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"dob":{"name":"dob","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's date of birth, if provided.","undocumented":false,"html":"The customer’s date of birth, if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":true,"subspec":{"day":{"name":"day","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The day of birth, between 1 and 31.","undocumented":false,"html":"The day of birth, between 1 and 31."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"day"},"month":{"name":"month","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The month of birth, between 1 and 12.","undocumented":false,"html":"The month of birth, between 1 and 12."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"month"},"year":{"name":"year","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The four-digit year of birth.","undocumented":false,"html":"The four-digit year of birth."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"year"}},"object_type":"dob"}},"object_type":"klarna","less_common":true},"konbini":{"name":"konbini","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ekonbini\u003C/code\u003E PaymentMethod, this hash contains details about the Konbini payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"konbini","less_common":true},"link":{"name":"link","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003ELink\u003C/code\u003E PaymentMethod, this hash contains details about the Link payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account owner's email address.","undocumented":false,"html":"Account owner’s email address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"persistent_token":{"name":"persistent_token","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Token used for persistent Link logins.","undocumented":false,"html":"Token used for persistent Link logins."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"persistent_token"}},"object_type":"link","less_common":true},"livemode":{"name":"livemode","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","undocumented":false,"html":"Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"livemode","less_common":true},"metadata":{"name":"metadata","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Set of [key-value pairs](/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.","undocumented":false,"html":"Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"metadata"},"oxxo":{"name":"oxxo","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eoxxo\u003C/code\u003E PaymentMethod, this hash contains details about the OXXO payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"oxxo","less_common":true},"p24":{"name":"p24","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ep24\u003C/code\u003E PaymentMethod, this hash contains details about the P24 payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's bank, if provided.","undocumented":false,"html":"The customer’s bank, if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"ing":{"documentation":null},"citi_handlowy":{"documentation":null},"tmobile_usbugi_bankowe":{"documentation":null},"plus_bank":{"documentation":null},"etransfer_pocztowy24":{"documentation":null},"banki_spbdzielcze":{"documentation":null},"bank_nowy_bfg_sa":{"documentation":null},"getin_bank":{"documentation":null},"blik":{"documentation":null},"noble_pay":{"documentation":null},"ideabank":{"documentation":null},"envelobank":{"documentation":null},"santander_przelew24":{"documentation":null},"nest_przelew":{"documentation":null},"mbank_mtransfer":{"documentation":null},"inteligo":{"documentation":null},"pbac_z_ipko":{"documentation":null},"bnp_paribas":{"documentation":null},"credit_agricole":{"documentation":null},"toyota_bank":{"documentation":null},"bank_pekao_sa":{"documentation":null},"volkswagen_bank":{"documentation":null},"bank_millennium":{"documentation":null},"alior_bank":{"documentation":null},"boz":{"documentation":null}},"object_type":"bank"}},"object_type":"p24","less_common":true},"paynow":{"name":"paynow","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epaynow\u003C/code\u003E PaymentMethod, this hash contains details about the PayNow payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"paynow","less_common":true},"pix":{"name":"pix","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epix\u003C/code\u003E PaymentMethod, this hash contains details about the Pix payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"pix","less_common":true},"promptpay":{"name":"promptpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epromptpay\u003C/code\u003E PaymentMethod, this hash contains details about the PromptPay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"promptpay","less_common":true},"radar_options":{"name":"radar_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Options to configure Radar. See [Radar Session](/docs/radar/radar-session) for more information.","undocumented":false,"html":"Options to configure Radar. See \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E for more information."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"session":{"name":"session","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A [Radar Session](/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.","undocumented":false,"html":"A \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"session"}},"object_type":"radar_options","less_common":true},"sepa_debit":{"name":"sepa_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.","undocumented":false,"html":"If this is a \u003Ccode\u003Esepa_debit\u003C/code\u003E PaymentMethod, this hash contains details about the SEPA debit bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_code":{"name":"bank_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank code of bank associated with the bank account.","undocumented":false,"html":"Bank code of bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_code"},"branch_code":{"name":"branch_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Branch code of bank associated with the bank account.","undocumented":false,"html":"Branch code of bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"branch_code"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter ISO code representing the country the bank account is located in.","undocumented":false,"html":"Two-letter ISO code representing the country the bank account is located in."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"generated_from":{"name":"generated_from","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Information about the object that generated this PaymentMethod.","undocumented":false,"html":"Information about the object that generated this PaymentMethod."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the Charge that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the Charge that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["charge"],"object_type":"charge"},"setup_attempt":{"name":"setup_attempt","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the SetupAttempt that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the SetupAttempt that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["setup_attempt"],"object_type":"setup_attempt"}},"object_type":"generated_from"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four characters of the IBAN.","undocumented":false,"html":"Last four characters of the IBAN."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"}},"object_type":"sepa_debit","less_common":true},"sofort":{"name":"sofort","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Esofort\u003C/code\u003E PaymentMethod, this hash contains details about the SOFORT payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter ISO code representing the country the bank account is located in.","undocumented":false,"html":"Two-letter ISO code representing the country the bank account is located in."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"}},"object_type":"sofort","less_common":true},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"acss_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Pre-authorized debit payments](/docs/payments/acss-debit) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).","undocumented":false,"html":"\u003Ca href=\"/docs/payments/acss-debit\"\u003EPre-authorized debit payments\u003C/a\u003E are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS)."}},"affirm":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Affirm](/docs/payments/affirm) is a buy now, pay later payment method in the US.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/affirm\"\u003EAffirm\u003C/a\u003E is a buy now, pay later payment method in the US."}},"afterpay_clearpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Afterpay / Clearpay](/docs/payments/afterpay-clearpay) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/afterpay-clearpay\"\u003EAfterpay / Clearpay\u003C/a\u003E is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US."}},"alipay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Alipay](/docs/payments/alipay) is a digital wallet payment method used in China.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/alipay\"\u003EAlipay\u003C/a\u003E is a digital wallet payment method used in China."}},"au_becs_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[BECS Direct Debit](/docs/payments/au-becs-debit) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).","undocumented":false,"html":"\u003Ca href=\"/docs/payments/au-becs-debit\"\u003EBECS Direct Debit\u003C/a\u003E is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS)."}},"bacs_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Bacs Direct Debit](/docs/payments/payment-methods/bacs-debit) is used to debit UK bank accounts.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/payment-methods/bacs-debit\"\u003EBacs Direct Debit\u003C/a\u003E is used to debit UK bank accounts."}},"bancontact":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Bancontact](/docs/payments/bancontact) is a bank redirect payment method used in Belgium.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/bancontact\"\u003EBancontact\u003C/a\u003E is a bank redirect payment method used in Belgium."}},"blik":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[BLIK](/docs/payments/blik) is a single-use payment method common in Poland.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/blik\"\u003EBLIK\u003C/a\u003E is a single-use payment method common in Poland."}},"boleto":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Boleto](/docs/payments/boleto) is a voucher-based payment method used in Brazil.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/boleto\"\u003EBoleto\u003C/a\u003E is a voucher-based payment method used in Brazil."}},"card":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Card payments](/docs/payments/payment-methods/overview#cards) are supported through many networks and card brands.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/payment-methods/overview#cards\"\u003ECard payments\u003C/a\u003E are supported through many networks and card brands."}},"card_present":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Stripe Terminal](/docs/terminal/payments/collect-payment) is used to collect in-person card payments.","undocumented":false,"html":"\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E is used to collect in-person card payments."}},"customer_balance":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uses a customer’s [cash balance](/docs/payments/customer-balance) for the payment.","undocumented":false,"html":"Uses a customer’s \u003Ca href=\"/docs/payments/customer-balance\"\u003Ecash balance\u003C/a\u003E for the payment."}},"eps":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[EPS](/docs/payments/eps) is an Austria-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/eps\"\u003EEPS\u003C/a\u003E is an Austria-based bank redirect payment method."}},"fpx":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[FPX](/docs/payments/fpx) is a Malaysia-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/fpx\"\u003EFPX\u003C/a\u003E is a Malaysia-based bank redirect payment method."}},"giropay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[giropay](/docs/payments/giropay) is a German bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/giropay\"\u003Egiropay\u003C/a\u003E is a German bank redirect payment method."}},"grabpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[GrabPay](/docs/payments/grabpay) is a digital wallet payment method used in Southeast Asia.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/grabpay\"\u003EGrabPay\u003C/a\u003E is a digital wallet payment method used in Southeast Asia."}},"ideal":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[iDEAL](/docs/payments/ideal) is a Netherlands-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/ideal\"\u003EiDEAL\u003C/a\u003E is a Netherlands-based bank redirect payment method."}},"interac_present":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Stripe Terminal](/docs/terminal/payments/collect-payment) accepts [Interac](/docs/terminal/payments/regional?integration-country=CA#interac-payments) debit cards for in-person payments in Canada.","undocumented":false,"html":"\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E accepts \u003Ca href=\"/docs/terminal/payments/regional?integration-country=CA#interac-payments\"\u003EInterac\u003C/a\u003E debit cards for in-person payments in Canada."}},"klarna":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Klarna](/docs/payments/klarna) is a global buy now, pay later payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/klarna\"\u003EKlarna\u003C/a\u003E is a global buy now, pay later payment method."}},"konbini":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Konbini](/docs/payments/konbini) is a cash-based voucher payment method used in Japan.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/konbini\"\u003EKonbini\u003C/a\u003E is a cash-based voucher payment method used in Japan."}},"link":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Link](/docs/payments/link) allows customers to pay with their saved payment details.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/link\"\u003ELink\u003C/a\u003E allows customers to pay with their saved payment details."}},"oxxo":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[OXXO](/docs/payments/oxxo) is a cash-based voucher payment method used in Mexico.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/oxxo\"\u003EOXXO\u003C/a\u003E is a cash-based voucher payment method used in Mexico."}},"p24":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Przelewy24](/docs/payments/p24) is a bank redirect payment method used in Poland.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/p24\"\u003EPrzelewy24\u003C/a\u003E is a bank redirect payment method used in Poland."}},"paynow":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[PayNow](/docs/payments/paynow) is a QR code payment method used in Singapore.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/paynow\"\u003EPayNow\u003C/a\u003E is a QR code payment method used in Singapore."}},"pix":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Pix](/docs/payments/pix) is an instant bank transfer payment method in Brazil.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/pix\"\u003EPix\u003C/a\u003E is an instant bank transfer payment method in Brazil."}},"promptpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[PromptPay](/docs/payments/promptpay) is an instant funds transfer service popular in Thailand.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/promptpay\"\u003EPromptPay\u003C/a\u003E is an instant funds transfer service popular in Thailand."}},"sepa_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[SEPA Direct Debit](/docs/payments/sepa-debit) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/sepa-debit\"\u003ESEPA Direct Debit\u003C/a\u003E is used to debit bank accounts within the Single Euro Payments Area (SEPA) region."}},"sofort":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Sofort](/docs/payments/sofort) is a bank redirect payment method used in Europe.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/sofort\"\u003ESofort\u003C/a\u003E is a bank redirect payment method used in Europe."}},"us_bank_account":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[ACH Direct Debit](/docs/payments/ach-debit) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/ach-debit\"\u003EACH Direct Debit\u003C/a\u003E is used to debit US bank accounts through the Automated Clearing House (ACH) payments system."}},"wechat_pay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[WeChat Pay](/docs/payments/wechat-pay) is a digital wallet payment method based in China.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/wechat-pay\"\u003EWeChat Pay\u003C/a\u003E is a digital wallet payment method based in China."}}},"object_type":"type"},"us_bank_account":{"name":"us_bank_account","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eus_bank_account\u003C/code\u003E PaymentMethod, this hash contains details about the US bank account payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_holder_type":{"name":"account_holder_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account holder type: individual or company.","undocumented":false,"html":"Account holder type: individual or company."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"individual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account belongs to an individual","undocumented":false,"html":"Account belongs to an individual"}},"company":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account belongs to a company","undocumented":false,"html":"Account belongs to a company"}}},"object_type":"account_holder_type"},"account_type":{"name":"account_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account type: checkings or savings. Defaults to checking if omitted.","undocumented":false,"html":"Account type: checkings or savings. Defaults to checking if omitted."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"checking":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account type is checking","undocumented":false,"html":"Bank account type is checking"}},"savings":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account type is savings","undocumented":false,"html":"Bank account type is savings"}}},"object_type":"account_type"},"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The name of the bank.","undocumented":false,"html":"The name of the bank."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"financial_connections_account":{"name":"financial_connections_account","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the Financial Connections Account used to create the payment method.","undocumented":false,"html":"The ID of the Financial Connections Account used to create the payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"financial_connections_account"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about US bank account networks that can be used.","undocumented":false,"html":"Contains information about US bank account networks that can be used."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network.","undocumented":false,"html":"The preferred network."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"},"supported":{"name":"supported","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All supported networks.","undocumented":false,"html":"All supported networks."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported"}},"object_type":"networks"},"routing_number":{"name":"routing_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Routing number of the bank account.","undocumented":false,"html":"Routing number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"routing_number"}},"object_type":"us_bank_account","less_common":true},"wechat_pay":{"name":"wechat_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Ewechat_pay\u003C/code\u003E PaymentMethod, this hash contains details about the wechat_pay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"wechat_pay","less_common":true}},"object_type":"payment_method","less_common":true},"payment_method_type":{"name":"payment_method_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_method_type","less_common":true},"request_log_url":{"name":"request_log_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A URL to the request log entry in your dashboard.","undocumented":false,"html":"A URL to the request log entry in your dashboard."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"request_log_url","less_common":true},"setup_intent":{"name":"setup_intent","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The SetupIntent object for errors returned on a request involving a SetupIntent.","undocumented":false,"html":"The SetupIntent object for errors returned on a request involving a SetupIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"setup_intent","less_common":true,"subspec":{"id":{"name":"id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Unique identifier for the object.","undocumented":false,"html":"Unique identifier for the object."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"id"},"object":{"name":"object","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"String representing the object's type. Objects of the same type share the same value.","undocumented":false,"html":"String representing the object’s type. Objects of the same type share the same value."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"object","less_common":true},"application":{"name":"application","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the Connect application that created the SetupIntent.\n","undocumented":false,"html":"ID of the Connect application that created the SetupIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"Connect only","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["application"],"object_type":"application","less_common":true},"attach_to_self":{"name":"attach_to_self","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.\n","undocumented":false,"html":"If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.\u003C/p\u003E\n\n\u003Cp\u003EIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"attach_to_self","less_common":true},"cancellation_reason":{"name":"cancellation_reason","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.","undocumented":false,"html":"Reason for cancellation of this SetupIntent, one of \u003Ccode\u003Eabandoned\u003C/code\u003E, \u003Ccode\u003Erequested_by_customer\u003C/code\u003E, or \u003Ccode\u003Eduplicate\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cancellation_reason","less_common":true},"client_secret":{"name":"client_secret","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.","undocumented":false,"html":"The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\u003C/p\u003E\n\n\u003Cp\u003EThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"client_secret"},"created":{"name":"created","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Time at which the object was created. Measured in seconds since the Unix epoch.","undocumented":false,"html":"Time at which the object was created. Measured in seconds since the Unix epoch."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"created","less_common":true},"customer":{"name":"customer","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.\n","undocumented":false,"html":"ID of the Customer this SetupIntent belongs to, if one exists.\u003C/p\u003E\n\n\u003Cp\u003EIf 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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["customer"],"object_type":"customer"},"description":{"name":"description","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An arbitrary string attached to the object. Often useful for displaying to users.","undocumented":false,"html":"An arbitrary string attached to the object. Often useful for displaying to users."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"description"},"flow_directions":{"name":"flow_directions","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.\n","undocumented":false,"html":"Indicates the directions of money movement for which this payment method is intended to be used.\u003C/p\u003E\n\n\u003Cp\u003EInclude \u003Ccode\u003Einbound\u003C/code\u003E if you intend to use the payment method as the origin to pull funds from. Include \u003Ccode\u003Eoutbound\u003C/code\u003E if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"flow_directions","less_common":true},"last_setup_error":{"name":"last_setup_error","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The error encountered in the previous SetupIntent confirmation.","undocumented":false,"html":"The error encountered in the previous SetupIntent confirmation."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`","undocumented":false,"html":"The type of error returned. One of \u003Ccode\u003Eapi_error\u003C/code\u003E, \u003Ccode\u003Ecard_error\u003C/code\u003E, \u003Ccode\u003Eidempotency_error\u003C/code\u003E, or \u003Ccode\u003Einvalid_request_error\u003C/code\u003E"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"code":{"name":"code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For some errors that could be handled programmatically, a short string indicating the [error code](/docs/error-codes) reported.","undocumented":false,"html":"For some errors that could be handled programmatically, a short string indicating the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"code"},"decline_code":{"name":"decline_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](/docs/declines#issuer-declines) if they provide one.","undocumented":false,"html":"For card errors resulting from a card issuer decline, a short string indicating the \u003Ca href=\"/docs/declines#issuer-declines\"\u003Ecard issuer’s reason for the decline\u003C/a\u003E if they provide one."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"decline_code"},"doc_url":{"name":"doc_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A URL to more information about the [error code](/docs/error-codes) reported.","undocumented":false,"html":"A URL to more information about the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"doc_url","less_common":true},"message":{"name":"message","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.","undocumented":false,"html":"A human-readable message providing more details about the error. For card errors, these messages can be shown to your users."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"message"},"param":{"name":"param","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"param"},"payment_method":{"name":"payment_method","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The PaymentMethod object for errors returned on a request involving a PaymentMethod.","undocumented":false,"html":"The PaymentMethod object for errors returned on a request involving a PaymentMethod."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"id":{"name":"id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Unique identifier for the object.","undocumented":false,"html":"Unique identifier for the object."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"id"},"object":{"name":"object","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"String representing the object's type. Objects of the same type share the same value.","undocumented":false,"html":"String representing the object’s type. Objects of the same type share the same value."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"object","less_common":true},"acss_debit":{"name":"acss_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eacss_debit\u003C/code\u003E PaymentMethod, this hash contains details about the ACSS Debit payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Name of the bank associated with the bank account.","undocumented":false,"html":"Name of the bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"institution_number":{"name":"institution_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Institution number of the bank account.","undocumented":false,"html":"Institution number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"institution_number"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"transit_number":{"name":"transit_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transit number of the bank account.","undocumented":false,"html":"Transit number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"transit_number"}},"object_type":"acss_debit","less_common":true},"affirm":{"name":"affirm","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eaffirm\u003C/code\u003E PaymentMethod, this hash contains details about the Affirm payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"affirm","less_common":true},"afterpay_clearpay":{"name":"afterpay_clearpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003EAfterpayClearpay\u003C/code\u003E PaymentMethod, this hash contains details about the AfterpayClearpay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"afterpay_clearpay","less_common":true},"alipay":{"name":"alipay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003EAlipay\u003C/code\u003E PaymentMethod, this hash contains details about the Alipay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"alipay","less_common":true},"au_becs_debit":{"name":"au_becs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.","undocumented":false,"html":"If this is an \u003Ccode\u003Eau_becs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bsb_number":{"name":"bsb_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Six-digit number identifying bank and branch associated with this bank account.","undocumented":false,"html":"Six-digit number identifying bank and branch associated with this bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bsb_number"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"}},"object_type":"au_becs_debit","less_common":true},"bacs_debit":{"name":"bacs_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.","undocumented":false,"html":"If this is a \u003Ccode\u003Ebacs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the Bacs Direct Debit bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"sort_code":{"name":"sort_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Sort code of the bank account. (e.g., `10-20-30`)","undocumented":false,"html":"Sort code of the bank account. (e.g., \u003Ccode\u003E10-20-30\u003C/code\u003E)"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"sort_code"}},"object_type":"bacs_debit","less_common":true},"bancontact":{"name":"bancontact","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ebancontact\u003C/code\u003E PaymentMethod, this hash contains details about the Bancontact payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"bancontact","less_common":true},"billing_details":{"name":"billing_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","undocumented":false,"html":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"address":{"name":"address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing address.","undocumented":false,"html":"Billing address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Email address.","undocumented":false,"html":"Email address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Full name.","undocumented":false,"html":"Full name."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"phone":{"name":"phone","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Billing phone number (including extension).","undocumented":false,"html":"Billing phone number (including extension)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"phone"}},"object_type":"billing_details"},"blik":{"name":"blik","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eblik\u003C/code\u003E PaymentMethod, this hash contains details about the BLIK payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"blik","less_common":true},"boleto":{"name":"boleto","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eboleto\u003C/code\u003E PaymentMethod, this hash contains details about the Boleto payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":null,"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"tax_id":{"name":"tax_id","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies the customer tax id (CNPJ or CPF)","undocumented":false,"html":"Uniquely identifies the customer tax id (CNPJ or CPF)"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"tax_id"}},"object_type":"boleto","less_common":true},"card":{"name":"card","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `card` PaymentMethod, this hash contains the user's card details.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecard\u003C/code\u003E PaymentMethod, this hash contains the user’s card details."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"checks":{"name":"checks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Checks on Card address and CVC if provided.","undocumented":false,"html":"Checks on Card address and CVC if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"address_line1_check":{"name":"address_line1_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a address line1 was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"address_line1_check"},"address_postal_code_check":{"name":"address_postal_code_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a address postal code was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"address_postal_code_check"},"cvc_check":{"name":"cvc_check","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.","undocumented":false,"html":"If a CVC was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cvc_check"}},"object_type":"checks"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":"card_fingerprint_read","hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"generated_from":{"name":"generated_from","check":"hash","validation":"hash","documentation":{"gate_specific":{"sdk_client_public":{"gate_specific":{},"localize_terms":[],"undocumented":true,"html":null}},"localize_terms":[],"markdown":"Details of the original PaymentMethod that created this object.","undocumented":false,"html":"Details of the original PaymentMethod that created this object."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The charge that created this object.","undocumented":false,"html":"The charge that created this object."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"charge"},"payment_method_details":{"name":"payment_method_details","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transaction-specific details of the payment method used in the payment.","undocumented":false,"html":"Transaction-specific details of the payment method used in the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"card_present":{"name":"card_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"This hash contains the snapshot of the `card_present` transaction-specific details which generated this `card` payment method.","undocumented":false,"html":"This hash contains the snapshot of the \u003Ccode\u003Ecard_present\u003C/code\u003E transaction-specific details which generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount_authorized":{"name":"amount_authorized","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The authorized amount","undocumented":false,"html":"The authorized amount"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_authorized"},"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"capture_before":{"name":"capture_before","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.","undocumented":false,"html":"When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"capture_before"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"emv_auth_data":{"name":"emv_auth_data","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Authorization response cryptogram.","undocumented":false,"html":"Authorization response cryptogram."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"emv_auth_data"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"generated_card":{"name":"generated_card","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"generated_card"},"incremental_authorization_supported":{"name":"incremental_authorization_supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether this [PaymentIntent](/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).","undocumented":false,"html":"Whether this \u003Ca href=\"/docs/api/payment_intents\"\u003EPaymentIntent\u003C/a\u003E is eligible for incremental authorizations. Request support using \u003Ca href=\"/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support\"\u003Erequest_incremental_authorization_support\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"incremental_authorization_supported"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"network":{"name":"network","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Identifies which network this charge was processed on. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ecartes_bancaires\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"network"},"overcapture_supported":{"name":"overcapture_supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Defines whether the authorized amount can be over-captured or not","undocumented":false,"html":"Defines whether the authorized amount can be over-captured or not"},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"overcapture_supported"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"},"receipt":{"name":"receipt","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A collection of fields required to be displayed on receipts. Only required for EMV transactions.","undocumented":false,"html":"A collection of fields required to be displayed on receipts. Only required for EMV transactions."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_type":{"name":"account_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of account being debited or credited","undocumented":false,"html":"The type of account being debited or credited"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"credit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A credit account, as when using a credit card","undocumented":false,"html":"A credit account, as when using a credit card"}},"checking":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A checking account, as when using a debit card","undocumented":false,"html":"A checking account, as when using a debit card"}},"prepaid":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A prepaid account, as when using a debit gift card","undocumented":false,"html":"A prepaid account, as when using a debit gift card"}},"unknown":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An unknown account","undocumented":false,"html":"An unknown account"}}},"object_type":"account_type"},"application_cryptogram":{"name":"application_cryptogram","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 9F26, cryptogram generated by the integrated circuit chip.","undocumented":false,"html":"EMV tag 9F26, cryptogram generated by the integrated circuit chip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"application_cryptogram"},"application_preferred_name":{"name":"application_preferred_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Mnenomic of the Application Identifier.","undocumented":false,"html":"Mnenomic of the Application Identifier."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"application_preferred_name"},"authorization_code":{"name":"authorization_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Identifier for this transaction.","undocumented":false,"html":"Identifier for this transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"authorization_code"},"authorization_response_code":{"name":"authorization_response_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 8A. A code returned by the card issuer.","undocumented":false,"html":"EMV tag 8A. A code returned by the card issuer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"authorization_response_code"},"cardholder_verification_method":{"name":"cardholder_verification_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How the cardholder verified ownership of the card.","undocumented":false,"html":"How the cardholder verified ownership of the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_verification_method"},"dedicated_file_name":{"name":"dedicated_file_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.","undocumented":false,"html":"EMV tag 84. Similar to the application identifier stored on the integrated circuit chip."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"dedicated_file_name"},"terminal_verification_results":{"name":"terminal_verification_results","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The outcome of a series of EMV functions performed by the card reader.","undocumented":false,"html":"The outcome of a series of EMV functions performed by the card reader."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"terminal_verification_results"},"transaction_status_information":{"name":"transaction_status_information","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"An indication of various EMV functions performed during the transaction.","undocumented":false,"html":"An indication of various EMV functions performed during the transaction."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"transaction_status_information"}},"object_type":"receipt"}},"object_type":"card_present"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.","undocumented":false,"html":"The type of payment method transaction-specific details from the transaction that generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method. Always \u003Ccode\u003Ecard_present\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"}},"object_type":"payment_method_details"},"setup_attempt":{"name":"setup_attempt","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the SetupAttempt that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the SetupAttempt that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["setup_attempt"],"object_type":"setup_attempt"}},"object_type":"generated_from"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"three_d_secure_usage":{"name":"three_d_secure_usage","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains details on how this Card may be used for 3D Secure authentication.","undocumented":false,"html":"Contains details on how this Card may be used for 3D Secure authentication."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"supported":{"name":"supported","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Whether 3D Secure is supported on this card.","undocumented":false,"html":"Whether 3D Secure is supported on this card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported"}},"object_type":"three_d_secure_usage"},"wallet":{"name":"wallet","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this Card is part of a card wallet, this contains the details of the card wallet.","undocumented":false,"html":"If this Card is part of a card wallet, this contains the details of the card wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amex_express_checkout":{"name":"amex_express_checkout","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `amex_express_checkout` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"amex_express_checkout"},"apple_pay":{"name":"apple_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `apple_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Eapple_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"apple_pay"},"dynamic_last4":{"name":"dynamic_last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"(For tokenized numbers only.) The last four digits of the device account number.","undocumented":false,"html":"(For tokenized numbers only.) The last four digits of the device account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"dynamic_last4"},"google_pay":{"name":"google_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `google_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Egoogle_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"google_pay"},"masterpass":{"name":"masterpass","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `masterpass` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Emasterpass\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"billing_address":{"name":"billing_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"billing_address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"shipping_address":{"name":"shipping_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"shipping_address"}},"object_type":"masterpass"},"samsung_pay":{"name":"samsung_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `samsung_pay` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Esamsung_pay\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"samsung_pay"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"The type of the card wallet, one of \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E, \u003Ccode\u003Eapple_pay\u003C/code\u003E, \u003Ccode\u003Egoogle_pay\u003C/code\u003E, \u003Ccode\u003Emasterpass\u003C/code\u003E, \u003Ccode\u003Esamsung_pay\u003C/code\u003E, or \u003Ccode\u003Evisa_checkout\u003C/code\u003E. 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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"visa_checkout":{"name":"visa_checkout","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `visa_checkout` card wallet, this hash contains details about the wallet.","undocumented":false,"html":"If this is a \u003Ccode\u003Evisa_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"billing_address":{"name":"billing_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"billing_address"},"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"name":{"name":"name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"name"},"shipping_address":{"name":"shipping_address","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"city":{"name":"city","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"City, district, suburb, town, or village.","undocumented":false,"html":"City, district, suburb, town, or village."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"city"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","undocumented":false,"html":"Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"line1":{"name":"line1","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 1 (e.g., street, PO Box, or company name).","undocumented":false,"html":"Address line 1 (e.g., street, PO Box, or company name)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line1"},"line2":{"name":"line2","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Address line 2 (e.g., apartment, suite, unit, or building).","undocumented":false,"html":"Address line 2 (e.g., apartment, suite, unit, or building)."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"line2"},"postal_code":{"name":"postal_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ZIP or postal code.","undocumented":false,"html":"ZIP or postal code."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"postal_code"},"state":{"name":"state","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"State, county, province, or region.","undocumented":false,"html":"State, county, province, or region."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"state"}},"object_type":"shipping_address"}},"object_type":"visa_checkout"}},"object_type":"wallet"}},"object_type":"card","less_common":true},"card_present":{"name":"card_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `card_present` PaymentMethod, this hash contains details about the Card Present payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecard_present\u003C/code\u003E PaymentMethod, this hash contains details about the Card Present payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"}},"object_type":"card_present","less_common":true},"created":{"name":"created","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Time at which the object was created. Measured in seconds since the Unix epoch.","undocumented":false,"html":"Time at which the object was created. Measured in seconds since the Unix epoch."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"created","less_common":true},"customer":{"name":"customer","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["customer"],"object_type":"customer"},"customer_balance":{"name":"customer_balance","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ecustomer_balance\u003C/code\u003E PaymentMethod, this hash contains details about the CustomerBalance payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"customer_balance","less_common":true},"eps":{"name":"eps","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eeps\u003C/code\u003E PaymentMethod, this hash contains details about the EPS payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`, `deutsche_bank_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`.","undocumented":false,"html":"The customer’s bank. Should be one of \u003Ccode\u003Earzte_und_apotheker_bank\u003C/code\u003E, \u003Ccode\u003Eaustrian_anadi_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebank_austria\u003C/code\u003E, \u003Ccode\u003Ebankhaus_carl_spangler\u003C/code\u003E, \u003Ccode\u003Ebankhaus_schelhammer_und_schattera_ag\u003C/code\u003E, \u003Ccode\u003Ebawag_psk_ag\u003C/code\u003E, \u003Ccode\u003Ebks_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebrull_kallmus_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebtv_vier_lander_bank\u003C/code\u003E, \u003Ccode\u003Ecapital_bank_grawe_gruppe_ag\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank_ag\u003C/code\u003E, \u003Ccode\u003Edolomitenbank\u003C/code\u003E, \u003Ccode\u003Eeasybank_ag\u003C/code\u003E, \u003Ccode\u003Eerste_bank_und_sparkassen\u003C/code\u003E, \u003Ccode\u003Ehypo_alpeadriabank_international_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_noe_lb_fur_niederosterreich_u_wien\u003C/code\u003E, \u003Ccode\u003Ehypo_oberosterreich_salzburg_steiermark\u003C/code\u003E, \u003Ccode\u003Ehypo_tirol_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_vorarlberg_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_bank_burgenland_aktiengesellschaft\u003C/code\u003E, \u003Ccode\u003Emarchfelder_bank\u003C/code\u003E, \u003Ccode\u003Eoberbank_ag\u003C/code\u003E, \u003Ccode\u003Eraiffeisen_bankengruppe_osterreich\u003C/code\u003E, \u003Ccode\u003Eschoellerbank_ag\u003C/code\u003E, \u003Ccode\u003Esparda_bank_wien\u003C/code\u003E, \u003Ccode\u003Evolksbank_gruppe\u003C/code\u003E, \u003Ccode\u003Evolkskreditbank_ag\u003C/code\u003E, or \u003Ccode\u003Evr_bank_braunau\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"}},"object_type":"eps","less_common":true},"fpx":{"name":"fpx","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Efpx\u003C/code\u003E PaymentMethod, this hash contains details about the FPX payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `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`, `pb_enterprise`, or `bank_of_china`.","undocumented":false,"html":"The customer’s bank, if provided. Can be one of \u003Ccode\u003Eaffin_bank\u003C/code\u003E, \u003Ccode\u003Eagrobank\u003C/code\u003E, \u003Ccode\u003Ealliance_bank\u003C/code\u003E, \u003Ccode\u003Eambank\u003C/code\u003E, \u003Ccode\u003Ebank_islam\u003C/code\u003E, \u003Ccode\u003Ebank_muamalat\u003C/code\u003E, \u003Ccode\u003Ebank_rakyat\u003C/code\u003E, \u003Ccode\u003Ebsn\u003C/code\u003E, \u003Ccode\u003Ecimb\u003C/code\u003E, \u003Ccode\u003Ehong_leong_bank\u003C/code\u003E, \u003Ccode\u003Ehsbc\u003C/code\u003E, \u003Ccode\u003Ekfh\u003C/code\u003E, \u003Ccode\u003Emaybank2u\u003C/code\u003E, \u003Ccode\u003Eocbc\u003C/code\u003E, \u003Ccode\u003Epublic_bank\u003C/code\u003E, \u003Ccode\u003Erhb\u003C/code\u003E, \u003Ccode\u003Estandard_chartered\u003C/code\u003E, \u003Ccode\u003Euob\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank\u003C/code\u003E, \u003Ccode\u003Emaybank2e\u003C/code\u003E, \u003Ccode\u003Epb_enterprise\u003C/code\u003E, or \u003Ccode\u003Ebank_of_china\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"}},"object_type":"fpx","less_common":true},"giropay":{"name":"giropay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Egiropay\u003C/code\u003E PaymentMethod, this hash contains details about the Giropay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"giropay","less_common":true},"grabpay":{"name":"grabpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Egrabpay\u003C/code\u003E PaymentMethod, this hash contains details about the GrabPay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"grabpay","less_common":true},"ideal":{"name":"ideal","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eideal\u003C/code\u003E PaymentMethod, this hash contains details about the iDEAL payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`, `van_lanschot`, or `yoursafe`.","undocumented":false,"html":"The customer’s bank, if provided. Can be one of \u003Ccode\u003Eabn_amro\u003C/code\u003E, \u003Ccode\u003Easn_bank\u003C/code\u003E, \u003Ccode\u003Ebunq\u003C/code\u003E, \u003Ccode\u003Ehandelsbanken\u003C/code\u003E, \u003Ccode\u003Eing\u003C/code\u003E, \u003Ccode\u003Eknab\u003C/code\u003E, \u003Ccode\u003Emoneyou\u003C/code\u003E, \u003Ccode\u003Erabobank\u003C/code\u003E, \u003Ccode\u003Eregiobank\u003C/code\u003E, \u003Ccode\u003Erevolut\u003C/code\u003E, \u003Ccode\u003Esns_bank\u003C/code\u003E, \u003Ccode\u003Etriodos_bank\u003C/code\u003E, \u003Ccode\u003Evan_lanschot\u003C/code\u003E, or \u003Ccode\u003Eyoursafe\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank"},"bic":{"name":"bic","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The Bank Identifier Code of the customer's bank, if the bank was provided.","undocumented":false,"html":"The Bank Identifier Code of the customer’s bank, if the bank was provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bic"}},"object_type":"ideal","less_common":true},"interac_present":{"name":"interac_present","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Einterac_present\u003C/code\u003E PaymentMethod, this hash contains details about the Interac Present payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"brand":{"name":"brand","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card brand. Can be `interac`, `mastercard` or `visa`.","undocumented":false,"html":"Card brand. Can be \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E or \u003Ccode\u003Evisa\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"brand"},"cardholder_name":{"name":"cardholder_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","undocumented":false,"html":"The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"cardholder_name"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"exp_month":{"name":"exp_month","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-digit number representing the card's expiration month.","undocumented":false,"html":"Two-digit number representing the card’s expiration month."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_month"},"exp_year":{"name":"exp_year","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Four-digit number representing the card's expiration year.","undocumented":false,"html":"Four-digit number representing the card’s expiration year."},"gate":true,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"exp_year"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.*\n","undocumented":false,"html":"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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"funding":{"name":"funding","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","undocumented":false,"html":"Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"funding"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The last four digits of the card.","undocumented":false,"html":"The last four digits of the card."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about card networks that can be used to process the payment.","undocumented":false,"html":"Contains information about card networks that can be used to process the payment."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"available":{"name":"available","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All available networks for the card.","undocumented":false,"html":"All available networks for the card."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"available"},"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network for the card.","undocumented":false,"html":"The preferred network for the card."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"}},"object_type":"networks"},"preferred_locales":{"name":"preferred_locales","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.","undocumented":false,"html":"EMV tag 5F2D. Preferred languages specified by the integrated circuit chip."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred_locales"},"read_method":{"name":"read_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"How card details were read in this transaction.","undocumented":false,"html":"How card details were read in this transaction."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"contact_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Inserting a chip card into the card reader.","undocumented":false,"html":"Inserting a chip card into the card reader."}},"contactless_emv":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Tapping a contactless-enabled chip card or mobile wallet.","undocumented":false,"html":"Tapping a contactless-enabled chip card or mobile wallet."}},"magnetic_stripe_track2":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Swiping a card using the magnetic stripe reader.","undocumented":false,"html":"Swiping a card using the magnetic stripe reader."}},"magnetic_stripe_fallback":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.","undocumented":false,"html":"When inserting a chip card fails three times in a row, fallback to a magnetic stripe read."}},"contactless_magstripe_mode":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Older standard for contactless payments that emulated a magnetic stripe read.","undocumented":false,"html":"Older standard for contactless payments that emulated a magnetic stripe read."}}},"object_type":"read_method"}},"object_type":"interac_present","less_common":true},"klarna":{"name":"klarna","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Eklarna\u003C/code\u003E PaymentMethod, this hash contains details about the Klarna payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"dob":{"name":"dob","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's date of birth, if provided.","undocumented":false,"html":"The customer’s date of birth, if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":true,"subspec":{"day":{"name":"day","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The day of birth, between 1 and 31.","undocumented":false,"html":"The day of birth, between 1 and 31."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"day"},"month":{"name":"month","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The month of birth, between 1 and 12.","undocumented":false,"html":"The month of birth, between 1 and 12."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"month"},"year":{"name":"year","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The four-digit year of birth.","undocumented":false,"html":"The four-digit year of birth."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"year"}},"object_type":"dob"}},"object_type":"klarna","less_common":true},"konbini":{"name":"konbini","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ekonbini\u003C/code\u003E PaymentMethod, this hash contains details about the Konbini payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"konbini","less_common":true},"link":{"name":"link","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003ELink\u003C/code\u003E PaymentMethod, this hash contains details about the Link payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"email":{"name":"email","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account owner's email address.","undocumented":false,"html":"Account owner’s email address."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"email"},"persistent_token":{"name":"persistent_token","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Token used for persistent Link logins.","undocumented":false,"html":"Token used for persistent Link logins."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"persistent_token"}},"object_type":"link","less_common":true},"livemode":{"name":"livemode","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","undocumented":false,"html":"Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"livemode","less_common":true},"metadata":{"name":"metadata","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Set of [key-value pairs](/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.","undocumented":false,"html":"Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"metadata"},"oxxo":{"name":"oxxo","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eoxxo\u003C/code\u003E PaymentMethod, this hash contains details about the OXXO payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"oxxo","less_common":true},"p24":{"name":"p24","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Ep24\u003C/code\u003E PaymentMethod, this hash contains details about the P24 payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank":{"name":"bank","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The customer's bank, if provided.","undocumented":false,"html":"The customer’s bank, if provided."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"ing":{"documentation":null},"citi_handlowy":{"documentation":null},"tmobile_usbugi_bankowe":{"documentation":null},"plus_bank":{"documentation":null},"etransfer_pocztowy24":{"documentation":null},"banki_spbdzielcze":{"documentation":null},"bank_nowy_bfg_sa":{"documentation":null},"getin_bank":{"documentation":null},"blik":{"documentation":null},"noble_pay":{"documentation":null},"ideabank":{"documentation":null},"envelobank":{"documentation":null},"santander_przelew24":{"documentation":null},"nest_przelew":{"documentation":null},"mbank_mtransfer":{"documentation":null},"inteligo":{"documentation":null},"pbac_z_ipko":{"documentation":null},"bnp_paribas":{"documentation":null},"credit_agricole":{"documentation":null},"toyota_bank":{"documentation":null},"bank_pekao_sa":{"documentation":null},"volkswagen_bank":{"documentation":null},"bank_millennium":{"documentation":null},"alior_bank":{"documentation":null},"boz":{"documentation":null}},"object_type":"bank"}},"object_type":"p24","less_common":true},"paynow":{"name":"paynow","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epaynow\u003C/code\u003E PaymentMethod, this hash contains details about the PayNow payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"paynow","less_common":true},"pix":{"name":"pix","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epix\u003C/code\u003E PaymentMethod, this hash contains details about the Pix payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"pix","less_common":true},"promptpay":{"name":"promptpay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Epromptpay\u003C/code\u003E PaymentMethod, this hash contains details about the PromptPay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"promptpay","less_common":true},"radar_options":{"name":"radar_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Options to configure Radar. See [Radar Session](/docs/radar/radar-session) for more information.","undocumented":false,"html":"Options to configure Radar. See \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E for more information."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"session":{"name":"session","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A [Radar Session](/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.","undocumented":false,"html":"A \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"session"}},"object_type":"radar_options","less_common":true},"sepa_debit":{"name":"sepa_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.","undocumented":false,"html":"If this is a \u003Ccode\u003Esepa_debit\u003C/code\u003E PaymentMethod, this hash contains details about the SEPA debit bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"bank_code":{"name":"bank_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank code of bank associated with the bank account.","undocumented":false,"html":"Bank code of bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_code"},"branch_code":{"name":"branch_code","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Branch code of bank associated with the bank account.","undocumented":false,"html":"Branch code of bank associated with the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"branch_code"},"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter ISO code representing the country the bank account is located in.","undocumented":false,"html":"Two-letter ISO code representing the country the bank account is located in."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"generated_from":{"name":"generated_from","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Information about the object that generated this PaymentMethod.","undocumented":false,"html":"Information about the object that generated this PaymentMethod."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"charge":{"name":"charge","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the Charge that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the Charge that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["charge"],"object_type":"charge"},"setup_attempt":{"name":"setup_attempt","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the SetupAttempt that generated this PaymentMethod, if any.","undocumented":false,"html":"The ID of the SetupAttempt that generated this PaymentMethod, if any."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["setup_attempt"],"object_type":"setup_attempt"}},"object_type":"generated_from"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four characters of the IBAN.","undocumented":false,"html":"Last four characters of the IBAN."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"}},"object_type":"sepa_debit","less_common":true},"sofort":{"name":"sofort","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.","undocumented":false,"html":"If this is a \u003Ccode\u003Esofort\u003C/code\u003E PaymentMethod, this hash contains details about the SOFORT payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"country":{"name":"country","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Two-letter ISO code representing the country the bank account is located in.","undocumented":false,"html":"Two-letter ISO code representing the country the bank account is located in."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"country"}},"object_type":"sofort","less_common":true},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"acss_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Pre-authorized debit payments](/docs/payments/acss-debit) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).","undocumented":false,"html":"\u003Ca href=\"/docs/payments/acss-debit\"\u003EPre-authorized debit payments\u003C/a\u003E are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS)."}},"affirm":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Affirm](/docs/payments/affirm) is a buy now, pay later payment method in the US.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/affirm\"\u003EAffirm\u003C/a\u003E is a buy now, pay later payment method in the US."}},"afterpay_clearpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Afterpay / Clearpay](/docs/payments/afterpay-clearpay) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/afterpay-clearpay\"\u003EAfterpay / Clearpay\u003C/a\u003E is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US."}},"alipay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Alipay](/docs/payments/alipay) is a digital wallet payment method used in China.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/alipay\"\u003EAlipay\u003C/a\u003E is a digital wallet payment method used in China."}},"au_becs_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[BECS Direct Debit](/docs/payments/au-becs-debit) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).","undocumented":false,"html":"\u003Ca href=\"/docs/payments/au-becs-debit\"\u003EBECS Direct Debit\u003C/a\u003E is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS)."}},"bacs_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Bacs Direct Debit](/docs/payments/payment-methods/bacs-debit) is used to debit UK bank accounts.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/payment-methods/bacs-debit\"\u003EBacs Direct Debit\u003C/a\u003E is used to debit UK bank accounts."}},"bancontact":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Bancontact](/docs/payments/bancontact) is a bank redirect payment method used in Belgium.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/bancontact\"\u003EBancontact\u003C/a\u003E is a bank redirect payment method used in Belgium."}},"blik":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[BLIK](/docs/payments/blik) is a single-use payment method common in Poland.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/blik\"\u003EBLIK\u003C/a\u003E is a single-use payment method common in Poland."}},"boleto":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Boleto](/docs/payments/boleto) is a voucher-based payment method used in Brazil.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/boleto\"\u003EBoleto\u003C/a\u003E is a voucher-based payment method used in Brazil."}},"card":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Card payments](/docs/payments/payment-methods/overview#cards) are supported through many networks and card brands.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/payment-methods/overview#cards\"\u003ECard payments\u003C/a\u003E are supported through many networks and card brands."}},"card_present":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Stripe Terminal](/docs/terminal/payments/collect-payment) is used to collect in-person card payments.","undocumented":false,"html":"\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E is used to collect in-person card payments."}},"customer_balance":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uses a customer’s [cash balance](/docs/payments/customer-balance) for the payment.","undocumented":false,"html":"Uses a customer’s \u003Ca href=\"/docs/payments/customer-balance\"\u003Ecash balance\u003C/a\u003E for the payment."}},"eps":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[EPS](/docs/payments/eps) is an Austria-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/eps\"\u003EEPS\u003C/a\u003E is an Austria-based bank redirect payment method."}},"fpx":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[FPX](/docs/payments/fpx) is a Malaysia-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/fpx\"\u003EFPX\u003C/a\u003E is a Malaysia-based bank redirect payment method."}},"giropay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[giropay](/docs/payments/giropay) is a German bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/giropay\"\u003Egiropay\u003C/a\u003E is a German bank redirect payment method."}},"grabpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[GrabPay](/docs/payments/grabpay) is a digital wallet payment method used in Southeast Asia.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/grabpay\"\u003EGrabPay\u003C/a\u003E is a digital wallet payment method used in Southeast Asia."}},"ideal":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[iDEAL](/docs/payments/ideal) is a Netherlands-based bank redirect payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/ideal\"\u003EiDEAL\u003C/a\u003E is a Netherlands-based bank redirect payment method."}},"interac_present":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Stripe Terminal](/docs/terminal/payments/collect-payment) accepts [Interac](/docs/terminal/payments/regional?integration-country=CA#interac-payments) debit cards for in-person payments in Canada.","undocumented":false,"html":"\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E accepts \u003Ca href=\"/docs/terminal/payments/regional?integration-country=CA#interac-payments\"\u003EInterac\u003C/a\u003E debit cards for in-person payments in Canada."}},"klarna":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Klarna](/docs/payments/klarna) is a global buy now, pay later payment method.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/klarna\"\u003EKlarna\u003C/a\u003E is a global buy now, pay later payment method."}},"konbini":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Konbini](/docs/payments/konbini) is a cash-based voucher payment method used in Japan.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/konbini\"\u003EKonbini\u003C/a\u003E is a cash-based voucher payment method used in Japan."}},"link":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Link](/docs/payments/link) allows customers to pay with their saved payment details.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/link\"\u003ELink\u003C/a\u003E allows customers to pay with their saved payment details."}},"oxxo":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[OXXO](/docs/payments/oxxo) is a cash-based voucher payment method used in Mexico.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/oxxo\"\u003EOXXO\u003C/a\u003E is a cash-based voucher payment method used in Mexico."}},"p24":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Przelewy24](/docs/payments/p24) is a bank redirect payment method used in Poland.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/p24\"\u003EPrzelewy24\u003C/a\u003E is a bank redirect payment method used in Poland."}},"paynow":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[PayNow](/docs/payments/paynow) is a QR code payment method used in Singapore.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/paynow\"\u003EPayNow\u003C/a\u003E is a QR code payment method used in Singapore."}},"pix":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Pix](/docs/payments/pix) is an instant bank transfer payment method in Brazil.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/pix\"\u003EPix\u003C/a\u003E is an instant bank transfer payment method in Brazil."}},"promptpay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[PromptPay](/docs/payments/promptpay) is an instant funds transfer service popular in Thailand.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/promptpay\"\u003EPromptPay\u003C/a\u003E is an instant funds transfer service popular in Thailand."}},"sepa_debit":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[SEPA Direct Debit](/docs/payments/sepa-debit) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/sepa-debit\"\u003ESEPA Direct Debit\u003C/a\u003E is used to debit bank accounts within the Single Euro Payments Area (SEPA) region."}},"sofort":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Sofort](/docs/payments/sofort) is a bank redirect payment method used in Europe.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/sofort\"\u003ESofort\u003C/a\u003E is a bank redirect payment method used in Europe."}},"us_bank_account":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[ACH Direct Debit](/docs/payments/ach-debit) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/ach-debit\"\u003EACH Direct Debit\u003C/a\u003E is used to debit US bank accounts through the Automated Clearing House (ACH) payments system."}},"wechat_pay":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[WeChat Pay](/docs/payments/wechat-pay) is a digital wallet payment method based in China.","undocumented":false,"html":"\u003Ca href=\"/docs/payments/wechat-pay\"\u003EWeChat Pay\u003C/a\u003E is a digital wallet payment method based in China."}}},"object_type":"type"},"us_bank_account":{"name":"us_bank_account","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Eus_bank_account\u003C/code\u003E PaymentMethod, this hash contains details about the US bank account payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"account_holder_type":{"name":"account_holder_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account holder type: individual or company.","undocumented":false,"html":"Account holder type: individual or company."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"individual":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account belongs to an individual","undocumented":false,"html":"Account belongs to an individual"}},"company":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account belongs to a company","undocumented":false,"html":"Account belongs to a company"}}},"object_type":"account_holder_type"},"account_type":{"name":"account_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Account type: checkings or savings. Defaults to checking if omitted.","undocumented":false,"html":"Account type: checkings or savings. Defaults to checking if omitted."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"checking":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account type is checking","undocumented":false,"html":"Bank account type is checking"}},"savings":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account type is savings","undocumented":false,"html":"Bank account type is savings"}}},"object_type":"account_type"},"bank_name":{"name":"bank_name","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The name of the bank.","undocumented":false,"html":"The name of the bank."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"bank_name"},"financial_connections_account":{"name":"financial_connections_account","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The ID of the Financial Connections Account used to create the payment method.","undocumented":false,"html":"The ID of the Financial Connections Account used to create the payment method."},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"financial_connections_account"},"fingerprint":{"name":"fingerprint","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.","undocumented":false,"html":"Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"fingerprint"},"last4":{"name":"last4","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Last four digits of the bank account number.","undocumented":false,"html":"Last four digits of the bank account number."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"last4"},"networks":{"name":"networks","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains information about US bank account networks that can be used.","undocumented":false,"html":"Contains information about US bank account networks that can be used."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"preferred":{"name":"preferred","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The preferred network.","undocumented":false,"html":"The preferred network."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"preferred"},"supported":{"name":"supported","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"All supported networks.","undocumented":false,"html":"All supported networks."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported"}},"object_type":"networks"},"routing_number":{"name":"routing_number","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Routing number of the bank account.","undocumented":false,"html":"Routing number of the bank account."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"routing_number"}},"object_type":"us_bank_account","less_common":true},"wechat_pay":{"name":"wechat_pay","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.","undocumented":false,"html":"If this is an \u003Ccode\u003Ewechat_pay\u003C/code\u003E PaymentMethod, this hash contains details about the wechat_pay payment method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"wechat_pay","less_common":true}},"object_type":"payment_method","less_common":true},"payment_method_type":{"name":"payment_method_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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.","undocumented":false,"html":"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."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_method_type","less_common":true}},"object_type":"last_setup_error"},"latest_attempt":{"name":"latest_attempt","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The most recent SetupAttempt for this SetupIntent.\n","undocumented":false,"html":"The most recent SetupAttempt for this SetupIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["setup_attempt"],"object_type":"latest_attempt","less_common":true},"livemode":{"name":"livemode","check":"boolean","validation":"boolean","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","undocumented":false,"html":"Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"livemode","less_common":true},"mandate":{"name":"mandate","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the multi use Mandate generated by the SetupIntent.\n","undocumented":false,"html":"ID of the multi use Mandate generated by the SetupIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["mandate"],"object_type":"mandate","less_common":true},"metadata":{"name":"metadata","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Set of [key-value pairs](/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.","undocumented":false,"html":"Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"metadata"},"next_action":{"name":"next_action","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If present, this property tells you what actions you need to take in order for your customer to continue payment setup.","undocumented":false,"html":"If present, this property tells you what actions you need to take in order for your customer to continue payment setup."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"redirect_to_url":{"name":"redirect_to_url","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains instructions for authenticating a payment by redirecting your customer to another page or application.","undocumented":false,"html":"Contains instructions for authenticating a payment by redirecting your customer to another page or application."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"return_url":{"name":"return_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.","undocumented":false,"html":"If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"return_url"},"url":{"name":"url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL you must redirect your customer to in order to authenticate.","undocumented":false,"html":"The URL you must redirect your customer to in order to authenticate."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"url"}},"object_type":"redirect_to_url"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.","undocumented":false,"html":"Type of the next action to perform, one of \u003Ccode\u003Eredirect_to_url\u003C/code\u003E, \u003Ccode\u003Euse_stripe_sdk\u003C/code\u003E, \u003Ccode\u003Ealipay_handle_redirect\u003C/code\u003E, \u003Ccode\u003Eoxxo_display_details\u003C/code\u003E, or \u003Ccode\u003Everify_with_microdeposits\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"type"},"use_stripe_sdk":{"name":"use_stripe_sdk","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.","undocumented":false,"html":"When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"use_stripe_sdk"},"verify_with_microdeposits":{"name":"verify_with_microdeposits","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Contains details describing microdeposits verification flow.","undocumented":false,"html":"Contains details describing microdeposits verification flow."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"arrival_date":{"name":"arrival_date","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The timestamp when the microdeposits are expected to land.","undocumented":false,"html":"The timestamp when the microdeposits are expected to land."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"arrival_date"},"hosted_verification_url":{"name":"hosted_verification_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The URL for the hosted verification page, which allows customers to verify their bank account.","undocumented":false,"html":"The URL for the hosted verification page, which allows customers to verify their bank account."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"hosted_verification_url"},"microdeposit_type":{"name":"microdeposit_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.","undocumented":false,"html":"The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"descriptor_code":{"documentation":null},"amounts":{"documentation":null}},"object_type":"microdeposit_type"}},"object_type":"verify_with_microdeposits"}},"object_type":"next_action"},"on_behalf_of":{"name":"on_behalf_of","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The account (if any) for which the setup is intended.\n","undocumented":false,"html":"The account (if any) for which the setup is intended."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"Connect only","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["account"],"object_type":"on_behalf_of","less_common":true},"payment_method":{"name":"payment_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the payment method used with this SetupIntent.","undocumented":false,"html":"ID of the payment method used with this SetupIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["payment_method"],"object_type":"payment_method"},"payment_method_options":{"name":"payment_method_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payment-method-specific configuration for this SetupIntent.","undocumented":false,"html":"Payment-method-specific configuration for this SetupIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"acss_debit":{"name":"acss_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the SetupIntent's payment_method_types includes `acss_debit`, this hash contains the configurations that will be applied to each setup attempt of that type.\n","undocumented":false,"html":"If the SetupIntent’s payment_method_types includes \u003Ccode\u003Eacss_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"currency":{"name":"currency","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Currency supported by the bank account","undocumented":false,"html":"Currency supported by the bank account"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"cad":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Canadian dollars","undocumented":false,"html":"Canadian dollars"}},"usd":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"US dollars","undocumented":false,"html":"US dollars"}}},"object_type":"currency"},"mandate_options":{"name":"mandate_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Additional fields for Mandate creation","undocumented":false,"html":"Additional fields for Mandate creation"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"custom_mandate_url":{"name":"custom_mandate_url","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A URL for custom mandate text","undocumented":false,"html":"A URL for custom mandate text"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"custom_mandate_url"},"default_for":{"name":"default_for","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"List of Stripe products where this mandate can be selected automatically.","undocumented":false,"html":"List of Stripe products where this mandate can be selected automatically."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"invoice":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Enables payments for Stripe Invoices. 'subscription' must also be provided.","undocumented":false,"html":"Enables payments for Stripe Invoices. ‘subscription’ must also be provided."}},"subscription":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Enables payments for Stripe Subscriptions. 'invoice' must also be provided.","undocumented":false,"html":"Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided."}}},"object_type":"default_for"},"interval_description":{"name":"interval_description","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.","undocumented":false,"html":"Description of the interval. Only required if the ‘payment_schedule’ parameter is ‘interval’ or ‘combined’."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval_description"},"payment_schedule":{"name":"payment_schedule","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payment schedule for the mandate.","undocumented":false,"html":"Payment schedule for the mandate."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"interval":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments are initiated at a regular pre-defined interval","undocumented":false,"html":"Payments are initiated at a regular pre-defined interval"}},"sporadic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments are initiated sporadically","undocumented":false,"html":"Payments are initiated sporadically"}},"combined":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments can be initiated at a pre-defined interval or sporadically","undocumented":false,"html":"Payments can be initiated at a pre-defined interval or sporadically"}}},"object_type":"payment_schedule"},"transaction_type":{"name":"transaction_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transaction type of the mandate.","undocumented":false,"html":"Transaction type of the mandate."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"personal":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transactions are made for personal reasons","undocumented":false,"html":"Transactions are made for personal reasons"}},"business":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Transactions are made for business reasons","undocumented":false,"html":"Transactions are made for business reasons"}}},"object_type":"transaction_type"}},"object_type":"mandate_options"},"verification_method":{"name":"verification_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account verification method.","undocumented":false,"html":"Bank account verification method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"automatic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification with fallback to microdeposits.","undocumented":false,"html":"Instant verification with fallback to microdeposits."}},"instant":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification.","undocumented":false,"html":"Instant verification."}},"microdeposits":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Verification using microdeposits.","undocumented":false,"html":"Verification using microdeposits."}}},"object_type":"verification_method"}},"object_type":"acss_debit"},"blik":{"name":"blik","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the SetupIntent's payment_method_types includes `blik`, this hash contains the configurations that will be applied to each setup attempt of that type.\n","undocumented":false,"html":"If the SetupIntent’s payment_method_types includes \u003Ccode\u003Eblik\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"mandate_options":{"name":"mandate_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Details of the reusable mandate.","undocumented":false,"html":"Details of the reusable mandate."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"expires_after":{"name":"expires_after","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Date at which the mandate expires.","undocumented":false,"html":"Date at which the mandate expires."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"expires_after"},"off_session":{"name":"off_session","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Details for off-session mandates.","undocumented":false,"html":"Details for off-session mandates."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount":{"name":"amount","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Amount of each recurring payment.","undocumented":false,"html":"Amount of each recurring payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount"},"currency":{"name":"currency","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Currency of each recurring payment.","undocumented":false,"html":"Currency of each recurring payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"currency"},"interval":{"name":"interval","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Frequency interval of each recurring payment.","undocumented":false,"html":"Frequency interval of each recurring payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"day":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments recur every day.","undocumented":false,"html":"Payments recur every day."}},"week":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments recur every week.","undocumented":false,"html":"Payments recur every week."}},"month":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments recur every month.","undocumented":false,"html":"Payments recur every month."}},"year":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Payments recur every year.","undocumented":false,"html":"Payments recur every year."}}},"object_type":"interval"},"interval_count":{"name":"interval_count","check":"integer","validation":"integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Frequency indicator of each recurring payment.","undocumented":false,"html":"Frequency indicator of each recurring payment."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval_count"}},"object_type":"off_session"},"type":{"name":"type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Type of the mandate.","undocumented":false,"html":"Type of the mandate."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"on_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Mandate for on-session payments.","undocumented":false,"html":"Mandate for on-session payments."}},"off_session":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Mandate for off-session payments.","undocumented":false,"html":"Mandate for off-session payments."}}},"object_type":"type"}},"object_type":"mandate_options"}},"object_type":"blik"},"card":{"name":"card","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the SetupIntent's payment_method_types includes `card`, this hash contains the configurations that will be applied to each setup attempt of that type.\n","undocumented":false,"html":"If the SetupIntent’s payment_method_types includes \u003Ccode\u003Ecard\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"mandate_options":{"name":"mandate_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Configuration options for setting up an eMandate for cards issued in India.","undocumented":false,"html":"Configuration options for setting up an eMandate for cards issued in India."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"amount":{"name":"amount","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Amount to be charged for future payments.","undocumented":false,"html":"Amount to be charged for future payments."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount"},"amount_type":{"name":"amount_type","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.\n","undocumented":false,"html":"One of \u003Ccode\u003Efixed\u003C/code\u003E or \u003Ccode\u003Emaximum\u003C/code\u003E. If \u003Ccode\u003Efixed\u003C/code\u003E, the \u003Ccode\u003Eamount\u003C/code\u003E param refers to the exact amount to be charged in future payments. If \u003Ccode\u003Emaximum\u003C/code\u003E, the amount charged can be up to the value passed for the \u003Ccode\u003Eamount\u003C/code\u003E param."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"amount_type"},"currency":{"name":"currency","check":"currency","validation":"currency","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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).","undocumented":false,"html":"Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"currency"},"description":{"name":"description","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A description of the mandate or subscription that is meant to be displayed to the customer.","undocumented":false,"html":"A description of the mandate or subscription that is meant to be displayed to the customer."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"description"},"end_date":{"name":"end_date","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.\n","undocumented":false,"html":"End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"end_date"},"interval":{"name":"interval","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.\n","undocumented":false,"html":"Specifies payment frequency. One of \u003Ccode\u003Eday\u003C/code\u003E, \u003Ccode\u003Eweek\u003C/code\u003E, \u003Ccode\u003Emonth\u003C/code\u003E, \u003Ccode\u003Eyear\u003C/code\u003E, or \u003Ccode\u003Esporadic\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval"},"interval_count":{"name":"interval_count","check":"positive_integer","validation":"positive integer","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.\n","undocumented":false,"html":"The number of intervals between payments. For example, \u003Ccode\u003Einterval=month\u003C/code\u003E and \u003Ccode\u003Einterval_count=3\u003C/code\u003E indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when \u003Ccode\u003Einterval=sporadic\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"interval_count"},"reference":{"name":"reference","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Unique identifier for the mandate or subscription.","undocumented":false,"html":"Unique identifier for the mandate or subscription."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"reference"},"start_date":{"name":"start_date","check":"timestamp","validation":"timestamp","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Start date of the mandate or subscription. Start date should not be lesser than yesterday.\n","undocumented":false,"html":"Start date of the mandate or subscription. Start date should not be lesser than yesterday."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"start_date"},"supported_types":{"name":"supported_types","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Specifies the type of mandates supported. Possible values are `india`.\n","undocumented":false,"html":"Specifies the type of mandates supported. Possible values are \u003Ccode\u003Eindia\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"supported_types"}},"object_type":"mandate_options"},"network":{"name":"network","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.","undocumented":false,"html":"Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"network"},"request_three_d_secure":{"name":"request_three_d_secure","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](/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](/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","undocumented":false,"html":"We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and \u003Ca href=\"/docs/strong-customer-authentication\"\u003Eother requirements\u003C/a\u003E. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: \u003Ccode\u003Eautomatic\u003C/code\u003E or \u003Ccode\u003Eany\u003C/code\u003E. If not provided, defaults to \u003Ccode\u003Eautomatic\u003C/code\u003E. Read our guide on \u003Ca href=\"/docs/payments/3d-secure#manual-three-ds\"\u003Emanually requesting 3D Secure\u003C/a\u003E for more information on how this configuration interacts with Radar and our SCA Engine."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":"advanced","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"request_three_d_secure"}},"object_type":"card"},"link":{"name":"link","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the SetupIntent's payment_method_types includes `link`, this hash contains the configurations that will be applied to each setup attempt of that type.\n","undocumented":false,"html":"If the SetupIntent’s payment_method_types includes \u003Ccode\u003Elink\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"persistent_token":{"name":"persistent_token","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Token used for persistent Link logins.","undocumented":false,"html":"Token used for persistent Link logins."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"persistent_token"}},"object_type":"link"},"sepa_debit":{"name":"sepa_debit","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the SetupIntent's payment_method_types includes `sepa_debit`, this hash contains the configurations that will be applied to each setup attempt of that type.\n","undocumented":false,"html":"If the SetupIntent’s payment_method_types includes \u003Ccode\u003Esepa_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"mandate_options":{"name":"mandate_options","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Additional fields for Mandate creation","undocumented":false,"html":"Additional fields for Mandate creation"},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{},"object_type":"mandate_options"}},"object_type":"sepa_debit"},"us_bank_account":{"name":"us_bank_account","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"If the SetupIntent's payment_method_types includes `us_bank_account`, this hash contains the configurations that will be applied to each setup attempt of that type.\n","undocumented":false,"html":"If the SetupIntent’s payment_method_types includes \u003Ccode\u003Eus_bank_account\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"financial_connections":{"name":"financial_connections","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Additional fields for Financial Connections Session creation","undocumented":false,"html":"Additional fields for Financial Connections Session creation"},"gate":true,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"subspec":{"permissions":{"name":"permissions","check":"array","validation":"array","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The list of permissions to request. The `payment_method` permission must be included.","undocumented":false,"html":"The list of permissions to request. The \u003Ccode\u003Epayment_method\u003C/code\u003E permission must be included."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"payment_method":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows the creation of a payment method from the account.","undocumented":false,"html":"Allows the creation of a payment method from the account."}},"balances":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows accessing balance data from the account.","undocumented":false,"html":"Allows accessing balance data from the account."}},"transactions":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows accessing transactions data from the account.","undocumented":false,"html":"Allows accessing transactions data from the account."}},"ownership":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Allows accessing ownership data from the account.","undocumented":false,"html":"Allows accessing ownership data from the account."}}},"object_type":"permissions"}},"object_type":"financial_connections"},"verification_method":{"name":"verification_method","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Bank account verification method.","undocumented":false,"html":"Bank account verification method."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"enum_values":{"automatic":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification with fallback to microdeposits.","undocumented":false,"html":"Instant verification with fallback to microdeposits."}},"instant":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Instant verification only.","undocumented":false,"html":"Instant verification only."}},"microdeposits":{"documentation":{"gate_specific":{},"localize_terms":[],"markdown":"Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices.","undocumented":false,"html":"Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices."}}},"object_type":"verification_method"}},"object_type":"us_bank_account"}},"object_type":"payment_method_options","less_common":true},"payment_method_types":{"name":"payment_method_types","check":"string_array","validation":"array containing strings","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.","undocumented":false,"html":"The list of payment method types (e.g. card) that this SetupIntent is allowed to set up."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"payment_method_types"},"single_use_mandate":{"name":"single_use_mandate","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"ID of the single_use Mandate generated by the SetupIntent.\n","undocumented":false,"html":"ID of the single_use Mandate generated by the SetupIntent."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"user_expandable":["mandate"],"object_type":"single_use_mandate","less_common":true},"status":{"name":"status","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"[Status](/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. ","undocumented":false,"html":"\u003Ca href=\"/docs/payments/intents#intent-statuses\"\u003EStatus\u003C/a\u003E of this SetupIntent, one of \u003Ccode\u003Erequires_payment_method\u003C/code\u003E, \u003Ccode\u003Erequires_confirmation\u003C/code\u003E, \u003Ccode\u003Erequires_action\u003C/code\u003E, \u003Ccode\u003Eprocessing\u003C/code\u003E, \u003Ccode\u003Ecanceled\u003C/code\u003E, or \u003Ccode\u003Esucceeded\u003C/code\u003E. "},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"status"},"usage":{"name":"usage","check":"string","validation":"string","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"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`.\n","undocumented":false,"html":"Indicates how the payment method is intended to be used in the future.\u003C/p\u003E\n\n\u003Cp\u003EUse \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when the customer is in your checkout flow. Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be in your checkout flow. If not provided, this value defaults to \u003Ccode\u003Eoff_session\u003C/code\u003E."},"gate":false,"hide_unset_desc":null,"required":true,"default":null,"badge_text":"retrievable with publishable key","requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"usage"}}},"source":{"name":"source","check":"hash","validation":"hash","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The source object for errors returned on a request involving a source.","undocumented":false,"html":"The source object for errors returned on a request involving a source."},"gate":false,"hide_unset_desc":null,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"includable":null,"object_type":"source","less_common":true}},"status_codes":{"200 - OK":"Everything worked as expected.","400 - Bad Request":"The request was unacceptable, often due to missing a required\n parameter.","401 - Unauthorized":"No valid API key provided.","402 - Request Failed":"The parameters were valid but the request failed.","403 - Forbidden":"The API key doesn't have permissions to perform the request.","404 - Not Found":"The requested resource doesn't exist.","409 - Conflict":"The request conflicts with another request (perhaps due to\n using the same idempotent key).","429 - Too Many Requests":"Too many requests hit the API too quickly. We recommend an\n exponential backoff of your requests.","500, 502, 503, 504 - Server Errors":"Something went wrong on Stripe's end. (These are rare.)"},"error_types":{"api_error":"API errors cover any other type of problem (e.g., a temporary\n problem with Stripe's servers), and are extremely\n uncommon.","card_error":"Card errors are the most common type of error you should\n expect to handle. They result when the user enters a card that\n can't be charged for some reason.","idempotency_error":"Idempotency errors occur when an `Idempotency-Key`\n is re-used on a request that does not match the first request's\n API endpoint and parameters.","invalid_request_error":"Invalid request errors arise when your request has invalid\n parameters."},"section_type":"override","section_tag":"errors","version":null}},"error_handling":{"title":"Handling errors","group_title":"Topics","group_anchor":"topics","anchor":"error_handling","section_anchor":"errors","subsection_anchors":null,"path":"/errors/handling","gate":false,"display_on_load":true,"data":{"catching_errors":"# Select a client library to see examples of handling different kinds of errors.","section_type":"override","section_tag":"error_handling","version":null}},"expanding_objects":{"title":"Expanding Responses","group_title":"Topics","group_anchor":"topics","anchor":"expanding_objects","section_anchor":"expanding_objects","subsection_anchors":[],"path":"/expanding_objects","gate":false,"display_on_load":true,"data":{"request":"curl https://api.stripe.com/v1/charges/ch_3Mik892eZvKYlo2C1PpFTUfK \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -d \"expand[]\"=customer \\\n -d \"expand[]\"=\"invoice.subscription\" \\\n -G \n","response":"{\n \"id\": \"ch_3Mik892eZvKYlo2C1PpFTUfK\",\n \"object\": \"charge\",\n \"customer\": {\n \"id\": \"cu_14HOtK2eZvKYlo2CPM0hlYU6\",\n \"object\": \"customer\",\n ...\n },\n \"invoice\": {\n \"id\": \"in_1Mik892eZvKYlo2C6e4R3n4D\",\n \"object\": \"invoice\",\n \"subscription\": {\n \"id\": \"su_1MihCv2eZvKYlo2Cu6plHncm\",\n \"object\": \"subscription\",\n ...\n },\n ...\n },\n ...\n}\n","section_type":"override","section_tag":"expanding_objects","version":null}},"idempotent_requests":{"title":"Idempotent Requests","group_title":"Topics","group_anchor":"topics","anchor":"idempotent_requests","section_anchor":"idempotent_requests","subsection_anchors":[],"path":"/idempotent_requests","gate":false,"display_on_load":true,"data":{"request":"curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -H \"Idempotency-Key: ouFLBvhzM9XtR0C0\" \\\n -d amount=2000 \\\n -d currency=usd \\\n -d description=\"My First Test Charge (created for API docs at https://www.stripe.com/docs/api)\" \\\n -d source=tok_amex\n","section_type":"override","section_tag":"idempotent_requests","version":null}},"metadata":{"title":"Metadata","group_title":"Topics","group_anchor":"topics","anchor":"metadata","section_anchor":"metadata","subsection_anchors":[],"path":"/metadata","gate":false,"display_on_load":true,"data":{"max_metadata_hash_length":50,"max_metadata_key_length":40,"max_metadata_val_length":500,"request":"curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -d amount=2000 \\\n -d currency=usd \\\n -d source=tok_visa \\\n -d \"metadata[order_id]\"=6735\n","response":"{\n \"id\": \"ch_3Mik892eZvKYlo2C1PpFTUfK\",\n \"object\": \"charge\",\n \"amount\": 100,\n \"amount_captured\": 0,\n \"amount_refunded\": 0,\n \"application\": null,\n \"application_fee\": null,\n \"application_fee_amount\": null,\n \"balance_transaction\": \"txn_1032HU2eZvKYlo2CEPtcnUvl\",\n \"billing_details\": {\n \"address\": {\n \"city\": null,\n \"country\": null,\n \"line1\": null,\n \"line2\": null,\n \"postal_code\": null,\n \"state\": null\n },\n \"email\": null,\n \"name\": \"Jenny Rosen\",\n \"phone\": null\n },\n \"calculated_statement_descriptor\": null,\n \"captured\": false,\n \"created\": 1678132533,\n \"currency\": \"usd\",\n \"customer\": null,\n \"description\": \"My First Test Charge (created for API docs)\",\n \"disputed\": false,\n \"failure_balance_transaction\": null,\n \"failure_code\": null,\n \"failure_message\": null,\n \"fraud_details\": {\n },\n \"invoice\": null,\n \"livemode\": false,\n \"metadata\": {\n \"order_id\": \"6735\"\n },\n \"on_behalf_of\": null,\n \"outcome\": null,\n \"paid\": true,\n \"payment_intent\": null,\n \"payment_method\": \"card_19yUNL2eZvKYlo2CNGsN6EWH\",\n \"payment_method_details\": {\n \"card\": {\n \"brand\": \"visa\",\n \"checks\": {\n \"address_line1_check\": null,\n \"address_postal_code_check\": null,\n \"cvc_check\": \"unchecked\"\n },\n \"country\": \"US\",\n \"exp_month\": 12,\n \"exp_year\": 2020,\n \"fingerprint\": \"Xt5EWLLDS7FJjR1c\",\n \"funding\": \"credit\",\n \"installments\": null,\n \"last4\": \"4242\",\n \"mandate\": null,\n \"moto\": null,\n \"network\": \"visa\",\n \"three_d_secure\": null,\n \"wallet\": null\n },\n \"type\": \"card\"\n },\n \"receipt_email\": null,\n \"receipt_number\": null,\n \"receipt_url\": \"https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKLWKmaAGMgbi8srRiIc6LBb_Gl7ONY6nM3pN9__h6y8_JcMHRQI4GIqBjXuFW-2D2qAiU4S8k7hU0SQw\",\n \"redaction\": null,\n \"refunded\": false,\n \"refunds\": {\n \"object\": \"list\",\n \"data\": [\n\n ],\n \"has_more\": false,\n \"url\": \"/v1/charges/ch_3Mik892eZvKYlo2C1PpFTUfK/refunds\"\n },\n \"review\": null,\n \"shipping\": null,\n \"source_transfer\": null,\n \"statement_descriptor\": null,\n \"statement_descriptor_suffix\": null,\n \"status\": \"succeeded\",\n \"transfer_data\": null,\n \"transfer_group\": null\n}","section_type":"override","section_tag":"metadata","version":null}},"pagination":{"title":"Pagination","group_title":"Topics","group_anchor":"topics","anchor":"pagination","section_anchor":"pagination","subsection_anchors":["search_pagination","auto_pagination"],"path":"/pagination","gate":false,"display_on_load":true,"data":{"example_auto_pagination":"# The auto-pagination feature is specific to Stripe's\n # libraries and cannot be used directly with curl.\n","request_data":{"test_key":"sk_test_4eC39HqLyjWDarjtT1zdp7dc","action_type":"list","action_name":null,"action_path":null,"resource_name":"customer","parent_resource_name":null,"namespace":null,"test_helper":false,"request_params":{"limit":3},"url_params":{},"overridden_languages":[],"preamble_comment":null},"response":"{\n \"object\": \"list\",\n \"url\": \"/v1/customers\",\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"cus_4QFOF3xrvBT2nU\",\n \"object\": \"customer\",\n \"address\": {\n \"city\": \"City9debc82d-10b2-42e2-87ec-3316c9e7acc5\",\n \"country\": \"Country2bde78f1-d28b-4c80-8e99-836828661c29\",\n \"line1\": \"Line136e8abc0-92e2-4b91-aa83-b07ee5305ef0\",\n \"line2\": \"Line2139281af-fd20-4e7e-8a99-2a09c32dbe1e\",\n \"postal_code\": \"PostalCode190108c3-177d-4b5c-9c5a-89ef946e36b5\",\n \"state\": \"State8618eae4-ad11-4577-b227-ae6667c2e41e\"\n },\n \"balance\": 0,\n \"created\": 1405641986,\n \"currency\": \"usd\",\n \"default_source\": \"card_14HOtJ2eZvKYlo2CD2lt4r4W\",\n \"delinquent\": false,\n \"description\": \"someone@example.com for Coderwall\",\n \"discount\": null,\n \"email\": \"namee97851f5-1cf1-48f6-b694-497e641661e8@test.com\",\n \"invoice_prefix\": \"93EC0E1\",\n \"invoice_settings\": {\n \"custom_fields\": null,\n \"default_payment_method\": \"pm_1MWFdw2eZvKYlo2CvWcM1Btd\",\n \"footer\": null,\n \"rendering_options\": null\n },\n \"livemode\": false,\n \"metadata\": {\n \"CustomerReferenceId\": \"16527612\",\n \"CustomerReferenceType\": \"reedonline\",\n \"tag-key\": \"tag-value\",\n \"meta-key\": \"meta-value\",\n \"order_id\": \"6735\",\n \"order_id_1\": \"6735\",\n \"email\": \"test@test.com\",\n \"adress\": \"testadress\",\n \"address\": \"testadress\",\n \"Address\": \"testadress\",\n \"order_id2\": \"6735\"\n },\n \"name\": \"namee97851f5-1cf1-48f6-b694-497e641661e8\",\n \"next_invoice_sequence\": 932993,\n \"phone\": null,\n \"preferred_locales\": [\n \n ],\n \"shipping\": null,\n \"tax_exempt\": \"none\",\n \"test_clock\": null\n },\n {...},\n {...}\n ]\n}\n","section_type":"override","section_tag":"pagination","version":null}},"search_pagination":{"title":"Search","group_title":"Topics","group_anchor":"topics","anchor":"search_pagination","section_anchor":"pagination","subsection_anchors":null,"path":"/pagination/search","gate":false,"display_on_load":true,"data":{"section_type":"override","title":"Search customers","description":"Search for customers you’ve previously created using Stripe’s \u003Ca href=\"/docs/search#search-query-language\"\u003ESearch Query Language\u003C/a\u003E.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.","top_level_changes":[],"changes":{},"version":null,"returns":"A dictionary with a \u003Ccode\u003Edata\u003C/code\u003E property that contains an array of up to \u003Ccode\u003Elimit\u003C/code\u003E customers. If no objects match the\nquery, the resulting array will be empty. See the related guide on \u003Ca href=\"/docs/expand#lists\"\u003Eexpanding properties in lists\u003C/a\u003E.","section_tag":"search_pagination","specs":{"query":{"name":"query","check":null,"validation":"","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"The search query string. See [search query language](/docs/search#search-query-language) and the list of supported [query fields for customers](/docs/search#query-fields-for-customers).","undocumented":false,"html":"The search query string. See \u003Ca href=\"/docs/search#search-query-language\"\u003Esearch query language\u003C/a\u003E and the list of supported \u003Ca href=\"/docs/search#query-fields-for-customers\"\u003Equery fields for customers\u003C/a\u003E."},"gate":false,"hide_unset_desc":false,"required":true,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"deprecated_allow_empty":false,"object_type":"query"},"limit":{"name":"limit","check":null,"validation":"","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","undocumented":false,"html":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."},"gate":false,"hide_unset_desc":false,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"object_type":"limit"},"page":{"name":"page","check":null,"validation":"","documentation":{"gate_specific":{},"localize_terms":[],"markdown":"A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.","undocumented":false,"html":"A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results."},"gate":false,"hide_unset_desc":false,"required":false,"default":null,"badge_text":null,"requirement_text":null,"permission":null,"hide_nil":null,"is_country_specific":false,"deprecated_allow_empty":false,"object_type":"page"}},"supported_languages":null,"action":"method","curl_definition":"GET /v1/customers/search","request":"curl https://api.stripe.com/v1/customers/search \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n --data-urlencode query=\"name:'fakename' AND metadata['foo']:'bar'\" \\\n -G\n","request_data":{"test_key":"sk_test_4eC39HqLyjWDarjtT1zdp7dc","action_type":"custom","action_name":"search","action_path":"search","resource_name":"customer","parent_resource_name":null,"namespace":null,"test_helper":false,"request_params":{"query":"name:'fakename' AND metadata['foo']:'bar'"},"url_params":{},"overridden_languages":["curl","java","go"],"preamble_comment":null},"response":"{\n \"object\": \"search_result\",\n \"url\": \"/v1/customers/search\",\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"cus_4QFOF3xrvBT2nU\",\n \"object\": \"customer\",\n \"address\": {\n \"city\": \"City9debc82d-10b2-42e2-87ec-3316c9e7acc5\",\n \"country\": \"Country2bde78f1-d28b-4c80-8e99-836828661c29\",\n \"line1\": \"Line136e8abc0-92e2-4b91-aa83-b07ee5305ef0\",\n \"line2\": \"Line2139281af-fd20-4e7e-8a99-2a09c32dbe1e\",\n \"postal_code\": \"PostalCode190108c3-177d-4b5c-9c5a-89ef946e36b5\",\n \"state\": \"State8618eae4-ad11-4577-b227-ae6667c2e41e\"\n },\n \"balance\": 0,\n \"created\": 1405641986,\n \"currency\": \"usd\",\n \"default_source\": \"card_14HOtJ2eZvKYlo2CD2lt4r4W\",\n \"delinquent\": false,\n \"description\": \"someone@example.com for Coderwall\",\n \"discount\": null,\n \"email\": \"namee97851f5-1cf1-48f6-b694-497e641661e8@test.com\",\n \"invoice_prefix\": \"93EC0E1\",\n \"invoice_settings\": {\n \"custom_fields\": null,\n \"default_payment_method\": \"pm_1MWFdw2eZvKYlo2CvWcM1Btd\",\n \"footer\": null,\n \"rendering_options\": null\n },\n \"livemode\": false,\n \"metadata\": {\n \"foo\": \"bar\"\n },\n \"name\": \"fakename\",\n \"next_invoice_sequence\": 932993,\n \"phone\": null,\n \"preferred_locales\": [\n \n ],\n \"shipping\": null,\n \"tax_exempt\": \"none\",\n \"test_clock\": null\n },\n {...},\n {...}\n ]\n}\n"}},"auto_pagination":{"title":"Auto-pagination","group_title":"Topics","group_anchor":"topics","anchor":"auto_pagination","section_anchor":"pagination","subsection_anchors":null,"path":"/pagination/auto","gate":false,"display_on_load":true,"data":{"request":"# The auto-pagination feature is specific to Stripe's\n # libraries and cannot be used directly with curl.\n","section_type":"override","section_tag":"auto_pagination","version":null}},"request_ids":{"title":"Request IDs","group_title":"Topics","group_anchor":"topics","anchor":"request_ids","section_anchor":"request_ids","subsection_anchors":[],"path":"/request_ids","gate":false,"display_on_load":true,"data":{"request":"curl https://api.stripe.com/v1/customers \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -D \"-\" \\\n -X POST\n","section_type":"override","section_tag":"request_ids","version":null}},"versioning":{"title":"Versioning","group_title":"Topics","group_anchor":"topics","anchor":"versioning","section_anchor":"versioning","subsection_anchors":[],"path":"/versioning","gate":false,"display_on_load":true,"data":{"current_version":"2022-11-15","example_version_on_request":"","merchant":false,"request":"curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -H \"Stripe-Version: 2022-11-15\"\n","section_type":"override","section_tag":"versioning","version":null}},"balance":{"title":"Balance","group_title":"Core Resources","group_anchor":"core_resources","anchor":"balance","section_anchor":"balance","subsection_anchors":["balance_object","retrieve_balance"],"path":"/balance","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Balance","description":"This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect Account Balances](/docs/connect/account-balances).\n","section_tag":"balance","subsection_summaries":[{"anchor":"balance_object","curl_definition":null},{"anchor":"retrieve_balance","curl_definition":"GET /v1/balance"}]}},"balance_object":{"title":"The balance object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"balance_object","section_anchor":"balance","subsection_anchors":null,"path":"/balance/balance_object","gate":false,"display_on_load":false},"retrieve_balance":{"title":"Retrieve balance","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_balance","section_anchor":"balance","subsection_anchors":null,"path":"/balance/balance_retrieve","gate":false,"display_on_load":false},"balance_transactions":{"title":"Balance Transactions","group_title":"Core Resources","group_anchor":"core_resources","anchor":"balance_transactions","section_anchor":"balance_transactions","subsection_anchors":["balance_transaction_object","balance_transaction_retrieve","balance_transaction_list"],"path":"/balance_transactions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Balance Transactions","description":"Balance transactions represent funds moving through your Stripe account.\nThey're created for every type of transaction that comes into or flows out of your Stripe account balance.\n\nRelated guide: [Balance Transaction Types](/docs/reports/balance-transaction-types).\n","section_tag":"balance_transactions","subsection_summaries":[{"anchor":"balance_transaction_object","curl_definition":null},{"anchor":"balance_transaction_retrieve","curl_definition":"GET /v1/balance_transactions/:id"},{"anchor":"balance_transaction_list","curl_definition":"GET /v1/balance_transactions"}]}},"balance_transaction_object":{"title":"The balance transaction object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"balance_transaction_object","section_anchor":"balance_transactions","subsection_anchors":null,"path":"/balance_transactions/object","gate":false,"display_on_load":false},"balance_transaction_retrieve":{"title":"Retrieve a balance transaction","group_title":"Core Resources","group_anchor":"core_resources","anchor":"balance_transaction_retrieve","section_anchor":"balance_transactions","subsection_anchors":null,"path":"/balance_transactions/retrieve","gate":false,"display_on_load":false},"balance_transaction_list":{"title":"List all balance transactions","group_title":"Core Resources","group_anchor":"core_resources","anchor":"balance_transaction_list","section_anchor":"balance_transactions","subsection_anchors":null,"path":"/balance_transactions/list","gate":false,"display_on_load":false},"charges":{"title":"Charges","group_title":"Core Resources","group_anchor":"core_resources","anchor":"charges","section_anchor":"charges","subsection_anchors":["charge_object","create_charge","retrieve_charge","update_charge","capture_charge","list_charges","search_charges"],"path":"/charges","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Charges","description":"To charge a credit or a debit card, you create a `Charge` object. You can\nretrieve and refund individual charges as well as list all charges. Charges\nare identified by a unique, random ID.\n\nRelated guide: [Accept a payment with the Charges API](/docs/payments/accept-a-payment-charges).\n","section_tag":"charges","subsection_summaries":[{"anchor":"charge_object","curl_definition":null},{"anchor":"create_charge","curl_definition":"POST /v1/charges"},{"anchor":"retrieve_charge","curl_definition":"GET /v1/charges/:id"},{"anchor":"update_charge","curl_definition":"POST /v1/charges/:id"},{"anchor":"capture_charge","curl_definition":"POST /v1/charges/:id/capture"},{"anchor":"list_charges","curl_definition":"GET /v1/charges"},{"anchor":"search_charges","curl_definition":"GET /v1/charges/search"}]}},"charge_object":{"title":"The charge object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"charge_object","section_anchor":"charges","subsection_anchors":null,"path":"/charges/object","gate":false,"display_on_load":false},"create_charge":{"title":"Create a charge","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_charge","section_anchor":"charges","subsection_anchors":null,"path":"/charges/create","gate":false,"display_on_load":false},"retrieve_charge":{"title":"Retrieve a charge","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_charge","section_anchor":"charges","subsection_anchors":null,"path":"/charges/retrieve","gate":false,"display_on_load":false},"update_charge":{"title":"Update a charge","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_charge","section_anchor":"charges","subsection_anchors":null,"path":"/charges/update","gate":false,"display_on_load":false},"capture_charge":{"title":"Capture a charge","group_title":"Core Resources","group_anchor":"core_resources","anchor":"capture_charge","section_anchor":"charges","subsection_anchors":null,"path":"/charges/capture","gate":false,"display_on_load":false},"list_charges":{"title":"List all charges","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_charges","section_anchor":"charges","subsection_anchors":null,"path":"/charges/list","gate":false,"display_on_load":false},"search_charges":{"title":"Search charges","group_title":"Core Resources","group_anchor":"core_resources","anchor":"search_charges","section_anchor":"charges","subsection_anchors":null,"path":"/charges/search","gate":false,"display_on_load":false},"customers":{"title":"Customers","group_title":"Core Resources","group_anchor":"core_resources","anchor":"customers","section_anchor":"customers","subsection_anchors":["customer_object","create_customer","retrieve_customer","update_customer","delete_customer","list_customers","search_customers"],"path":"/customers","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Customers","description":"This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](/docs/payments/save-during-payment).\n","section_tag":"customers","subsection_summaries":[{"anchor":"customer_object","curl_definition":null},{"anchor":"create_customer","curl_definition":"POST /v1/customers"},{"anchor":"retrieve_customer","curl_definition":"GET /v1/customers/:id"},{"anchor":"update_customer","curl_definition":"POST /v1/customers/:id"},{"anchor":"delete_customer","curl_definition":"DELETE /v1/customers/:id"},{"anchor":"list_customers","curl_definition":"GET /v1/customers"},{"anchor":"search_customers","curl_definition":"GET /v1/customers/search"}]}},"customer_object":{"title":"The customer object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"customer_object","section_anchor":"customers","subsection_anchors":null,"path":"/customers/object","gate":false,"display_on_load":false},"create_customer":{"title":"Create a customer","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_customer","section_anchor":"customers","subsection_anchors":null,"path":"/customers/create","gate":false,"display_on_load":false},"retrieve_customer":{"title":"Retrieve a customer","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_customer","section_anchor":"customers","subsection_anchors":null,"path":"/customers/retrieve","gate":false,"display_on_load":false},"update_customer":{"title":"Update a customer","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_customer","section_anchor":"customers","subsection_anchors":null,"path":"/customers/update","gate":false,"display_on_load":false},"delete_customer":{"title":"Delete a customer","group_title":"Core Resources","group_anchor":"core_resources","anchor":"delete_customer","section_anchor":"customers","subsection_anchors":null,"path":"/customers/delete","gate":false,"display_on_load":false},"list_customers":{"title":"List all customers","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_customers","section_anchor":"customers","subsection_anchors":null,"path":"/customers/list","gate":false,"display_on_load":false},"search_customers":{"title":"Search customers","group_title":"Core Resources","group_anchor":"core_resources","anchor":"search_customers","section_anchor":"customers","subsection_anchors":null,"path":"/customers/search","gate":false,"display_on_load":false},"disputes":{"title":"Disputes","group_title":"Core Resources","group_anchor":"core_resources","anchor":"disputes","section_anchor":"disputes","subsection_anchors":["dispute_object","dispute_evidence_object","retrieve_dispute","update_dispute","close_dispute","list_disputes"],"path":"/disputes","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Disputes","description":"A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you're given the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate. You can find more\ninformation about the dispute process in our [Disputes and\nFraud](/docs/disputes) documentation.\n\nRelated guide: [Disputes and Fraud](/docs/disputes).\n","section_tag":"disputes","subsection_summaries":[{"anchor":"dispute_object","curl_definition":null},{"anchor":"dispute_evidence_object","curl_definition":null},{"anchor":"retrieve_dispute","curl_definition":"GET /v1/disputes/:id"},{"anchor":"update_dispute","curl_definition":"POST /v1/disputes/:id"},{"anchor":"close_dispute","curl_definition":"POST /v1/disputes/:id/close"},{"anchor":"list_disputes","curl_definition":"GET /v1/disputes"}]}},"dispute_object":{"title":"The dispute object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"dispute_object","section_anchor":"disputes","subsection_anchors":null,"path":"/disputes/object","gate":false,"display_on_load":false},"dispute_evidence_object":{"title":"The dispute evidence object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"dispute_evidence_object","section_anchor":"disputes","subsection_anchors":null,"path":"/disputes/evidence_object","gate":false,"display_on_load":false},"retrieve_dispute":{"title":"Retrieve a dispute","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_dispute","section_anchor":"disputes","subsection_anchors":null,"path":"/disputes/retrieve","gate":false,"display_on_load":false},"update_dispute":{"title":"Update a dispute","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_dispute","section_anchor":"disputes","subsection_anchors":null,"path":"/disputes/update","gate":false,"display_on_load":false},"close_dispute":{"title":"Close a dispute","group_title":"Core Resources","group_anchor":"core_resources","anchor":"close_dispute","section_anchor":"disputes","subsection_anchors":null,"path":"/disputes/close","gate":false,"display_on_load":false},"list_disputes":{"title":"List all disputes","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_disputes","section_anchor":"disputes","subsection_anchors":null,"path":"/disputes/list","gate":false,"display_on_load":false},"events":{"title":"Events","group_title":"Core Resources","group_anchor":"core_resources","anchor":"events","section_anchor":"events","subsection_anchors":["event_object","retrieve_event","list_events","event_types"],"path":"/events","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Events","description":"Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent; and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Note that many API requests may cause multiple\nevents to be created. For example, if you create a new subscription for a\ncustomer, you will receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The state of that\nresource at the time of the change is embedded in the event's data field. For\nexample, a `charge.succeeded` event will contain a charge, and an\n`invoice.payment_failed` event will contain an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](#retrieve_event) or a [list of events](#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. Webhooks are managed\nin your\n[account settings](https://dashboard.stripe.com/account/webhooks),\nand our [Using Webhooks](/docs/webhooks) guide will help you get set up.\n\nWhen using [Connect](/docs/connect), you can also receive notifications of\nevents that occur in connected accounts. For these events, there will be an\nadditional `account` attribute in the received `Event` object.\n\n**NOTE:** Right now, access to events through the [Retrieve Event API](#retrieve_event) is\nguaranteed only for 30 days.\n","section_tag":"events","subsection_summaries":[{"anchor":"event_object","curl_definition":null},{"anchor":"retrieve_event","curl_definition":"GET /v1/events/:id"},{"anchor":"list_events","curl_definition":"GET /v1/events"},{"anchor":"event_types","curl_definition":null}]}},"event_object":{"title":"The event object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"event_object","section_anchor":"events","subsection_anchors":null,"path":"/events/object","gate":false,"display_on_load":false},"retrieve_event":{"title":"Retrieve an event","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_event","section_anchor":"events","subsection_anchors":null,"path":"/events/retrieve","gate":false,"display_on_load":false},"list_events":{"title":"List all events","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_events","section_anchor":"events","subsection_anchors":null,"path":"/events/list","gate":false,"display_on_load":false},"event_types":{"title":"Types of events","group_title":"Core Resources","group_anchor":"core_resources","anchor":"event_types","section_anchor":"events","subsection_anchors":null,"path":"/events/types","gate":false,"display_on_load":false},"files":{"title":"Files","group_title":"Core Resources","group_anchor":"core_resources","anchor":"files","section_anchor":"files","subsection_anchors":["file_object","create_file","retrieve_file","list_files"],"path":"/files","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Files","description":"This is an object representing a file hosted on Stripe's servers. The\nfile may have been uploaded by yourself using the [create file](#create_file)\nrequest (for example, when uploading dispute evidence) or it may have\nbeen created by Stripe (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File Upload Guide](/docs/file-upload).\n","section_tag":"files","subsection_summaries":[{"anchor":"file_object","curl_definition":null},{"anchor":"create_file","curl_definition":"POST https://files.stripe.com/v1/files"},{"anchor":"retrieve_file","curl_definition":"GET /v1/files/:id"},{"anchor":"list_files","curl_definition":"GET /v1/files"}]}},"file_object":{"title":"The file object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"file_object","section_anchor":"files","subsection_anchors":null,"path":"/files/object","gate":false,"display_on_load":false},"create_file":{"title":"Create a file","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_file","section_anchor":"files","subsection_anchors":null,"path":"/files/create","gate":false,"display_on_load":false},"retrieve_file":{"title":"Retrieve a file","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_file","section_anchor":"files","subsection_anchors":null,"path":"/files/retrieve","gate":false,"display_on_load":false},"list_files":{"title":"List all files","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_files","section_anchor":"files","subsection_anchors":null,"path":"/files/list","gate":false,"display_on_load":false},"file_links":{"title":"File Links","group_title":"Core Resources","group_anchor":"core_resources","anchor":"file_links","section_anchor":"file_links","subsection_anchors":["file_link_object","create_file_link","retrieve_file_link","update_file_link","list_file_links"],"path":"/file_links","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"File Links","description":"To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that can be used to\nretrieve the contents of the file without authentication.\n","section_tag":"file_links","subsection_summaries":[{"anchor":"file_link_object","curl_definition":null},{"anchor":"create_file_link","curl_definition":"POST /v1/file_links"},{"anchor":"retrieve_file_link","curl_definition":"GET /v1/file_links/:id"},{"anchor":"update_file_link","curl_definition":"POST /v1/file_links/:id"},{"anchor":"list_file_links","curl_definition":"GET /v1/file_links"}]}},"file_link_object":{"title":"The file link object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"file_link_object","section_anchor":"file_links","subsection_anchors":null,"path":"/file_links/object","gate":false,"display_on_load":false},"create_file_link":{"title":"Create a file link","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_file_link","section_anchor":"file_links","subsection_anchors":null,"path":"/file_links/create","gate":false,"display_on_load":false},"retrieve_file_link":{"title":"Retrieve a file link","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_file_link","section_anchor":"file_links","subsection_anchors":null,"path":"/file_links/retrieve","gate":false,"display_on_load":false},"update_file_link":{"title":"Update a file link","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_file_link","section_anchor":"file_links","subsection_anchors":null,"path":"/file_links/update","gate":false,"display_on_load":false},"list_file_links":{"title":"List all file links","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_file_links","section_anchor":"file_links","subsection_anchors":null,"path":"/file_links/list","gate":false,"display_on_load":false},"mandates":{"title":"Mandates","group_title":"Core Resources","group_anchor":"core_resources","anchor":"mandates","section_anchor":"mandates","subsection_anchors":["mandate_object","retrieve_mandate"],"path":"/mandates","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Mandates","description":"A Mandate is a record of the permission a customer has given you to debit their payment method.\n","section_tag":"mandates","subsection_summaries":[{"anchor":"mandate_object","curl_definition":null},{"anchor":"retrieve_mandate","curl_definition":"GET /v1/mandates/:id"}]}},"mandate_object":{"title":"The Mandates object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"mandate_object","section_anchor":"mandates","subsection_anchors":null,"path":"/mandates/object","gate":false,"display_on_load":false},"retrieve_mandate":{"title":"Retrieve a Mandate","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_mandate","section_anchor":"mandates","subsection_anchors":null,"path":"/mandates/retrieve","gate":false,"display_on_load":false},"payment_intents":{"title":"PaymentIntents","group_title":"Core Resources","group_anchor":"core_resources","anchor":"payment_intents","section_anchor":"payment_intents","subsection_anchors":["payment_intent_object","create_payment_intent","retrieve_payment_intent","update_payment_intent","confirm_payment_intent","capture_payment_intent","cancel_payment_intent","list_payment_intents","increment_authorization","search_payment_intents","verify_microdeposits_payment_intent","apply_customer_balance"],"path":"/payment_intents","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"PaymentIntents","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](/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](/docs/payments/payment-intents).\n","section_tag":"payment_intents","subsection_summaries":[{"anchor":"payment_intent_object","curl_definition":null},{"anchor":"create_payment_intent","curl_definition":"POST /v1/payment_intents"},{"anchor":"retrieve_payment_intent","curl_definition":"GET /v1/payment_intents/:id"},{"anchor":"update_payment_intent","curl_definition":"POST /v1/payment_intents/:id"},{"anchor":"confirm_payment_intent","curl_definition":"POST /v1/payment_intents/:id/confirm"},{"anchor":"capture_payment_intent","curl_definition":"POST /v1/payment_intents/:id/capture"},{"anchor":"cancel_payment_intent","curl_definition":"POST /v1/payment_intents/:id/cancel"},{"anchor":"list_payment_intents","curl_definition":"GET /v1/payment_intents"},{"anchor":"increment_authorization","curl_definition":"POST /v1/payment_intents/:id/increment_authorization"},{"anchor":"search_payment_intents","curl_definition":"GET /v1/payment_intents/search"},{"anchor":"verify_microdeposits_payment_intent","curl_definition":"POST /v1/payment_intents/:id/verify_microdeposits"},{"anchor":"apply_customer_balance","curl_definition":"POST /v1/payment_intents/:id/apply_customer_balance"}]}},"payment_intent_object":{"title":"The PaymentIntent object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"payment_intent_object","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/object","gate":false,"display_on_load":false},"create_payment_intent":{"title":"Create a PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_payment_intent","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/create","gate":false,"display_on_load":false},"retrieve_payment_intent":{"title":"Retrieve a PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_payment_intent","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/retrieve","gate":false,"display_on_load":false},"update_payment_intent":{"title":"Update a PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_payment_intent","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/update","gate":false,"display_on_load":false},"confirm_payment_intent":{"title":"Confirm a PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"confirm_payment_intent","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/confirm","gate":false,"display_on_load":false},"capture_payment_intent":{"title":"Capture a PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"capture_payment_intent","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/capture","gate":false,"display_on_load":false},"cancel_payment_intent":{"title":"Cancel a PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"cancel_payment_intent","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/cancel","gate":false,"display_on_load":false},"list_payment_intents":{"title":"List all PaymentIntents","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_payment_intents","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/list","gate":false,"display_on_load":false},"increment_authorization":{"title":"Increment an authorization","group_title":"Core Resources","group_anchor":"core_resources","anchor":"increment_authorization","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/increment_authorization","gate":false,"display_on_load":false},"search_payment_intents":{"title":"Search PaymentIntents","group_title":"Core Resources","group_anchor":"core_resources","anchor":"search_payment_intents","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/search","gate":false,"display_on_load":false},"verify_microdeposits_payment_intent":{"title":"Verify microdeposits on a PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"verify_microdeposits_payment_intent","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/verify_microdeposits","gate":false,"display_on_load":false},"apply_customer_balance":{"title":"Reconcile a customer_balance PaymentIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"apply_customer_balance","section_anchor":"payment_intents","subsection_anchors":null,"path":"/payment_intents/apply_customer_balance","gate":false,"display_on_load":false},"setup_intents":{"title":"SetupIntents","group_title":"Core Resources","group_anchor":"core_resources","anchor":"setup_intents","section_anchor":"setup_intents","subsection_anchors":["setup_intent_object","create_setup_intent","retrieve_setup_intent","update_setup_intent","confirm_setup_intent","cancel_setup_intent","list_setup_intents","verify_microdeposits_setup_intent"],"path":"/setup_intents","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"SetupIntents","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](#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](/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](/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](#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](#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](/docs/payments/setup-intents).\n","section_tag":"setup_intents","subsection_summaries":[{"anchor":"setup_intent_object","curl_definition":null},{"anchor":"create_setup_intent","curl_definition":"POST /v1/setup_intents"},{"anchor":"retrieve_setup_intent","curl_definition":"GET /v1/setup_intents/:id"},{"anchor":"update_setup_intent","curl_definition":"POST /v1/setup_intents/:id"},{"anchor":"confirm_setup_intent","curl_definition":"POST /v1/setup_intents/:id/confirm"},{"anchor":"cancel_setup_intent","curl_definition":"POST /v1/setup_intents/:id/cancel"},{"anchor":"list_setup_intents","curl_definition":"GET /v1/setup_intents"},{"anchor":"verify_microdeposits_setup_intent","curl_definition":"POST /v1/setup_intents/:id/verify_microdeposits"}]}},"setup_intent_object":{"title":"The SetupIntent object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"setup_intent_object","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/object","gate":false,"display_on_load":false},"create_setup_intent":{"title":"Create a SetupIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_setup_intent","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/create","gate":false,"display_on_load":false},"retrieve_setup_intent":{"title":"Retrieve a SetupIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_setup_intent","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/retrieve","gate":false,"display_on_load":false},"update_setup_intent":{"title":"Update a SetupIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_setup_intent","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/update","gate":false,"display_on_load":false},"confirm_setup_intent":{"title":"Confirm a SetupIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"confirm_setup_intent","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/confirm","gate":false,"display_on_load":false},"cancel_setup_intent":{"title":"Cancel a SetupIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"cancel_setup_intent","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/cancel","gate":false,"display_on_load":false},"list_setup_intents":{"title":"List all SetupIntents","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_setup_intents","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/list","gate":false,"display_on_load":false},"verify_microdeposits_setup_intent":{"title":"Verify microdeposits on a SetupIntent","group_title":"Core Resources","group_anchor":"core_resources","anchor":"verify_microdeposits_setup_intent","section_anchor":"setup_intents","subsection_anchors":null,"path":"/setup_intents/verify_microdeposits","gate":false,"display_on_load":false},"setup_attempts":{"title":"SetupAttempts","group_title":"Core Resources","group_anchor":"core_resources","anchor":"setup_attempts","section_anchor":"setup_attempts","subsection_anchors":["setup_attempt_object","list_setup_attempts"],"path":"/setup_attempts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"SetupAttempts","description":"A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation was successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.\n","section_tag":"setup_attempts","subsection_summaries":[{"anchor":"setup_attempt_object","curl_definition":null},{"anchor":"list_setup_attempts","curl_definition":"GET /v1/setup_attempts"}]}},"setup_attempt_object":{"title":"The SetupAttempt object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"setup_attempt_object","section_anchor":"setup_attempts","subsection_anchors":null,"path":"/setup_attempts/object","gate":false,"display_on_load":false},"list_setup_attempts":{"title":"List all SetupAttempts","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_setup_attempts","section_anchor":"setup_attempts","subsection_anchors":null,"path":"/setup_attempts/list","gate":false,"display_on_load":false},"payouts":{"title":"Payouts","group_title":"Core Resources","group_anchor":"core_resources","anchor":"payouts","section_anchor":"payouts","subsection_anchors":["payout_object","create_payout","retrieve_payout","update_payout","list_payouts","cancel_payout","reverse_payout","payout_failures"],"path":"/payouts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Payouts","description":"A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nas well as list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving Payouts](/docs/payouts).\n","section_tag":"payouts","subsection_summaries":[{"anchor":"payout_object","curl_definition":null},{"anchor":"create_payout","curl_definition":"POST /v1/payouts"},{"anchor":"retrieve_payout","curl_definition":"GET /v1/payouts/:id"},{"anchor":"update_payout","curl_definition":"POST /v1/payouts/:id"},{"anchor":"list_payouts","curl_definition":"GET /v1/payouts"},{"anchor":"cancel_payout","curl_definition":"POST /v1/payouts/:id/cancel"},{"anchor":"reverse_payout","curl_definition":"POST /v1/payouts/:id/reverse"},{"anchor":"payout_failures","curl_definition":null}]}},"payout_object":{"title":"The payout object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"payout_object","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/object","gate":false,"display_on_load":false},"create_payout":{"title":"Create a payout","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_payout","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/create","gate":false,"display_on_load":false},"retrieve_payout":{"title":"Retrieve a payout","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_payout","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/retrieve","gate":false,"display_on_load":false},"update_payout":{"title":"Update a payout","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_payout","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/update","gate":false,"display_on_load":false},"list_payouts":{"title":"List all payouts","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_payouts","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/list","gate":false,"display_on_load":false},"cancel_payout":{"title":"Cancel a payout","group_title":"Core Resources","group_anchor":"core_resources","anchor":"cancel_payout","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/cancel","gate":false,"display_on_load":false},"reverse_payout":{"title":"Reverse a payout","group_title":"Core Resources","group_anchor":"core_resources","anchor":"reverse_payout","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/reverse","gate":false,"display_on_load":false},"payout_failures":{"title":"Types of payout failures","group_title":"Core Resources","group_anchor":"core_resources","anchor":"payout_failures","section_anchor":"payouts","subsection_anchors":null,"path":"/payouts/failures","gate":false,"display_on_load":false},"refunds":{"title":"Refunds","group_title":"Core Resources","group_anchor":"core_resources","anchor":"refunds","section_anchor":"refunds","subsection_anchors":["refund_object","create_refund","retrieve_refund","update_refund","cancel_refund","list_refunds"],"path":"/refunds","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Refunds","description":"`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](/docs/refunds).\n","section_tag":"refunds","subsection_summaries":[{"anchor":"refund_object","curl_definition":null},{"anchor":"create_refund","curl_definition":"POST /v1/refunds"},{"anchor":"retrieve_refund","curl_definition":"GET /v1/refunds/:id"},{"anchor":"update_refund","curl_definition":"POST /v1/refunds/:id"},{"anchor":"cancel_refund","curl_definition":"POST /v1/refunds/:id/cancel"},{"anchor":"list_refunds","curl_definition":"GET /v1/refunds"}]}},"refund_object":{"title":"The refund object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"refund_object","section_anchor":"refunds","subsection_anchors":null,"path":"/refunds/object","gate":false,"display_on_load":false},"create_refund":{"title":"Create a refund","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_refund","section_anchor":"refunds","subsection_anchors":null,"path":"/refunds/create","gate":false,"display_on_load":false},"retrieve_refund":{"title":"Retrieve a refund","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_refund","section_anchor":"refunds","subsection_anchors":null,"path":"/refunds/retrieve","gate":false,"display_on_load":false},"update_refund":{"title":"Update a refund","group_title":"Core Resources","group_anchor":"core_resources","anchor":"update_refund","section_anchor":"refunds","subsection_anchors":null,"path":"/refunds/update","gate":false,"display_on_load":false},"cancel_refund":{"title":"Cancel a refund","group_title":"Core Resources","group_anchor":"core_resources","anchor":"cancel_refund","section_anchor":"refunds","subsection_anchors":null,"path":"/refunds/cancel","gate":false,"display_on_load":false},"list_refunds":{"title":"List all refunds","group_title":"Core Resources","group_anchor":"core_resources","anchor":"list_refunds","section_anchor":"refunds","subsection_anchors":null,"path":"/refunds/list","gate":false,"display_on_load":false},"tokens":{"title":"Tokens","group_title":"Core Resources","group_anchor":"core_resources","anchor":"tokens","section_anchor":"tokens","subsection_anchors":["token_object","create_card_token","create_bank_account_token","create_pii_token","create_account_token","create_person_token","create_cvc_update_token","retrieve_token"],"path":"/tokens","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Tokens","description":"Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. You should use our\n[recommended payments integrations](/docs/payments) to perform this process\nclient-side. This ensures that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you cannot use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. Keep in mind that if\nyour integration uses this method, you are responsible for any PCI compliance\nthat may be required, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information is not sent directly to\nStripe, so we cannot determine how it is handled or stored.\n\nTokens cannot be stored or used more than once. To store card or bank account\ninformation for later use, you can create [Customer](/docs/api#customers)\nobjects or [Custom accounts](/docs/api#external_accounts). Note that\n[Radar](/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.\n\nRelated guide: [Accept a payment](/docs/payments/accept-a-payment-charges#web-create-token)\n","section_tag":"tokens","subsection_summaries":[{"anchor":"token_object","curl_definition":null},{"anchor":"create_card_token","curl_definition":"POST /v1/tokens"},{"anchor":"create_bank_account_token","curl_definition":"POST /v1/tokens"},{"anchor":"create_pii_token","curl_definition":"POST /v1/tokens"},{"anchor":"create_account_token","curl_definition":"POST /v1/tokens"},{"anchor":"create_person_token","curl_definition":"POST /v1/tokens"},{"anchor":"create_cvc_update_token","curl_definition":"POST /v1/tokens"},{"anchor":"retrieve_token","curl_definition":"GET /v1/tokens/:id"}]}},"token_object":{"title":"The token object","group_title":"Core Resources","group_anchor":"core_resources","anchor":"token_object","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/object","gate":false,"display_on_load":false},"create_card_token":{"title":"Create a card token","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_card_token","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/create_card","gate":false,"display_on_load":false},"create_bank_account_token":{"title":"Create a bank account token","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_bank_account_token","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/create_bank_account","gate":false,"display_on_load":false},"create_pii_token":{"title":"Create a PII token","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_pii_token","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/create_pii","gate":false,"display_on_load":false},"create_account_token":{"title":"Create an account token","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_account_token","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/create_account","gate":false,"display_on_load":false},"create_person_token":{"title":"Create a person token","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_person_token","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/create_person","gate":false,"display_on_load":false},"create_cvc_update_token":{"title":"Create a CVC update token","group_title":"Core Resources","group_anchor":"core_resources","anchor":"create_cvc_update_token","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/create_cvc_update","gate":false,"display_on_load":false},"retrieve_token":{"title":"Retrieve a token","group_title":"Core Resources","group_anchor":"core_resources","anchor":"retrieve_token","section_anchor":"tokens","subsection_anchors":null,"path":"/tokens/retrieve","gate":false,"display_on_load":false},"payment_methods":{"title":"PaymentMethods","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"payment_methods","section_anchor":"payment_methods","subsection_anchors":["payment_method_object","create_payment_method","retrieve_payment_method","retrieve_customer_payment_method","update_payment_method","list_payment_methods","list_customer_payment_methods","customer_attach_payment_method","customer_detach_payment_method"],"path":"/payment_methods","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"PaymentMethods","description":"PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](/docs/payments/payment-methods) and [More Payment Scenarios](/docs/payments/more-payment-scenarios).\n","section_tag":"payment_methods","subsection_summaries":[{"anchor":"payment_method_object","curl_definition":null},{"anchor":"create_payment_method","curl_definition":"POST /v1/payment_methods"},{"anchor":"retrieve_payment_method","curl_definition":"GET /v1/payment_methods/:id"},{"anchor":"retrieve_customer_payment_method","curl_definition":"GET /v1/customers/:customer/payment_methods/:payment_method"},{"anchor":"update_payment_method","curl_definition":"POST /v1/payment_methods/:id"},{"anchor":"list_payment_methods","curl_definition":"GET /v1/payment_methods"},{"anchor":"list_customer_payment_methods","curl_definition":"GET /v1/customers/:customer/payment_methods"},{"anchor":"customer_attach_payment_method","curl_definition":"POST /v1/payment_methods/:id/attach"},{"anchor":"customer_detach_payment_method","curl_definition":"POST /v1/payment_methods/:id/detach"}]}},"payment_method_object":{"title":"The PaymentMethod object","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"payment_method_object","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/object","gate":false,"display_on_load":false},"create_payment_method":{"title":"Create a PaymentMethod","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"create_payment_method","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/create","gate":false,"display_on_load":false},"retrieve_payment_method":{"title":"Retrieve a PaymentMethod","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"retrieve_payment_method","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/retrieve","gate":false,"display_on_load":false},"retrieve_customer_payment_method":{"title":"Retrieve a Customer's PaymentMethod","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"retrieve_customer_payment_method","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/customer","gate":false,"display_on_load":false},"update_payment_method":{"title":"Update a PaymentMethod","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"update_payment_method","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/update","gate":false,"display_on_load":false},"list_payment_methods":{"title":"List PaymentMethods","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"list_payment_methods","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/list","gate":false,"display_on_load":false},"list_customer_payment_methods":{"title":"List a Customer's PaymentMethods","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"list_customer_payment_methods","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/customer_list","gate":false,"display_on_load":false},"customer_attach_payment_method":{"title":"Attach a PaymentMethod to a Customer","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_attach_payment_method","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/attach","gate":false,"display_on_load":false},"customer_detach_payment_method":{"title":"Detach a PaymentMethod from a Customer","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_detach_payment_method","section_anchor":"payment_methods","subsection_anchors":null,"path":"/payment_methods/detach","gate":false,"display_on_load":false},"bank_accounts":{"title":"Bank Accounts","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"bank_accounts","section_anchor":"bank_accounts","subsection_anchors":["customer_bank_account_object","customer_create_bank_account","customer_retrieve_bank_account","customer_update_bank_account","customer_verify_bank_account","customer_delete_bank_account","customer_list_bank_accounts"],"path":"/customer_bank_accounts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Bank Accounts","description":"These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/docs/api#external_accounts) are transfer\ndestinations on `Account` objects for [Custom accounts](/docs/connect/custom-accounts).\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank Debits and Transfers](/docs/payments/bank-debits-transfers).\n","section_tag":"bank_accounts","subsection_summaries":[{"anchor":"customer_bank_account_object","curl_definition":null},{"anchor":"customer_create_bank_account","curl_definition":"POST /v1/customers/:id/sources"},{"anchor":"customer_retrieve_bank_account","curl_definition":"GET /v1/customers/:id/sources/:id"},{"anchor":"customer_update_bank_account","curl_definition":"POST /v1/customers/:id/sources/:id"},{"anchor":"customer_verify_bank_account","curl_definition":"POST /v1/customers/:id/sources/:id/verify"},{"anchor":"customer_delete_bank_account","curl_definition":"DELETE /v1/customers/:id/sources/:id"},{"anchor":"customer_list_bank_accounts","curl_definition":"GET /v1/customers/:id/sources?object=bank_account"}]}},"customer_bank_account_object":{"title":"The bank account object","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_bank_account_object","section_anchor":"bank_accounts","subsection_anchors":null,"path":"/customer_bank_accounts/object","gate":false,"display_on_load":false},"customer_create_bank_account":{"title":"Create a bank account","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_create_bank_account","section_anchor":"bank_accounts","subsection_anchors":null,"path":"/customer_bank_accounts/create","gate":false,"display_on_load":false},"customer_retrieve_bank_account":{"title":"Retrieve a bank account","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_retrieve_bank_account","section_anchor":"bank_accounts","subsection_anchors":null,"path":"/customer_bank_accounts/retrieve","gate":false,"display_on_load":false},"customer_update_bank_account":{"title":"Update a bank account","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_update_bank_account","section_anchor":"bank_accounts","subsection_anchors":null,"path":"/customer_bank_accounts/update","gate":false,"display_on_load":false},"customer_verify_bank_account":{"title":"Verify a bank account","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_verify_bank_account","section_anchor":"bank_accounts","subsection_anchors":null,"path":"/customer_bank_accounts/verify","gate":false,"display_on_load":false},"customer_delete_bank_account":{"title":"Delete a bank account","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_delete_bank_account","section_anchor":"bank_accounts","subsection_anchors":null,"path":"/customer_bank_accounts/delete","gate":false,"display_on_load":false},"customer_list_bank_accounts":{"title":"List all bank accounts","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_list_bank_accounts","section_anchor":"bank_accounts","subsection_anchors":null,"path":"/customer_bank_accounts/list","gate":false,"display_on_load":false},"cash_balance":{"title":"Cash Balance","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"cash_balance","section_anchor":"cash_balance","subsection_anchors":["cash_balance_object","retrieve_cash_balance","update_cash_balance","customer_cash_balance_transaction_object","retrieve_cash_balance_transaction","list_cash_balance_transactions","fund_cash_balance"],"path":"/cash_balance","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Cash balance","description":"A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.\n","section_tag":"cash_balance","subsection_summaries":[{"anchor":"cash_balance_object","curl_definition":null},{"anchor":"retrieve_cash_balance","curl_definition":"GET /v1/customers/:id/cash_balance"},{"anchor":"update_cash_balance","curl_definition":"POST /v1/customers/:id/cash_balance"},{"anchor":"customer_cash_balance_transaction_object","curl_definition":null},{"anchor":"retrieve_cash_balance_transaction","curl_definition":"GET /v1/customers/:id/cash_balance_transactions/:id"},{"anchor":"list_cash_balance_transactions","curl_definition":"GET /v1/customers/:id/cash_balance_transactions"},{"anchor":"fund_cash_balance","curl_definition":"POST /v1/test_helpers/customers/{:customer}/fund_cash_balance"}]}},"cash_balance_object":{"title":"The cash balance object","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"cash_balance_object","section_anchor":"cash_balance","subsection_anchors":null,"path":"/cash_balance/object","gate":false,"display_on_load":false},"retrieve_cash_balance":{"title":"Retrieve a cash balance","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"retrieve_cash_balance","section_anchor":"cash_balance","subsection_anchors":null,"path":"/cash_balance/retrieve","gate":true,"display_on_load":false},"update_cash_balance":{"title":"Update a cash balance's settings","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"update_cash_balance","section_anchor":"cash_balance","subsection_anchors":null,"path":"/cash_balance/update","gate":true,"display_on_load":false},"customer_cash_balance_transaction_object":{"title":"The cash balance transaction object","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"customer_cash_balance_transaction_object","section_anchor":"cash_balance","subsection_anchors":null,"path":"/cash_balance_transactions/object","gate":false,"display_on_load":false},"retrieve_cash_balance_transaction":{"title":"Retrieve a cash balance transaction","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"retrieve_cash_balance_transaction","section_anchor":"cash_balance","subsection_anchors":null,"path":"/cash_balance_transactions/retrieve","gate":false,"display_on_load":false},"list_cash_balance_transactions":{"title":"List cash balance transactions","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"list_cash_balance_transactions","section_anchor":"cash_balance","subsection_anchors":null,"path":"/cash_balance_transactions/list","gate":false,"display_on_load":false},"fund_cash_balance":{"title":"Fund a test mode cash balance","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"fund_cash_balance","section_anchor":"cash_balance","subsection_anchors":null,"path":"/cash_balance_transactions/fund_cash_balance","gate":false,"display_on_load":false},"cards":{"title":"Cards","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"cards","section_anchor":"cards","subsection_anchors":["card_object","create_card","retrieve_card","update_card","delete_card","list_cards"],"path":"/cards","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Cards","description":"You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card Payments with Sources](/docs/sources/cards).\n","section_tag":"cards","subsection_summaries":[{"anchor":"card_object","curl_definition":null},{"anchor":"create_card","curl_definition":"POST /v1/customers/:id/sources"},{"anchor":"retrieve_card","curl_definition":"GET /v1/customers/:id/sources/:id"},{"anchor":"update_card","curl_definition":"POST /v1/customers/:id/sources/:id"},{"anchor":"delete_card","curl_definition":"DELETE /v1/customers/:id/sources/:id"},{"anchor":"list_cards","curl_definition":"GET /v1/customers/:id/sources?object=card"}]}},"card_object":{"title":"The card object","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"card_object","section_anchor":"cards","subsection_anchors":null,"path":"/cards/object","gate":false,"display_on_load":false},"create_card":{"title":"Create a card","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"create_card","section_anchor":"cards","subsection_anchors":null,"path":"/cards/create","gate":false,"display_on_load":false},"retrieve_card":{"title":"Retrieve a card","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"retrieve_card","section_anchor":"cards","subsection_anchors":null,"path":"/cards/retrieve","gate":false,"display_on_load":false},"update_card":{"title":"Update a card","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"update_card","section_anchor":"cards","subsection_anchors":null,"path":"/cards/update","gate":false,"display_on_load":false},"delete_card":{"title":"Delete a card","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"delete_card","section_anchor":"cards","subsection_anchors":null,"path":"/cards/delete","gate":false,"display_on_load":false},"list_cards":{"title":"List all cards","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"list_cards","section_anchor":"cards","subsection_anchors":null,"path":"/cards/list","gate":false,"display_on_load":false},"sources":{"title":"Sources","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"sources","section_anchor":"sources","subsection_anchors":["source_object","create_source","retrieve_source","update_source","attach_source","detach_source"],"path":"/sources","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Sources","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\nStripe doesn't recommend using the deprecated [Sources API](/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](/docs/sources) and [Sources \u0026 Customers](/docs/sources/customers).\n","section_tag":"sources","subsection_summaries":[{"anchor":"source_object","curl_definition":null},{"anchor":"create_source","curl_definition":"POST /v1/sources"},{"anchor":"retrieve_source","curl_definition":"GET /v1/sources/:id"},{"anchor":"update_source","curl_definition":"POST /v1/sources/:id"},{"anchor":"attach_source","curl_definition":"POST /v1/customers/:id/sources"},{"anchor":"detach_source","curl_definition":"DELETE /v1/customers/:id/sources/:id"}]}},"source_object":{"title":"The source object","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"source_object","section_anchor":"sources","subsection_anchors":null,"path":"/sources/object","gate":false,"display_on_load":false},"create_source":{"title":"Create a source","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"create_source","section_anchor":"sources","subsection_anchors":null,"path":"/sources/create","gate":false,"display_on_load":false},"retrieve_source":{"title":"Retrieve a source","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"retrieve_source","section_anchor":"sources","subsection_anchors":null,"path":"/sources/retrieve","gate":false,"display_on_load":false},"update_source":{"title":"Update a source","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"update_source","section_anchor":"sources","subsection_anchors":null,"path":"/sources/update","gate":false,"display_on_load":false},"attach_source":{"title":"Attach a source","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"attach_source","section_anchor":"sources","subsection_anchors":null,"path":"/sources/attach","gate":false,"display_on_load":false},"detach_source":{"title":"Detach a source","group_title":"Payment Methods","group_anchor":"payment_methods_heading","anchor":"detach_source","section_anchor":"sources","subsection_anchors":null,"path":"/sources/detach","gate":false,"display_on_load":false},"products":{"title":"Products","group_title":"Products","group_anchor":"products_section","anchor":"products","section_anchor":"products","subsection_anchors":["product_object","create_product","retrieve_product","update_product","list_products","delete_product","search_products"],"path":"/products","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Products","description":"Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](/docs/payments/payment-links/overview),\n[accept payments with Checkout](/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](/docs/products-prices/overview)\n","section_tag":"products","subsection_summaries":[{"anchor":"product_object","curl_definition":null},{"anchor":"create_product","curl_definition":"POST /v1/products"},{"anchor":"retrieve_product","curl_definition":"GET /v1/products/:id"},{"anchor":"update_product","curl_definition":"POST /v1/products/:id"},{"anchor":"list_products","curl_definition":"GET /v1/products"},{"anchor":"delete_product","curl_definition":"DELETE /v1/products/:id"},{"anchor":"search_products","curl_definition":"GET /v1/products/search"}]}},"product_object":{"title":"The product object","group_title":"Products","group_anchor":"products_section","anchor":"product_object","section_anchor":"products","subsection_anchors":null,"path":"/products/object","gate":false,"display_on_load":false},"create_product":{"title":"Create a product","group_title":"Products","group_anchor":"products_section","anchor":"create_product","section_anchor":"products","subsection_anchors":null,"path":"/products/create","gate":false,"display_on_load":false},"retrieve_product":{"title":"Retrieve a product","group_title":"Products","group_anchor":"products_section","anchor":"retrieve_product","section_anchor":"products","subsection_anchors":null,"path":"/products/retrieve","gate":false,"display_on_load":false},"update_product":{"title":"Update a product","group_title":"Products","group_anchor":"products_section","anchor":"update_product","section_anchor":"products","subsection_anchors":null,"path":"/products/update","gate":false,"display_on_load":false},"list_products":{"title":"List all products","group_title":"Products","group_anchor":"products_section","anchor":"list_products","section_anchor":"products","subsection_anchors":null,"path":"/products/list","gate":false,"display_on_load":false},"delete_product":{"title":"Delete a product","group_title":"Products","group_anchor":"products_section","anchor":"delete_product","section_anchor":"products","subsection_anchors":null,"path":"/products/delete","gate":false,"display_on_load":false},"search_products":{"title":"Search products","group_title":"Products","group_anchor":"products_section","anchor":"search_products","section_anchor":"products","subsection_anchors":null,"path":"/products/search","gate":false,"display_on_load":false},"prices":{"title":"Prices","group_title":"Products","group_anchor":"products_section","anchor":"prices","section_anchor":"prices","subsection_anchors":["price_object","create_price","retrieve_price","update_price","list_prices","search_prices"],"path":"/prices","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Prices","description":"Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](#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](/docs/billing/subscriptions/set-up-subscription), [create an invoice](/docs/billing/invoices/create), and more about [products and prices](/docs/products-prices/overview).\n","section_tag":"prices","subsection_summaries":[{"anchor":"price_object","curl_definition":null},{"anchor":"create_price","curl_definition":"POST /v1/prices"},{"anchor":"retrieve_price","curl_definition":"GET /v1/prices/:id"},{"anchor":"update_price","curl_definition":"POST /v1/prices/:id"},{"anchor":"list_prices","curl_definition":"GET /v1/prices"},{"anchor":"search_prices","curl_definition":"GET /v1/prices/search"}]}},"price_object":{"title":"The price object","group_title":"Products","group_anchor":"products_section","anchor":"price_object","section_anchor":"prices","subsection_anchors":null,"path":"/prices/object","gate":false,"display_on_load":false},"create_price":{"title":"Create a price","group_title":"Products","group_anchor":"products_section","anchor":"create_price","section_anchor":"prices","subsection_anchors":null,"path":"/prices/create","gate":false,"display_on_load":false},"retrieve_price":{"title":"Retrieve a price","group_title":"Products","group_anchor":"products_section","anchor":"retrieve_price","section_anchor":"prices","subsection_anchors":null,"path":"/prices/retrieve","gate":false,"display_on_load":false},"update_price":{"title":"Update a price","group_title":"Products","group_anchor":"products_section","anchor":"update_price","section_anchor":"prices","subsection_anchors":null,"path":"/prices/update","gate":false,"display_on_load":false},"list_prices":{"title":"List all prices","group_title":"Products","group_anchor":"products_section","anchor":"list_prices","section_anchor":"prices","subsection_anchors":null,"path":"/prices/list","gate":false,"display_on_load":false},"search_prices":{"title":"Search prices","group_title":"Products","group_anchor":"products_section","anchor":"search_prices","section_anchor":"prices","subsection_anchors":null,"path":"/prices/search","gate":false,"display_on_load":false},"coupons":{"title":"Coupons","group_title":"Products","group_anchor":"products_section","anchor":"coupons","section_anchor":"coupons","subsection_anchors":["coupon_object","create_coupon","retrieve_coupon","update_coupon","delete_coupon","list_coupons"],"path":"/coupons","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Coupons","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 [subscriptions](#subscriptions), [invoices](#invoices),\n[checkout sessions](/docs/api/checkout/sessions), [quotes](#quotes), and more. Coupons do not work with conventional one-off [charges](#create_charge) or [payment intents](/docs/api/payment_intents).\n","section_tag":"coupons","subsection_summaries":[{"anchor":"coupon_object","curl_definition":null},{"anchor":"create_coupon","curl_definition":"POST /v1/coupons"},{"anchor":"retrieve_coupon","curl_definition":"GET /v1/coupons/:id"},{"anchor":"update_coupon","curl_definition":"POST /v1/coupons/:id"},{"anchor":"delete_coupon","curl_definition":"DELETE /v1/coupons/:id"},{"anchor":"list_coupons","curl_definition":"GET /v1/coupons"}]}},"coupon_object":{"title":"The coupon object","group_title":"Products","group_anchor":"products_section","anchor":"coupon_object","section_anchor":"coupons","subsection_anchors":null,"path":"/coupons/object","gate":false,"display_on_load":false},"create_coupon":{"title":"Create a coupon","group_title":"Products","group_anchor":"products_section","anchor":"create_coupon","section_anchor":"coupons","subsection_anchors":null,"path":"/coupons/create","gate":false,"display_on_load":false},"retrieve_coupon":{"title":"Retrieve a coupon","group_title":"Products","group_anchor":"products_section","anchor":"retrieve_coupon","section_anchor":"coupons","subsection_anchors":null,"path":"/coupons/retrieve","gate":false,"display_on_load":false},"update_coupon":{"title":"Update a coupon","group_title":"Products","group_anchor":"products_section","anchor":"update_coupon","section_anchor":"coupons","subsection_anchors":null,"path":"/coupons/update","gate":false,"display_on_load":false},"delete_coupon":{"title":"Delete a coupon","group_title":"Products","group_anchor":"products_section","anchor":"delete_coupon","section_anchor":"coupons","subsection_anchors":null,"path":"/coupons/delete","gate":false,"display_on_load":false},"list_coupons":{"title":"List all coupons","group_title":"Products","group_anchor":"products_section","anchor":"list_coupons","section_anchor":"coupons","subsection_anchors":null,"path":"/coupons/list","gate":false,"display_on_load":false},"promotion_codes":{"title":"Promotion Codes","group_title":"Products","group_anchor":"products_section","anchor":"promotion_codes","section_anchor":"promotion_codes","subsection_anchors":["promotion_code_object","create_promotion_code","update_promotion_code","retrieve_promotion_code","list_promotion_code"],"path":"/promotion_codes","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Promotion Code","description":"A Promotion Code represents a customer-redeemable code for a [coupon](#coupons). It can be used to\ncreate multiple codes for a single coupon.\n","section_tag":"promotion_codes","subsection_summaries":[{"anchor":"promotion_code_object","curl_definition":null},{"anchor":"create_promotion_code","curl_definition":"POST /v1/promotion_codes"},{"anchor":"update_promotion_code","curl_definition":"POST /v1/promotion_codes/:id"},{"anchor":"retrieve_promotion_code","curl_definition":"GET /v1/promotion_codes/:id"},{"anchor":"list_promotion_code","curl_definition":"GET /v1/promotion_codes"}]}},"promotion_code_object":{"title":"The promotion code object","group_title":"Products","group_anchor":"products_section","anchor":"promotion_code_object","section_anchor":"promotion_codes","subsection_anchors":null,"path":"/promotion_codes/object","gate":false,"display_on_load":false},"create_promotion_code":{"title":"Create a promotion code","group_title":"Products","group_anchor":"products_section","anchor":"create_promotion_code","section_anchor":"promotion_codes","subsection_anchors":null,"path":"/promotion_codes/create","gate":false,"display_on_load":false},"update_promotion_code":{"title":"Update a promotion code","group_title":"Products","group_anchor":"products_section","anchor":"update_promotion_code","section_anchor":"promotion_codes","subsection_anchors":null,"path":"/promotion_codes/update","gate":false,"display_on_load":false},"retrieve_promotion_code":{"title":"Retrieve a promotion code","group_title":"Products","group_anchor":"products_section","anchor":"retrieve_promotion_code","section_anchor":"promotion_codes","subsection_anchors":null,"path":"/promotion_codes/retrieve","gate":false,"display_on_load":false},"list_promotion_code":{"title":"List all promotion codes","group_title":"Products","group_anchor":"products_section","anchor":"list_promotion_code","section_anchor":"promotion_codes","subsection_anchors":null,"path":"/promotion_codes/list","gate":false,"display_on_load":false},"discounts":{"title":"Discounts","group_title":"Products","group_anchor":"products_section","anchor":"discounts","section_anchor":"discounts","subsection_anchors":["discount_object","delete_discount","delete_subscription_discount"],"path":"/discounts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Discounts","description":"A discount represents the actual application of a [coupon](#coupons) or [promotion code](#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying Discounts to Subscriptions](/docs/billing/subscriptions/discounts).\n","section_tag":"discounts","subsection_summaries":[{"anchor":"discount_object","curl_definition":null},{"anchor":"delete_discount","curl_definition":"DELETE /v1/customers/:id/discount"},{"anchor":"delete_subscription_discount","curl_definition":"DELETE /v1/subscriptions/:id/discount"}]}},"discount_object":{"title":"The discount object","group_title":"Products","group_anchor":"products_section","anchor":"discount_object","section_anchor":"discounts","subsection_anchors":null,"path":"/discounts/object","gate":false,"display_on_load":false},"delete_discount":{"title":"Delete a customer discount","group_title":"Products","group_anchor":"products_section","anchor":"delete_discount","section_anchor":"discounts","subsection_anchors":null,"path":"/discounts/delete","gate":false,"display_on_load":false},"delete_subscription_discount":{"title":"Delete a subscription discount","group_title":"Products","group_anchor":"products_section","anchor":"delete_subscription_discount","section_anchor":"discounts","subsection_anchors":null,"path":"/discounts/subscription_delete","gate":false,"display_on_load":false},"tax_codes":{"title":"Tax Codes","group_title":"Products","group_anchor":"products_section","anchor":"tax_codes","section_anchor":"tax_codes","subsection_anchors":["tax_code_object","list_tax_codes","retrieve_taxcode"],"path":"/tax_codes","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Tax Code","description":"[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.\n","section_tag":"tax_codes","subsection_summaries":[{"anchor":"tax_code_object","curl_definition":null},{"anchor":"list_tax_codes","curl_definition":"GET /v1/tax_codes"},{"anchor":"retrieve_taxcode","curl_definition":"GET /v1/tax_codes/:id"}]}},"tax_code_object":{"title":"The tax code object","group_title":"Products","group_anchor":"products_section","anchor":"tax_code_object","section_anchor":"tax_codes","subsection_anchors":null,"path":"/tax_codes/object","gate":false,"display_on_load":false},"list_tax_codes":{"title":"List all tax codes","group_title":"Products","group_anchor":"products_section","anchor":"list_tax_codes","section_anchor":"tax_codes","subsection_anchors":null,"path":"/tax_codes/list","gate":false,"display_on_load":false},"retrieve_taxcode":{"title":"Retrieve a tax code","group_title":"Products","group_anchor":"products_section","anchor":"retrieve_taxcode","section_anchor":"tax_codes","subsection_anchors":null,"path":"/tax_codes/retrieve","gate":false,"display_on_load":false},"tax_rates":{"title":"Tax Rates","group_title":"Products","group_anchor":"products_section","anchor":"tax_rates","section_anchor":"tax_rates","subsection_anchors":["tax_rate_object","create_tax_rate","retrieve_tax_rate","update_tax_rate","list_tax_rates"],"path":"/tax_rates","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Tax Rate","description":"Tax rates can be applied to [invoices](/docs/billing/invoices/tax-rates), [subscriptions](/docs/billing/subscriptions/taxes) and [Checkout Sessions](/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](/docs/billing/taxes/tax-rates).\n","section_tag":"tax_rates","subsection_summaries":[{"anchor":"tax_rate_object","curl_definition":null},{"anchor":"create_tax_rate","curl_definition":"POST /v1/tax_rates"},{"anchor":"retrieve_tax_rate","curl_definition":"GET /v1/tax_rates/:id"},{"anchor":"update_tax_rate","curl_definition":"POST /v1/tax_rates/:id"},{"anchor":"list_tax_rates","curl_definition":"GET /v1/tax_rates"}]}},"tax_rate_object":{"title":"The tax rate object","group_title":"Products","group_anchor":"products_section","anchor":"tax_rate_object","section_anchor":"tax_rates","subsection_anchors":null,"path":"/tax_rates/object","gate":false,"display_on_load":false},"create_tax_rate":{"title":"Create a tax rate","group_title":"Products","group_anchor":"products_section","anchor":"create_tax_rate","section_anchor":"tax_rates","subsection_anchors":null,"path":"/tax_rates/create","gate":false,"display_on_load":false},"retrieve_tax_rate":{"title":"Retrieves a tax rate","group_title":"Products","group_anchor":"products_section","anchor":"retrieve_tax_rate","section_anchor":"tax_rates","subsection_anchors":null,"path":"/tax_rates/retrieve","gate":false,"display_on_load":false},"update_tax_rate":{"title":"Update a tax rate","group_title":"Products","group_anchor":"products_section","anchor":"update_tax_rate","section_anchor":"tax_rates","subsection_anchors":null,"path":"/tax_rates/update","gate":false,"display_on_load":false},"list_tax_rates":{"title":"List all tax rates","group_title":"Products","group_anchor":"products_section","anchor":"list_tax_rates","section_anchor":"tax_rates","subsection_anchors":null,"path":"/tax_rates/list","gate":false,"display_on_load":false},"shipping_rates":{"title":"Shipping Rates","group_title":"Products","group_anchor":"products_section","anchor":"shipping_rates","section_anchor":"shipping_rates","subsection_anchors":["shipping_rate_object","create_shipping_rate","retrieve_shipping_rate","update_shipping_rate","list_shipping_rates"],"path":"/shipping_rates","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Shipping Rates","description":"Shipping rates describe the price of shipping presented to your customers and can be\napplied to [Checkout Sessions](/docs/payments/checkout/shipping)\nand [Orders](/docs/orders/shipping) to collect shipping costs.\n","section_tag":"shipping_rates","subsection_summaries":[{"anchor":"shipping_rate_object","curl_definition":null},{"anchor":"create_shipping_rate","curl_definition":"POST /v1/shipping_rates"},{"anchor":"retrieve_shipping_rate","curl_definition":"GET /v1/shipping_rates/:id"},{"anchor":"update_shipping_rate","curl_definition":"POST /v1/shipping_rates/:id"},{"anchor":"list_shipping_rates","curl_definition":"GET /v1/shipping_rates"}]}},"shipping_rate_object":{"title":"The shipping rate object","group_title":"Products","group_anchor":"products_section","anchor":"shipping_rate_object","section_anchor":"shipping_rates","subsection_anchors":null,"path":"/shipping_rates/object","gate":false,"display_on_load":false},"create_shipping_rate":{"title":"Create a shipping rate","group_title":"Products","group_anchor":"products_section","anchor":"create_shipping_rate","section_anchor":"shipping_rates","subsection_anchors":null,"path":"/shipping_rates/create","gate":false,"display_on_load":false},"retrieve_shipping_rate":{"title":"Retrieve a shipping rate","group_title":"Products","group_anchor":"products_section","anchor":"retrieve_shipping_rate","section_anchor":"shipping_rates","subsection_anchors":null,"path":"/shipping_rates/retrieve","gate":false,"display_on_load":false},"update_shipping_rate":{"title":"Update a shipping rate","group_title":"Products","group_anchor":"products_section","anchor":"update_shipping_rate","section_anchor":"shipping_rates","subsection_anchors":null,"path":"/shipping_rates/update","gate":false,"display_on_load":false},"list_shipping_rates":{"title":"List all shipping rates","group_title":"Products","group_anchor":"products_section","anchor":"list_shipping_rates","section_anchor":"shipping_rates","subsection_anchors":null,"path":"/shipping_rates/list","gate":false,"display_on_load":false},"checkout_sessions":{"title":"Checkout Sessions","group_title":"Checkout","group_anchor":"checkout","anchor":"checkout_sessions","section_anchor":"checkout_sessions","subsection_anchors":["checkout_session_object","create_checkout_session","expire_checkout_session","retrieve_checkout_session","list_checkout_sessions","retrieve_checkout_session_line_items"],"path":"/checkout/sessions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Sessions","description":"A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](/docs/payments/checkout)\nor [Payment Links](/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](/docs/api/customers), and either the successful\n[PaymentIntent](/docs/api/payment_intents) or an active\n[Subscription](/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout Quickstart](/docs/checkout/quickstart).\n","section_tag":"checkout_sessions","subsection_summaries":[{"anchor":"checkout_session_object","curl_definition":null},{"anchor":"create_checkout_session","curl_definition":"POST /v1/checkout/sessions"},{"anchor":"expire_checkout_session","curl_definition":"POST /v1/checkout/sessions/:id/expire"},{"anchor":"retrieve_checkout_session","curl_definition":"GET /v1/checkout/sessions/:id"},{"anchor":"list_checkout_sessions","curl_definition":"GET /v1/checkout/sessions"},{"anchor":"retrieve_checkout_session_line_items","curl_definition":"GET /v1/checkout/sessions/:id/line_items"}]}},"checkout_session_object":{"title":"The Checkout Session object","group_title":"Checkout","group_anchor":"checkout","anchor":"checkout_session_object","section_anchor":"checkout_sessions","subsection_anchors":null,"path":"/checkout/sessions/object","gate":false,"display_on_load":false},"create_checkout_session":{"title":"Create a Checkout Session","group_title":"Checkout","group_anchor":"checkout","anchor":"create_checkout_session","section_anchor":"checkout_sessions","subsection_anchors":null,"path":"/checkout/sessions/create","gate":false,"display_on_load":false},"expire_checkout_session":{"title":"Expire a Checkout Session","group_title":"Checkout","group_anchor":"checkout","anchor":"expire_checkout_session","section_anchor":"checkout_sessions","subsection_anchors":null,"path":"/checkout/sessions/expire","gate":false,"display_on_load":false},"retrieve_checkout_session":{"title":"Retrieve a Checkout Session","group_title":"Checkout","group_anchor":"checkout","anchor":"retrieve_checkout_session","section_anchor":"checkout_sessions","subsection_anchors":null,"path":"/checkout/sessions/retrieve","gate":false,"display_on_load":false},"list_checkout_sessions":{"title":"List all Checkout Sessions","group_title":"Checkout","group_anchor":"checkout","anchor":"list_checkout_sessions","section_anchor":"checkout_sessions","subsection_anchors":null,"path":"/checkout/sessions/list","gate":false,"display_on_load":false},"retrieve_checkout_session_line_items":{"title":"Retrieve a Checkout Session's line items","group_title":"Checkout","group_anchor":"checkout","anchor":"retrieve_checkout_session_line_items","section_anchor":"checkout_sessions","subsection_anchors":null,"path":"/checkout/sessions/line_items","gate":false,"display_on_load":false},"payment_links":{"title":"Payment Links","group_title":"Payment Links","group_anchor":"payment_links_section","anchor":"payment_links","section_anchor":"payment_links","subsection_anchors":["payment_link_object","create_payment_link","retrieve_payment_link","update_payment_link","list_payment_link","retrieve_payment_link_line_items"],"path":"/payment_links/payment_links","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Payment Link","description":"A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](/docs/payments/payment-links/api)\n","section_tag":"payment_links","subsection_summaries":[{"anchor":"payment_link_object","curl_definition":null},{"anchor":"create_payment_link","curl_definition":"POST /v1/payment_links"},{"anchor":"retrieve_payment_link","curl_definition":"GET /v1/payment_links/:id"},{"anchor":"update_payment_link","curl_definition":"POST /v1/payment_links/:id"},{"anchor":"list_payment_link","curl_definition":"GET /v1/payment_links"},{"anchor":"retrieve_payment_link_line_items","curl_definition":"GET /v1/payment_links/:id/line_items"}]}},"payment_link_object":{"title":"The payment link object","group_title":"Payment Links","group_anchor":"payment_links_section","anchor":"payment_link_object","section_anchor":"payment_links","subsection_anchors":null,"path":"/payment_links/payment_links/object","gate":false,"display_on_load":false},"create_payment_link":{"title":"Create a payment link","group_title":"Payment Links","group_anchor":"payment_links_section","anchor":"create_payment_link","section_anchor":"payment_links","subsection_anchors":null,"path":"/payment_links/payment_links/create","gate":false,"display_on_load":false},"retrieve_payment_link":{"title":"Retrieve payment link","group_title":"Payment Links","group_anchor":"payment_links_section","anchor":"retrieve_payment_link","section_anchor":"payment_links","subsection_anchors":null,"path":"/payment_links/payment_links/retrieve","gate":false,"display_on_load":false},"update_payment_link":{"title":"Update a payment link","group_title":"Payment Links","group_anchor":"payment_links_section","anchor":"update_payment_link","section_anchor":"payment_links","subsection_anchors":null,"path":"/payment_links/payment_links/update","gate":false,"display_on_load":false},"list_payment_link":{"title":"List all payment links","group_title":"Payment Links","group_anchor":"payment_links_section","anchor":"list_payment_link","section_anchor":"payment_links","subsection_anchors":null,"path":"/payment_links/payment_links/list","gate":false,"display_on_load":false},"retrieve_payment_link_line_items":{"title":"Retrieve a payment link's line items","group_title":"Payment Links","group_anchor":"payment_links_section","anchor":"retrieve_payment_link_line_items","section_anchor":"payment_links","subsection_anchors":null,"path":"/payment_links/line_items","gate":false,"display_on_load":false},"credit_notes":{"title":"Credit Notes","group_title":"Billing","group_anchor":"billing","anchor":"credit_notes","section_anchor":"credit_notes","subsection_anchors":["credit_note_object","credit_note_line_item_object","preview_credit_note","create_credit_note","retrieve_credit_note","update_credit_note","credit_note_lines","credit_note_preview_lines","void_credit_note","list_credit_notes"],"path":"/credit_notes","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Credit Note","description":"Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit Notes](/docs/billing/invoices/credit-notes).\n","section_tag":"credit_notes","subsection_summaries":[{"anchor":"credit_note_object","curl_definition":null},{"anchor":"credit_note_line_item_object","curl_definition":null},{"anchor":"preview_credit_note","curl_definition":"GET /v1/credit_notes/preview"},{"anchor":"create_credit_note","curl_definition":"POST /v1/credit_notes"},{"anchor":"retrieve_credit_note","curl_definition":"GET /v1/credit_notes/:id"},{"anchor":"update_credit_note","curl_definition":"POST /v1/credit_notes/:id"},{"anchor":"credit_note_lines","curl_definition":"GET /v1/credit_notes/:credit_note/lines"},{"anchor":"credit_note_preview_lines","curl_definition":"GET /v1/credit_notes/preview/lines"},{"anchor":"void_credit_note","curl_definition":"POST /v1/credit_notes/:id/void"},{"anchor":"list_credit_notes","curl_definition":"GET /v1/credit_notes"}]}},"credit_note_object":{"title":"The credit note object","group_title":"Billing","group_anchor":"billing","anchor":"credit_note_object","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/object","gate":false,"display_on_load":false},"credit_note_line_item_object":{"title":"The (Credit Note) line item object","group_title":"Billing","group_anchor":"billing","anchor":"credit_note_line_item_object","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/line_item","gate":false,"display_on_load":false},"preview_credit_note":{"title":"Preview a credit note","group_title":"Billing","group_anchor":"billing","anchor":"preview_credit_note","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/preview","gate":false,"display_on_load":false},"create_credit_note":{"title":"Create a credit note","group_title":"Billing","group_anchor":"billing","anchor":"create_credit_note","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/create","gate":false,"display_on_load":false},"retrieve_credit_note":{"title":"Retrieve a credit note","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_credit_note","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/retrieve","gate":false,"display_on_load":false},"update_credit_note":{"title":"Update a credit note","group_title":"Billing","group_anchor":"billing","anchor":"update_credit_note","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/update","gate":false,"display_on_load":false},"credit_note_lines":{"title":"Retrieve a credit note's line items","group_title":"Billing","group_anchor":"billing","anchor":"credit_note_lines","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/lines","gate":false,"display_on_load":false},"credit_note_preview_lines":{"title":"Retrieve a credit note preview's line items","group_title":"Billing","group_anchor":"billing","anchor":"credit_note_preview_lines","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/preview_lines","gate":false,"display_on_load":false},"void_credit_note":{"title":"Void a credit note","group_title":"Billing","group_anchor":"billing","anchor":"void_credit_note","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/void","gate":false,"display_on_load":false},"list_credit_notes":{"title":"List all credit notes","group_title":"Billing","group_anchor":"billing","anchor":"list_credit_notes","section_anchor":"credit_notes","subsection_anchors":null,"path":"/credit_notes/list","gate":false,"display_on_load":false},"customer_balance_transactions":{"title":"Customer Balance Transactions","group_title":"Billing","group_anchor":"billing","anchor":"customer_balance_transactions","section_anchor":"customer_balance_transactions","subsection_anchors":["customer_balance_transaction_object","create_customer_balance_transaction","retrieve_customer_balance_transaction","update_customer_balance_transaction","list_customer_balance_transactions"],"path":"/customer_balance_transactions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Customer Balance Transaction","description":"Each customer has a [`balance`](/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer Balance](/docs/billing/customer/balance) to learn more.\n","section_tag":"customer_balance_transactions","subsection_summaries":[{"anchor":"customer_balance_transaction_object","curl_definition":null},{"anchor":"create_customer_balance_transaction","curl_definition":"POST /v1/customers/:id/balance_transactions"},{"anchor":"retrieve_customer_balance_transaction","curl_definition":"GET /v1/customers/:id/balance_transactions/:id"},{"anchor":"update_customer_balance_transaction","curl_definition":"POST /v1/customers/:id/balance_transactions/:id"},{"anchor":"list_customer_balance_transactions","curl_definition":"GET /v1/customers/:id/balance_transactions"}]}},"customer_balance_transaction_object":{"title":"The customer balance transaction object","group_title":"Billing","group_anchor":"billing","anchor":"customer_balance_transaction_object","section_anchor":"customer_balance_transactions","subsection_anchors":null,"path":"/customer_balance_transactions/object","gate":false,"display_on_load":false},"create_customer_balance_transaction":{"title":"Create a customer balance transaction","group_title":"Billing","group_anchor":"billing","anchor":"create_customer_balance_transaction","section_anchor":"customer_balance_transactions","subsection_anchors":null,"path":"/customer_balance_transactions/create","gate":false,"display_on_load":false},"retrieve_customer_balance_transaction":{"title":"Retrieve a customer balance transaction","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_customer_balance_transaction","section_anchor":"customer_balance_transactions","subsection_anchors":null,"path":"/customer_balance_transactions/retrieve","gate":false,"display_on_load":false},"update_customer_balance_transaction":{"title":"Update a customer credit balance transaction","group_title":"Billing","group_anchor":"billing","anchor":"update_customer_balance_transaction","section_anchor":"customer_balance_transactions","subsection_anchors":null,"path":"/customer_balance_transactions/update","gate":false,"display_on_load":false},"list_customer_balance_transactions":{"title":"List customer balance transactions","group_title":"Billing","group_anchor":"billing","anchor":"list_customer_balance_transactions","section_anchor":"customer_balance_transactions","subsection_anchors":null,"path":"/customer_balance_transactions/list","gate":false,"display_on_load":false},"customer_portal":{"title":"Customer Portal","group_title":"Billing","group_anchor":"billing","anchor":"customer_portal","section_anchor":"customer_portal","subsection_anchors":["portal_session_object","portal_configuration_object","create_portal_session","create_portal_configuration","update_portal_configuration","retrieve_portal_configuration","all_portal_configurations"],"path":"/customer_portal","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Customer Portal","description":"The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nLearn more in the [integration guide](/docs/billing/subscriptions/integrating-customer-portal).\n","section_tag":"customer_portal","subsection_summaries":[{"anchor":"portal_session_object","curl_definition":null},{"anchor":"portal_configuration_object","curl_definition":null},{"anchor":"create_portal_session","curl_definition":"POST /v1/billing_portal/sessions"},{"anchor":"create_portal_configuration","curl_definition":"POST /v1/billing_portal/configurations"},{"anchor":"update_portal_configuration","curl_definition":"POST /v1/billing_portal/configurations/:id"},{"anchor":"retrieve_portal_configuration","curl_definition":"GET /v1/billing_portal/configurations/:id"},{"anchor":"all_portal_configurations","curl_definition":"GET /v1/billing_portal/configurations"}]}},"portal_session_object":{"title":"The portal session object","group_title":"Billing","group_anchor":"billing","anchor":"portal_session_object","section_anchor":"customer_portal","subsection_anchors":null,"path":"/customer_portal/session","gate":false,"display_on_load":false},"portal_configuration_object":{"title":"The portal configuration object","group_title":"Billing","group_anchor":"billing","anchor":"portal_configuration_object","section_anchor":"customer_portal","subsection_anchors":null,"path":"/customer_portal/configuration","gate":false,"display_on_load":false},"create_portal_session":{"title":"Create a portal session","group_title":"Billing","group_anchor":"billing","anchor":"create_portal_session","section_anchor":"customer_portal","subsection_anchors":null,"path":"/customer_portal/sessions/create","gate":false,"display_on_load":false},"create_portal_configuration":{"title":"Create a portal configuration","group_title":"Billing","group_anchor":"billing","anchor":"create_portal_configuration","section_anchor":"customer_portal","subsection_anchors":null,"path":"/customer_portal/configurations/create","gate":false,"display_on_load":false},"update_portal_configuration":{"title":"Update a portal configuration","group_title":"Billing","group_anchor":"billing","anchor":"update_portal_configuration","section_anchor":"customer_portal","subsection_anchors":null,"path":"/customer_portal/configurations/update","gate":false,"display_on_load":false},"retrieve_portal_configuration":{"title":"Retrieve a portal configuration","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_portal_configuration","section_anchor":"customer_portal","subsection_anchors":null,"path":"/customer_portal/configurations/retrieve","gate":false,"display_on_load":false},"all_portal_configurations":{"title":"List portal configurations","group_title":"Billing","group_anchor":"billing","anchor":"all_portal_configurations","section_anchor":"customer_portal","subsection_anchors":null,"path":"/customer_portal/configurations/list","gate":false,"display_on_load":false},"customer_tax_ids":{"title":"Customer Tax IDs","group_title":"Billing","group_anchor":"billing","anchor":"customer_tax_ids","section_anchor":"customer_tax_ids","subsection_anchors":["tax_id_object","create_tax_id","retrieve_tax_id","delete_tax_id","list_tax_ids"],"path":"/customer_tax_ids","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Customer Tax IDs","description":"You can add one or multiple tax IDs to a [customer](/docs/api/customers).\nA customer's tax IDs are displayed on invoices and credit notes issued for the customer.\n\nRelated guide: [Customer Tax Identification Numbers](/docs/billing/taxes/tax-ids).\n","section_tag":"customer_tax_ids","subsection_summaries":[{"anchor":"tax_id_object","curl_definition":null},{"anchor":"create_tax_id","curl_definition":"POST /v1/customers/:id/tax_ids"},{"anchor":"retrieve_tax_id","curl_definition":"GET /v1/customers/:id/tax_ids/:id"},{"anchor":"delete_tax_id","curl_definition":"DELETE /v1/customers/:id/tax_ids/:id"},{"anchor":"list_tax_ids","curl_definition":"GET /v1/customers/:id/tax_ids"}]}},"tax_id_object":{"title":"The tax ID object","group_title":"Billing","group_anchor":"billing","anchor":"tax_id_object","section_anchor":"customer_tax_ids","subsection_anchors":null,"path":"/customer_tax_ids/object","gate":false,"display_on_load":false},"create_tax_id":{"title":"Create a tax ID","group_title":"Billing","group_anchor":"billing","anchor":"create_tax_id","section_anchor":"customer_tax_ids","subsection_anchors":null,"path":"/customer_tax_ids/create","gate":false,"display_on_load":false},"retrieve_tax_id":{"title":"Retrieve a tax ID","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_tax_id","section_anchor":"customer_tax_ids","subsection_anchors":null,"path":"/customer_tax_ids/retrieve","gate":false,"display_on_load":false},"delete_tax_id":{"title":"Delete a tax ID","group_title":"Billing","group_anchor":"billing","anchor":"delete_tax_id","section_anchor":"customer_tax_ids","subsection_anchors":null,"path":"/customer_tax_ids/delete","gate":false,"display_on_load":false},"list_tax_ids":{"title":"List all tax IDs","group_title":"Billing","group_anchor":"billing","anchor":"list_tax_ids","section_anchor":"customer_tax_ids","subsection_anchors":null,"path":"/customer_tax_ids/list","gate":false,"display_on_load":false},"invoices":{"title":"Invoices","group_title":"Billing","group_anchor":"billing","anchor":"invoices","section_anchor":"invoices","subsection_anchors":["invoice_object","invoice_line_item_object","create_invoice","retrieve_invoice","update_invoice","delete_invoice","finalize_invoice","pay_invoice","send_invoice","void_invoice","mark_uncollectible_invoice","invoice_lines","upcoming_invoice","upcoming_invoice_lines","list_invoices","search_invoices"],"path":"/invoices","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Invoices","description":"Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](/docs/billing/invoices/workflow/#auto_advance), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](/docs/billing/customer/balance).\n\nRelated guide: [Send Invoices to Customers](/docs/billing/invoices/sending).\n","section_tag":"invoices","subsection_summaries":[{"anchor":"invoice_object","curl_definition":null},{"anchor":"invoice_line_item_object","curl_definition":null},{"anchor":"create_invoice","curl_definition":"POST /v1/invoices"},{"anchor":"retrieve_invoice","curl_definition":"GET /v1/invoices/:id"},{"anchor":"update_invoice","curl_definition":"POST /v1/invoices/:id"},{"anchor":"delete_invoice","curl_definition":"DELETE /v1/invoices/:id"},{"anchor":"finalize_invoice","curl_definition":"POST /v1/invoices/:id/finalize"},{"anchor":"pay_invoice","curl_definition":"POST /v1/invoices/:id/pay"},{"anchor":"send_invoice","curl_definition":"POST /v1/invoices/:id/send"},{"anchor":"void_invoice","curl_definition":"POST /v1/invoices/:id/void"},{"anchor":"mark_uncollectible_invoice","curl_definition":"POST /v1/invoices/:id/mark_uncollectible"},{"anchor":"invoice_lines","curl_definition":"GET /v1/invoices/:id/lines"},{"anchor":"upcoming_invoice","curl_definition":"GET /v1/invoices/upcoming"},{"anchor":"upcoming_invoice_lines","curl_definition":"GET /v1/invoices/upcoming/lines"},{"anchor":"list_invoices","curl_definition":"GET /v1/invoices"},{"anchor":"search_invoices","curl_definition":"GET /v1/invoices/search"}]}},"invoice_object":{"title":"The Invoice object","group_title":"Billing","group_anchor":"billing","anchor":"invoice_object","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/object","gate":false,"display_on_load":false},"invoice_line_item_object":{"title":"The (Invoice) Line Item object","group_title":"Billing","group_anchor":"billing","anchor":"invoice_line_item_object","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/line_item","gate":false,"display_on_load":false},"create_invoice":{"title":"Create an invoice","group_title":"Billing","group_anchor":"billing","anchor":"create_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/create","gate":false,"display_on_load":false},"retrieve_invoice":{"title":"Retrieve an invoice","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/retrieve","gate":false,"display_on_load":false},"update_invoice":{"title":"Update an invoice","group_title":"Billing","group_anchor":"billing","anchor":"update_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/update","gate":false,"display_on_load":false},"delete_invoice":{"title":"Delete a draft invoice","group_title":"Billing","group_anchor":"billing","anchor":"delete_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/delete","gate":false,"display_on_load":false},"finalize_invoice":{"title":"Finalize an invoice","group_title":"Billing","group_anchor":"billing","anchor":"finalize_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/finalize","gate":false,"display_on_load":false},"pay_invoice":{"title":"Pay an invoice","group_title":"Billing","group_anchor":"billing","anchor":"pay_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/pay","gate":false,"display_on_load":false},"send_invoice":{"title":"Send an invoice for manual payment","group_title":"Billing","group_anchor":"billing","anchor":"send_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/send","gate":false,"display_on_load":false},"void_invoice":{"title":"Void an invoice","group_title":"Billing","group_anchor":"billing","anchor":"void_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/void","gate":false,"display_on_load":false},"mark_uncollectible_invoice":{"title":"Mark an invoice as uncollectible","group_title":"Billing","group_anchor":"billing","anchor":"mark_uncollectible_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/mark_uncollectible","gate":false,"display_on_load":false},"invoice_lines":{"title":"Retrieve an invoice's line items","group_title":"Billing","group_anchor":"billing","anchor":"invoice_lines","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/invoice_lines","gate":false,"display_on_load":false},"upcoming_invoice":{"title":"Retrieve an upcoming invoice","group_title":"Billing","group_anchor":"billing","anchor":"upcoming_invoice","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/upcoming","gate":false,"display_on_load":false},"upcoming_invoice_lines":{"title":"Retrieve an upcoming invoice's line items","group_title":"Billing","group_anchor":"billing","anchor":"upcoming_invoice_lines","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/upcoming_invoice_lines","gate":false,"display_on_load":false},"list_invoices":{"title":"List all invoices","group_title":"Billing","group_anchor":"billing","anchor":"list_invoices","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/list","gate":false,"display_on_load":false},"search_invoices":{"title":"Search invoices","group_title":"Billing","group_anchor":"billing","anchor":"search_invoices","section_anchor":"invoices","subsection_anchors":null,"path":"/invoices/search","gate":false,"display_on_load":false},"invoiceitems":{"title":"Invoice Items","group_title":"Billing","group_anchor":"billing","anchor":"invoiceitems","section_anchor":"invoiceitems","subsection_anchors":["invoiceitem_object","create_invoiceitem","retrieve_invoiceitem","update_invoiceitem","delete_invoiceitem","list_invoiceitems"],"path":"/invoiceitems","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Invoice Items","description":"Invoice Items represent the component lines of an [invoice](/docs/api/invoices). An invoice item is added to an\ninvoice by creating or updating it with an `invoice` field, at which point it will be included as\n[an invoice line item](/docs/api/invoices/line_item) within\n[invoice.lines](/docs/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](/docs/invoicing/integration), [Subscription Invoices](/docs/billing/invoices/subscription#adding-upcoming-invoice-items).\n","section_tag":"invoiceitems","subsection_summaries":[{"anchor":"invoiceitem_object","curl_definition":null},{"anchor":"create_invoiceitem","curl_definition":"POST /v1/invoiceitems"},{"anchor":"retrieve_invoiceitem","curl_definition":"GET /v1/invoiceitems/:id"},{"anchor":"update_invoiceitem","curl_definition":"POST /v1/invoiceitems/:id"},{"anchor":"delete_invoiceitem","curl_definition":"DELETE /v1/invoiceitems/:id"},{"anchor":"list_invoiceitems","curl_definition":"GET /v1/invoiceitems"}]}},"invoiceitem_object":{"title":"The invoiceitem object","group_title":"Billing","group_anchor":"billing","anchor":"invoiceitem_object","section_anchor":"invoiceitems","subsection_anchors":null,"path":"/invoiceitems/object","gate":false,"display_on_load":false},"create_invoiceitem":{"title":"Create an invoice item","group_title":"Billing","group_anchor":"billing","anchor":"create_invoiceitem","section_anchor":"invoiceitems","subsection_anchors":null,"path":"/invoiceitems/create","gate":false,"display_on_load":false},"retrieve_invoiceitem":{"title":"Retrieve an invoice item","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_invoiceitem","section_anchor":"invoiceitems","subsection_anchors":null,"path":"/invoiceitems/retrieve","gate":false,"display_on_load":false},"update_invoiceitem":{"title":"Update an invoice item","group_title":"Billing","group_anchor":"billing","anchor":"update_invoiceitem","section_anchor":"invoiceitems","subsection_anchors":null,"path":"/invoiceitems/update","gate":false,"display_on_load":false},"delete_invoiceitem":{"title":"Delete an invoice item","group_title":"Billing","group_anchor":"billing","anchor":"delete_invoiceitem","section_anchor":"invoiceitems","subsection_anchors":null,"path":"/invoiceitems/delete","gate":false,"display_on_load":false},"list_invoiceitems":{"title":"List all invoice items","group_title":"Billing","group_anchor":"billing","anchor":"list_invoiceitems","section_anchor":"invoiceitems","subsection_anchors":null,"path":"/invoiceitems/list","gate":false,"display_on_load":false},"plans":{"title":"Plans","group_title":"Billing","group_anchor":"billing","anchor":"plans","section_anchor":"plans","subsection_anchors":["plan_object","create_plan","retrieve_plan","update_plan","delete_plan","list_plans"],"path":"/plans","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Plans","description":"You can now model subscriptions more flexibly using the [Prices 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](#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](/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](/docs/products-prices/overview).\n","section_tag":"plans","subsection_summaries":[{"anchor":"plan_object","curl_definition":null},{"anchor":"create_plan","curl_definition":"POST /v1/plans"},{"anchor":"retrieve_plan","curl_definition":"GET /v1/plans/:id"},{"anchor":"update_plan","curl_definition":"POST /v1/plans/:id"},{"anchor":"delete_plan","curl_definition":"DELETE /v1/plans/:id"},{"anchor":"list_plans","curl_definition":"GET /v1/plans"}]}},"plan_object":{"title":"The plan object","group_title":"Billing","group_anchor":"billing","anchor":"plan_object","section_anchor":"plans","subsection_anchors":null,"path":"/plans/object","gate":false,"display_on_load":false},"create_plan":{"title":"Create a plan","group_title":"Billing","group_anchor":"billing","anchor":"create_plan","section_anchor":"plans","subsection_anchors":null,"path":"/plans/create","gate":false,"display_on_load":false},"retrieve_plan":{"title":"Retrieve a plan","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_plan","section_anchor":"plans","subsection_anchors":null,"path":"/plans/retrieve","gate":false,"display_on_load":false},"update_plan":{"title":"Update a plan","group_title":"Billing","group_anchor":"billing","anchor":"update_plan","section_anchor":"plans","subsection_anchors":null,"path":"/plans/update","gate":false,"display_on_load":false},"delete_plan":{"title":"Delete a plan","group_title":"Billing","group_anchor":"billing","anchor":"delete_plan","section_anchor":"plans","subsection_anchors":null,"path":"/plans/delete","gate":false,"display_on_load":false},"list_plans":{"title":"List all plans","group_title":"Billing","group_anchor":"billing","anchor":"list_plans","section_anchor":"plans","subsection_anchors":null,"path":"/plans/list","gate":false,"display_on_load":false},"quotes":{"title":"Quotes","group_title":"Billing","group_anchor":"billing","anchor":"quotes","section_anchor":"quotes","subsection_anchors":["quote_object","create_quote","retrieve_quote","update_quote","finalize_quote","accept_quote","cancel_quote","download_pdf_method","list_line_item","list_upfront_line_item","list_quote"],"path":"/quotes","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Quote","description":"A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule.\n","section_tag":"quotes","subsection_summaries":[{"anchor":"quote_object","curl_definition":null},{"anchor":"create_quote","curl_definition":"POST /v1/quotes"},{"anchor":"retrieve_quote","curl_definition":"GET /v1/quotes/:id"},{"anchor":"update_quote","curl_definition":"POST /v1/quotes/:id"},{"anchor":"finalize_quote","curl_definition":"POST /v1/quotes/:id/finalize"},{"anchor":"accept_quote","curl_definition":"POST /v1/quotes/:id/accept"},{"anchor":"cancel_quote","curl_definition":"POST /v1/quotes/:id/cancel"},{"anchor":"download_pdf_method","curl_definition":"GET https://files.stripe.com/v1/quotes/:id/pdf"},{"anchor":"list_line_item","curl_definition":"GET /v1/quotes/:id/line_items"},{"anchor":"list_upfront_line_item","curl_definition":"GET /v1/quotes/:id/computed_upfront_line_items"},{"anchor":"list_quote","curl_definition":"GET /v1/quotes"}]}},"quote_object":{"title":"The quote object","group_title":"Billing","group_anchor":"billing","anchor":"quote_object","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/object","gate":false,"display_on_load":false},"create_quote":{"title":"Create a quote","group_title":"Billing","group_anchor":"billing","anchor":"create_quote","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/create","gate":false,"display_on_load":false},"retrieve_quote":{"title":"Retrieve a quote","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_quote","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/retrieve","gate":false,"display_on_load":false},"update_quote":{"title":"Update a quote","group_title":"Billing","group_anchor":"billing","anchor":"update_quote","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/update","gate":false,"display_on_load":false},"finalize_quote":{"title":"Finalize a quote","group_title":"Billing","group_anchor":"billing","anchor":"finalize_quote","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/finalize","gate":false,"display_on_load":false},"accept_quote":{"title":"Accept a quote","group_title":"Billing","group_anchor":"billing","anchor":"accept_quote","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/accept","gate":false,"display_on_load":false},"cancel_quote":{"title":"Cancel a quote","group_title":"Billing","group_anchor":"billing","anchor":"cancel_quote","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/cancel","gate":false,"display_on_load":false},"download_pdf_method":{"title":"Download quote PDF","group_title":"Billing","group_anchor":"billing","anchor":"download_pdf_method","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/pdf","gate":false,"display_on_load":false},"list_line_item":{"title":"Retrieve a quote's line items","group_title":"Billing","group_anchor":"billing","anchor":"list_line_item","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/line_items/list","gate":false,"display_on_load":false},"list_upfront_line_item":{"title":"Retrieve a quote's upfront line items","group_title":"Billing","group_anchor":"billing","anchor":"list_upfront_line_item","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/line_items/upfront/list","gate":false,"display_on_load":false},"list_quote":{"title":"List all quotes","group_title":"Billing","group_anchor":"billing","anchor":"list_quote","section_anchor":"quotes","subsection_anchors":null,"path":"/quotes/list","gate":false,"display_on_load":false},"subscriptions":{"title":"Subscriptions","group_title":"Billing","group_anchor":"billing","anchor":"subscriptions","section_anchor":"subscriptions","subsection_anchors":["subscription_object","create_subscription","retrieve_subscription","update_subscription","resume_subscription","cancel_subscription","list_subscriptions","subscriptions_search"],"path":"/subscriptions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Subscriptions","description":"Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating Subscriptions](/docs/billing/subscriptions/creating).\n","section_tag":"subscriptions","subsection_summaries":[{"anchor":"subscription_object","curl_definition":null},{"anchor":"create_subscription","curl_definition":"POST /v1/subscriptions"},{"anchor":"retrieve_subscription","curl_definition":"GET /v1/subscriptions/:id"},{"anchor":"update_subscription","curl_definition":"POST /v1/subscriptions/:id"},{"anchor":"resume_subscription","curl_definition":"POST /v1/subscriptions/:id/resume"},{"anchor":"cancel_subscription","curl_definition":"DELETE /v1/subscriptions/:id"},{"anchor":"list_subscriptions","curl_definition":"GET /v1/subscriptions"},{"anchor":"subscriptions_search","curl_definition":"GET /v1/subscriptions/search"}]}},"subscription_object":{"title":"The subscription object","group_title":"Billing","group_anchor":"billing","anchor":"subscription_object","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/object","gate":false,"display_on_load":false},"create_subscription":{"title":"Create a subscription","group_title":"Billing","group_anchor":"billing","anchor":"create_subscription","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/create","gate":false,"display_on_load":false},"retrieve_subscription":{"title":"Retrieve a subscription","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_subscription","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/retrieve","gate":false,"display_on_load":false},"update_subscription":{"title":"Update a subscription","group_title":"Billing","group_anchor":"billing","anchor":"update_subscription","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/update","gate":false,"display_on_load":false},"resume_subscription":{"title":"Resume a subscription","group_title":"Billing","group_anchor":"billing","anchor":"resume_subscription","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/resume","gate":false,"display_on_load":false},"cancel_subscription":{"title":"Cancel a subscription","group_title":"Billing","group_anchor":"billing","anchor":"cancel_subscription","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/cancel","gate":false,"display_on_load":false},"list_subscriptions":{"title":"List subscriptions","group_title":"Billing","group_anchor":"billing","anchor":"list_subscriptions","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/list","gate":false,"display_on_load":false},"subscriptions_search":{"title":"Search subscriptions","group_title":"Billing","group_anchor":"billing","anchor":"subscriptions_search","section_anchor":"subscriptions","subsection_anchors":null,"path":"/subscriptions/search","gate":false,"display_on_load":false},"subscription_items":{"title":"Subscription Items","group_title":"Billing","group_anchor":"billing","anchor":"subscription_items","section_anchor":"subscription_items","subsection_anchors":["subscription_item_object","create_subscription_item","retrieve_subscription_item","update_subscription_item","delete_subscription_item","list_subscription_items"],"path":"/subscription_items","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Subscription Items","description":"Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.\n","section_tag":"subscription_items","subsection_summaries":[{"anchor":"subscription_item_object","curl_definition":null},{"anchor":"create_subscription_item","curl_definition":"POST /v1/subscription_items"},{"anchor":"retrieve_subscription_item","curl_definition":"GET /v1/subscription_items/:id"},{"anchor":"update_subscription_item","curl_definition":"POST /v1/subscription_items/:id"},{"anchor":"delete_subscription_item","curl_definition":"DELETE /v1/subscription_items/:id"},{"anchor":"list_subscription_items","curl_definition":"GET /v1/subscription_items"}]}},"subscription_item_object":{"title":"The subscription item object","group_title":"Billing","group_anchor":"billing","anchor":"subscription_item_object","section_anchor":"subscription_items","subsection_anchors":null,"path":"/subscription_items/object","gate":false,"display_on_load":false},"create_subscription_item":{"title":"Create a subscription item","group_title":"Billing","group_anchor":"billing","anchor":"create_subscription_item","section_anchor":"subscription_items","subsection_anchors":null,"path":"/subscription_items/create","gate":false,"display_on_load":false},"retrieve_subscription_item":{"title":"Retrieve a subscription item","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_subscription_item","section_anchor":"subscription_items","subsection_anchors":null,"path":"/subscription_items/retrieve","gate":false,"display_on_load":false},"update_subscription_item":{"title":"Update a subscription item","group_title":"Billing","group_anchor":"billing","anchor":"update_subscription_item","section_anchor":"subscription_items","subsection_anchors":null,"path":"/subscription_items/update","gate":false,"display_on_load":false},"delete_subscription_item":{"title":"Delete a subscription item","group_title":"Billing","group_anchor":"billing","anchor":"delete_subscription_item","section_anchor":"subscription_items","subsection_anchors":null,"path":"/subscription_items/delete","gate":false,"display_on_load":false},"list_subscription_items":{"title":"List all subscription items","group_title":"Billing","group_anchor":"billing","anchor":"list_subscription_items","section_anchor":"subscription_items","subsection_anchors":null,"path":"/subscription_items/list","gate":false,"display_on_load":false},"subscription_schedules":{"title":"Subscription Schedules","group_title":"Billing","group_anchor":"billing","anchor":"subscription_schedules","section_anchor":"subscription_schedules","subsection_anchors":["subscription_schedule_object","create_subscription_schedule","retrieve_subscription_schedule","update_subscription_schedule","cancel_subscription_schedule","release_subscription_schedule","list_subscription_schedules"],"path":"/subscription_schedules","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Subscription Schedule","description":"A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription Schedules](/docs/billing/subscriptions/subscription-schedules).\n","section_tag":"subscription_schedules","subsection_summaries":[{"anchor":"subscription_schedule_object","curl_definition":null},{"anchor":"create_subscription_schedule","curl_definition":"POST /v1/subscription_schedules"},{"anchor":"retrieve_subscription_schedule","curl_definition":"GET /v1/subscription_schedules/:id"},{"anchor":"update_subscription_schedule","curl_definition":"POST /v1/subscription_schedules/:id"},{"anchor":"cancel_subscription_schedule","curl_definition":"POST /v1/subscription_schedules/:id/cancel"},{"anchor":"release_subscription_schedule","curl_definition":"POST /v1/subscription_schedules/:id/release"},{"anchor":"list_subscription_schedules","curl_definition":"GET /v1/subscription_schedules"}]}},"subscription_schedule_object":{"title":"The schedule object","group_title":"Billing","group_anchor":"billing","anchor":"subscription_schedule_object","section_anchor":"subscription_schedules","subsection_anchors":null,"path":"/subscription_schedules/object","gate":false,"display_on_load":false},"create_subscription_schedule":{"title":"Create a schedule","group_title":"Billing","group_anchor":"billing","anchor":"create_subscription_schedule","section_anchor":"subscription_schedules","subsection_anchors":null,"path":"/subscription_schedules/create","gate":false,"display_on_load":false},"retrieve_subscription_schedule":{"title":"Retrieve a schedule","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_subscription_schedule","section_anchor":"subscription_schedules","subsection_anchors":null,"path":"/subscription_schedules/retrieve","gate":false,"display_on_load":false},"update_subscription_schedule":{"title":"Update a schedule","group_title":"Billing","group_anchor":"billing","anchor":"update_subscription_schedule","section_anchor":"subscription_schedules","subsection_anchors":null,"path":"/subscription_schedules/update","gate":false,"display_on_load":false},"cancel_subscription_schedule":{"title":"Cancel a schedule","group_title":"Billing","group_anchor":"billing","anchor":"cancel_subscription_schedule","section_anchor":"subscription_schedules","subsection_anchors":null,"path":"/subscription_schedules/cancel","gate":false,"display_on_load":false},"release_subscription_schedule":{"title":"Release a schedule","group_title":"Billing","group_anchor":"billing","anchor":"release_subscription_schedule","section_anchor":"subscription_schedules","subsection_anchors":null,"path":"/subscription_schedules/release","gate":false,"display_on_load":false},"list_subscription_schedules":{"title":"List all schedules","group_title":"Billing","group_anchor":"billing","anchor":"list_subscription_schedules","section_anchor":"subscription_schedules","subsection_anchors":null,"path":"/subscription_schedules/list","gate":false,"display_on_load":false},"test_clocks":{"title":"Test Clocks","group_title":"Billing","group_anchor":"billing","anchor":"test_clocks","section_anchor":"test_clocks","subsection_anchors":["test_clock_object","create_test_clock","retrieve_test_clock","delete_test_clock","advance_test_clock","list_test_clocks"],"path":"/test_clocks","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Test Clocks","description":"A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.\n","section_tag":"test_clocks","subsection_summaries":[{"anchor":"test_clock_object","curl_definition":null},{"anchor":"create_test_clock","curl_definition":"POST /v1/test_helpers/test_clocks"},{"anchor":"retrieve_test_clock","curl_definition":"GET /v1/test_helpers/test_clocks/:id"},{"anchor":"delete_test_clock","curl_definition":"DELETE /v1/test_helpers/test_clocks/:id"},{"anchor":"advance_test_clock","curl_definition":"POST /v1/test_helpers/test_clocks/:id/advance"},{"anchor":"list_test_clocks","curl_definition":"GET /v1/test_helpers/test_clocks"}]}},"test_clock_object":{"title":"The test clock object","group_title":"Billing","group_anchor":"billing","anchor":"test_clock_object","section_anchor":"test_clocks","subsection_anchors":null,"path":"/test_clocks/object","gate":false,"display_on_load":false},"create_test_clock":{"title":"Create a test clock","group_title":"Billing","group_anchor":"billing","anchor":"create_test_clock","section_anchor":"test_clocks","subsection_anchors":null,"path":"/test_clocks/create","gate":false,"display_on_load":false},"retrieve_test_clock":{"title":"Retrieve a test clock","group_title":"Billing","group_anchor":"billing","anchor":"retrieve_test_clock","section_anchor":"test_clocks","subsection_anchors":null,"path":"/test_clocks/retrieve","gate":false,"display_on_load":false},"delete_test_clock":{"title":"Delete a test clock","group_title":"Billing","group_anchor":"billing","anchor":"delete_test_clock","section_anchor":"test_clocks","subsection_anchors":null,"path":"/test_clocks/delete","gate":false,"display_on_load":false},"advance_test_clock":{"title":"Advance a test clock","group_title":"Billing","group_anchor":"billing","anchor":"advance_test_clock","section_anchor":"test_clocks","subsection_anchors":null,"path":"/test_clocks/advance","gate":false,"display_on_load":false},"list_test_clocks":{"title":"List all test clocks","group_title":"Billing","group_anchor":"billing","anchor":"list_test_clocks","section_anchor":"test_clocks","subsection_anchors":null,"path":"/test_clocks/list","gate":false,"display_on_load":false},"usage_records":{"title":"Usage Records","group_title":"Billing","group_anchor":"billing","anchor":"usage_records","section_anchor":"usage_records","subsection_anchors":["usage_record_object","usage_record_create","usage_record_summary_all"],"path":"/usage_records","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Usage Records","description":"Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered Billing](/docs/billing/subscriptions/metered-billing).\n","section_tag":"usage_records","subsection_summaries":[{"anchor":"usage_record_object","curl_definition":null},{"anchor":"usage_record_create","curl_definition":"POST /v1/subscription_items/:id/usage_records"},{"anchor":"usage_record_summary_all","curl_definition":"GET /v1/subscription_items/:id/usage_record_summaries"}]}},"usage_record_object":{"title":"The usage record object","group_title":"Billing","group_anchor":"billing","anchor":"usage_record_object","section_anchor":"usage_records","subsection_anchors":null,"path":"/usage_records/object","gate":false,"display_on_load":false},"usage_record_create":{"title":"Create a usage record","group_title":"Billing","group_anchor":"billing","anchor":"usage_record_create","section_anchor":"usage_records","subsection_anchors":null,"path":"/usage_records/create","gate":false,"display_on_load":false},"usage_record_summary_all":{"title":"List all subscription item period summaries","group_title":"Billing","group_anchor":"billing","anchor":"usage_record_summary_all","section_anchor":"usage_records","subsection_anchors":null,"path":"/usage_records/subscription_item_summary_list","gate":false,"display_on_load":false},"accounts":{"title":"Accounts","group_title":"Connect","group_anchor":"connect","anchor":"accounts","section_anchor":"accounts","subsection_anchors":["account_object","create_account","retrieve_account","update_account","delete_account","reject_account","list_accounts","login_link_object","create_login_link"],"path":"/accounts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Accounts","description":"This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that\naccount has started to go through Connect Onboarding. Once you create an [Account Link](/docs/api/account_links)\nfor a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express**\nbelow. Learn about the differences [between accounts](/docs/connect/accounts).\n","section_tag":"accounts","subsection_summaries":[{"anchor":"account_object","curl_definition":null},{"anchor":"create_account","curl_definition":"POST /v1/accounts"},{"anchor":"retrieve_account","curl_definition":"GET /v1/accounts/:id"},{"anchor":"update_account","curl_definition":"POST /v1/accounts/:id"},{"anchor":"delete_account","curl_definition":"DELETE /v1/accounts/:id"},{"anchor":"reject_account","curl_definition":"POST /v1/accounts/:id/reject"},{"anchor":"list_accounts","curl_definition":"GET /v1/accounts"},{"anchor":"login_link_object","curl_definition":null},{"anchor":"create_login_link","curl_definition":"POST /v1/accounts/:id/login_links"}]}},"account_object":{"title":"The account object","group_title":"Connect","group_anchor":"connect","anchor":"account_object","section_anchor":"accounts","subsection_anchors":null,"path":"/accounts/object","gate":false,"display_on_load":false},"create_account":{"title":"Create an account","group_title":"Connect","group_anchor":"connect","anchor":"create_account","section_anchor":"accounts","subsection_anchors":null,"path":"/accounts/create","gate":false,"display_on_load":false},"retrieve_account":{"title":"Retrieve account","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_account","section_anchor":"accounts","subsection_anchors":null,"path":"/accounts/retrieve","gate":false,"display_on_load":false},"update_account":{"title":"Update an account","group_title":"Connect","group_anchor":"connect","anchor":"update_account","section_anchor":"accounts","subsection_anchors":null,"path":"/accounts/update","gate":false,"display_on_load":false},"delete_account":{"title":"Delete an account","group_title":"Connect","group_anchor":"connect","anchor":"delete_account","section_anchor":"accounts","subsection_anchors":null,"path":"/accounts/delete","gate":false,"display_on_load":false},"reject_account":{"title":"Reject an account","group_title":"Connect","group_anchor":"connect","anchor":"reject_account","section_anchor":"accounts","subsection_anchors":null,"path":"/account/reject","gate":false,"display_on_load":false},"list_accounts":{"title":"List all connected accounts","group_title":"Connect","group_anchor":"connect","anchor":"list_accounts","section_anchor":"accounts","subsection_anchors":null,"path":"/accounts/list","gate":false,"display_on_load":false},"login_link_object":{"title":"The login link object","group_title":"Connect","group_anchor":"connect","anchor":"login_link_object","section_anchor":"accounts","subsection_anchors":null,"path":"/account/login_link","gate":false,"display_on_load":false},"create_login_link":{"title":"Create a login link","group_title":"Connect","group_anchor":"connect","anchor":"create_login_link","section_anchor":"accounts","subsection_anchors":null,"path":"/account/create_login_link","gate":false,"display_on_load":false},"account_links":{"title":"Account Links","group_title":"Connect","group_anchor":"connect","anchor":"account_links","section_anchor":"account_links","subsection_anchors":["account_link_object","create_account_link"],"path":"/account_links","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Account Links","description":"Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](/docs/connect/connect-onboarding).\n","section_tag":"account_links","subsection_summaries":[{"anchor":"account_link_object","curl_definition":null},{"anchor":"create_account_link","curl_definition":"POST /v1/account_links"}]}},"account_link_object":{"title":"The account link object","group_title":"Connect","group_anchor":"connect","anchor":"account_link_object","section_anchor":"account_links","subsection_anchors":null,"path":"/account_links/object","gate":false,"display_on_load":false},"create_account_link":{"title":"Create an account link","group_title":"Connect","group_anchor":"connect","anchor":"create_account_link","section_anchor":"account_links","subsection_anchors":null,"path":"/account_links/create","gate":false,"display_on_load":false},"account_sessions":{"title":"Account Sessions","group_title":"Connect","group_anchor":"connect","anchor":"account_sessions","section_anchor":"account_sessions","subsection_anchors":["account_session_object","create_account_session"],"path":"/account_sessions","gate":true,"display_on_load":false,"data":{"section_type":"resource","title":"Account Session","description":"An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded UIs.\n\nWe recommend that you create an AccountSession each time you need to display an embedded UI\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded UIs](/docs/connect/get-started-connect-embedded-uis).\n","section_tag":"account_sessions","subsection_summaries":[{"anchor":"account_session_object","curl_definition":null},{"anchor":"create_account_session","curl_definition":"POST /v1/account_sessions"}]}},"account_session_object":{"title":"The account session object","group_title":"Connect","group_anchor":"connect","anchor":"account_session_object","section_anchor":"account_sessions","subsection_anchors":null,"path":"/account_sessions/object","gate":false,"display_on_load":false},"create_account_session":{"title":"Create an Account Session","group_title":"Connect","group_anchor":"connect","anchor":"create_account_session","section_anchor":"account_sessions","subsection_anchors":null,"path":"/account_sessions/create","gate":false,"display_on_load":false},"application_fees":{"title":"Application Fees","group_title":"Connect","group_anchor":"connect","anchor":"application_fees","section_anchor":"application_fees","subsection_anchors":["application_fee_object","retrieve_application_fee","list_application_fees"],"path":"/application_fees","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Application Fees","description":"When you collect a transaction fee on top of a charge made for your user\n(using [Connect](/docs/connect)), an `Application Fee` object is created in\nyour account. You can list, retrieve, and refund application fees.\n\nRelated guide: [Collecting Application Fees](/docs/connect/direct-charges#collecting-fees).\n","section_tag":"application_fees","subsection_summaries":[{"anchor":"application_fee_object","curl_definition":null},{"anchor":"retrieve_application_fee","curl_definition":"GET /v1/application_fees/:id"},{"anchor":"list_application_fees","curl_definition":"GET /v1/application_fees"}]}},"application_fee_object":{"title":"The application fee object","group_title":"Connect","group_anchor":"connect","anchor":"application_fee_object","section_anchor":"application_fees","subsection_anchors":null,"path":"/application_fees/object","gate":false,"display_on_load":false},"retrieve_application_fee":{"title":"Retrieve an application fee","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_application_fee","section_anchor":"application_fees","subsection_anchors":null,"path":"/application_fees/retrieve","gate":false,"display_on_load":false},"list_application_fees":{"title":"List all application fees","group_title":"Connect","group_anchor":"connect","anchor":"list_application_fees","section_anchor":"application_fees","subsection_anchors":null,"path":"/application_fees/list","gate":false,"display_on_load":false},"fee_refunds":{"title":"Application Fee Refunds","group_title":"Connect","group_anchor":"connect","anchor":"fee_refunds","section_anchor":"fee_refunds","subsection_anchors":["fee_refund_object","create_fee_refund","retrieve_fee_refund","update_fee_refund","list_fee_refunds"],"path":"/fee_refunds","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Application Fee Refunds","description":"`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding Application Fees](/docs/connect/destination-charges#refunding-app-fee).\n","section_tag":"fee_refunds","subsection_summaries":[{"anchor":"fee_refund_object","curl_definition":null},{"anchor":"create_fee_refund","curl_definition":"POST /v1/application_fees/:id/refunds"},{"anchor":"retrieve_fee_refund","curl_definition":"GET /v1/application_fees/:id/refunds/:id"},{"anchor":"update_fee_refund","curl_definition":"POST /v1/application_fees/:id/refunds/:id"},{"anchor":"list_fee_refunds","curl_definition":"GET /v1/application_fees/:id/refunds"}]}},"fee_refund_object":{"title":"The application fee refund object","group_title":"Connect","group_anchor":"connect","anchor":"fee_refund_object","section_anchor":"fee_refunds","subsection_anchors":null,"path":"/fee_refunds/object","gate":false,"display_on_load":false},"create_fee_refund":{"title":"Create an application fee refund","group_title":"Connect","group_anchor":"connect","anchor":"create_fee_refund","section_anchor":"fee_refunds","subsection_anchors":null,"path":"/fee_refunds/create","gate":false,"display_on_load":false},"retrieve_fee_refund":{"title":"Retrieve an application fee refund","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_fee_refund","section_anchor":"fee_refunds","subsection_anchors":null,"path":"/fee_refunds/retrieve","gate":false,"display_on_load":false},"update_fee_refund":{"title":"Update an application fee refund","group_title":"Connect","group_anchor":"connect","anchor":"update_fee_refund","section_anchor":"fee_refunds","subsection_anchors":null,"path":"/fee_refunds/update","gate":false,"display_on_load":false},"list_fee_refunds":{"title":"List all application fee refunds","group_title":"Connect","group_anchor":"connect","anchor":"list_fee_refunds","section_anchor":"fee_refunds","subsection_anchors":null,"path":"/fee_refunds/list","gate":false,"display_on_load":false},"capabilities":{"title":"Capabilities","group_title":"Connect","group_anchor":"connect","anchor":"capabilities","section_anchor":"capabilities","subsection_anchors":["capability_object","retrieve_capability","update_capability","list_capability"],"path":"/capabilities","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Capabilities","description":"This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](/docs/connect/account-capabilities).\n","section_tag":"capabilities","subsection_summaries":[{"anchor":"capability_object","curl_definition":null},{"anchor":"retrieve_capability","curl_definition":"GET /v1/accounts/:id/capabilities/:id"},{"anchor":"update_capability","curl_definition":"POST /v1/accounts/:id/capabilities/:id"},{"anchor":"list_capability","curl_definition":"GET /v1/accounts/:id/capabilities"}]}},"capability_object":{"title":"The capability object","group_title":"Connect","group_anchor":"connect","anchor":"capability_object","section_anchor":"capabilities","subsection_anchors":null,"path":"/capabilities/object","gate":false,"display_on_load":false},"retrieve_capability":{"title":"Retrieve an Account Capability","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_capability","section_anchor":"capabilities","subsection_anchors":null,"path":"/capabilities/retrieve","gate":false,"display_on_load":false},"update_capability":{"title":"Update an Account Capability","group_title":"Connect","group_anchor":"connect","anchor":"update_capability","section_anchor":"capabilities","subsection_anchors":null,"path":"/capabilities/update","gate":false,"display_on_load":false},"list_capability":{"title":"List all account capabilities","group_title":"Connect","group_anchor":"connect","anchor":"list_capability","section_anchor":"capabilities","subsection_anchors":null,"path":"/capabilities/list","gate":false,"display_on_load":false},"country_specs":{"title":"Country Specs","group_title":"Connect","group_anchor":"connect","anchor":"country_specs","section_anchor":"country_specs","subsection_anchors":["country_spec_object","list_country_specs","retrieve_country_spec"],"path":"/country_specs","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Country Specs","description":"Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information).\n","section_tag":"country_specs","subsection_summaries":[{"anchor":"country_spec_object","curl_definition":null},{"anchor":"list_country_specs","curl_definition":"GET /v1/country_specs"},{"anchor":"retrieve_country_spec","curl_definition":"GET /v1/country_specs/:id"}]}},"country_spec_object":{"title":"The country spec object","group_title":"Connect","group_anchor":"connect","anchor":"country_spec_object","section_anchor":"country_specs","subsection_anchors":null,"path":"/country_specs/object","gate":false,"display_on_load":false},"list_country_specs":{"title":"List Country Specs","group_title":"Connect","group_anchor":"connect","anchor":"list_country_specs","section_anchor":"country_specs","subsection_anchors":null,"path":"/country_specs/list","gate":false,"display_on_load":false},"retrieve_country_spec":{"title":"Retrieve a Country Spec","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_country_spec","section_anchor":"country_specs","subsection_anchors":null,"path":"/country_specs/retrieve","gate":false,"display_on_load":false},"external_accounts":{"title":"External Accounts","group_title":"Connect","group_anchor":"connect","anchor":"external_accounts","section_anchor":"external_accounts","subsection_anchors":["account_bank_account_object","account_create_bank_account","account_retrieve_bank_account","account_update_bank_account","account_delete_bank_account","account_list_bank_accounts","account_card_object","account_create_card","account_retrieve_card","account_update_card","account_delete_card","account_list_cards"],"path":"/external_accounts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"External Accounts","description":"External Accounts are transfer destinations on `Account` objects for\n[connected accounts](/docs/connect/accounts). They can be bank accounts or\ndebit cards.\n\n[Bank accounts](/docs/api#customer_bank_account_object) and [debit\ncards](/docs/api#card_object) can also be used as payment sources\non regular charges, and are documented in the links above.\n\nRelated guide: [Setting Bank and Debit Card Payouts](/docs/connect/bank-debit-card-payouts).\n","section_tag":"external_accounts","subsection_summaries":[{"anchor":"account_bank_account_object","curl_definition":null},{"anchor":"account_create_bank_account","curl_definition":"POST /v1/accounts/:id/external_accounts"},{"anchor":"account_retrieve_bank_account","curl_definition":"GET /v1/accounts/:id/external_accounts/:id"},{"anchor":"account_update_bank_account","curl_definition":"POST /v1/accounts/:id/external_accounts/:id"},{"anchor":"account_delete_bank_account","curl_definition":"DELETE /v1/accounts/:id/external_accounts/:id"},{"anchor":"account_list_bank_accounts","curl_definition":"GET /v1/accounts/:id/external_accounts?object=bank_account"},{"anchor":"account_card_object","curl_definition":null},{"anchor":"account_create_card","curl_definition":"POST /v1/accounts/:id/external_accounts"},{"anchor":"account_retrieve_card","curl_definition":"GET /v1/accounts/:id/external_accounts/:id"},{"anchor":"account_update_card","curl_definition":"POST /v1/accounts/:id/external_accounts/:id"},{"anchor":"account_delete_card","curl_definition":"DELETE /v1/accounts/:id/external_accounts/:id"},{"anchor":"account_list_cards","curl_definition":"GET /v1/accounts/:id/external_accounts?object=card"}]}},"account_bank_account_object":{"title":"The (account) bank account object","group_title":"Connect","group_anchor":"connect","anchor":"account_bank_account_object","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_bank_accounts/object","gate":false,"display_on_load":false},"account_create_bank_account":{"title":"Create a bank account","group_title":"Connect","group_anchor":"connect","anchor":"account_create_bank_account","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_bank_accounts/create","gate":false,"display_on_load":false},"account_retrieve_bank_account":{"title":"Retrieve a bank account","group_title":"Connect","group_anchor":"connect","anchor":"account_retrieve_bank_account","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_bank_accounts/retrieve","gate":false,"display_on_load":false},"account_update_bank_account":{"title":"Update a bank account","group_title":"Connect","group_anchor":"connect","anchor":"account_update_bank_account","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_bank_accounts/update","gate":false,"display_on_load":false},"account_delete_bank_account":{"title":"Delete a bank account","group_title":"Connect","group_anchor":"connect","anchor":"account_delete_bank_account","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_bank_accounts/delete","gate":false,"display_on_load":false},"account_list_bank_accounts":{"title":"List all bank accounts","group_title":"Connect","group_anchor":"connect","anchor":"account_list_bank_accounts","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_bank_accounts/list","gate":false,"display_on_load":false},"account_card_object":{"title":"The (account) card object","group_title":"Connect","group_anchor":"connect","anchor":"account_card_object","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_cards/object","gate":false,"display_on_load":false},"account_create_card":{"title":"Create a card","group_title":"Connect","group_anchor":"connect","anchor":"account_create_card","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_cards/create","gate":false,"display_on_load":false},"account_retrieve_card":{"title":"Retrieve a card","group_title":"Connect","group_anchor":"connect","anchor":"account_retrieve_card","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_cards/retrieve","gate":false,"display_on_load":false},"account_update_card":{"title":"Update a card","group_title":"Connect","group_anchor":"connect","anchor":"account_update_card","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_cards/update","gate":false,"display_on_load":false},"account_delete_card":{"title":"Delete a card","group_title":"Connect","group_anchor":"connect","anchor":"account_delete_card","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_cards/delete","gate":false,"display_on_load":false},"account_list_cards":{"title":"List all cards","group_title":"Connect","group_anchor":"connect","anchor":"account_list_cards","section_anchor":"external_accounts","subsection_anchors":null,"path":"/external_account_cards/list","gate":false,"display_on_load":false},"persons":{"title":"Persons","group_title":"Connect","group_anchor":"connect","anchor":"persons","section_anchor":"persons","subsection_anchors":["person_object","create_person","retrieve_person","update_person","delete_person","list_person"],"path":"/persons","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"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](/docs/connect/standard-accounts) or [Express onboarding documentation](/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.\n\nRelated guide: [Handling Identity Verification with the API](/docs/connect/identity-verification-api#person-information).\n","section_tag":"persons","subsection_summaries":[{"anchor":"person_object","curl_definition":null},{"anchor":"create_person","curl_definition":"POST /v1/accounts/:id/persons"},{"anchor":"retrieve_person","curl_definition":"GET /v1/accounts/:id/persons/:id"},{"anchor":"update_person","curl_definition":"POST /v1/accounts/:id/persons/:id"},{"anchor":"delete_person","curl_definition":"DELETE /v1/accounts/:id/persons/:id"},{"anchor":"list_person","curl_definition":"GET /v1/accounts/:id/persons"}]}},"person_object":{"title":"The person object","group_title":"Connect","group_anchor":"connect","anchor":"person_object","section_anchor":"persons","subsection_anchors":null,"path":"/persons/object","gate":false,"display_on_load":false},"create_person":{"title":"Create a person","group_title":"Connect","group_anchor":"connect","anchor":"create_person","section_anchor":"persons","subsection_anchors":null,"path":"/persons/create","gate":false,"display_on_load":false},"retrieve_person":{"title":"Retrieve a person","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_person","section_anchor":"persons","subsection_anchors":null,"path":"/persons/retrieve","gate":false,"display_on_load":false},"update_person":{"title":"Update a person","group_title":"Connect","group_anchor":"connect","anchor":"update_person","section_anchor":"persons","subsection_anchors":null,"path":"/persons/update","gate":false,"display_on_load":false},"delete_person":{"title":"Delete a person","group_title":"Connect","group_anchor":"connect","anchor":"delete_person","section_anchor":"persons","subsection_anchors":null,"path":"/persons/delete","gate":false,"display_on_load":false},"list_person":{"title":"List all persons","group_title":"Connect","group_anchor":"connect","anchor":"list_person","section_anchor":"persons","subsection_anchors":null,"path":"/persons/list","gate":false,"display_on_load":false},"topups":{"title":"Top-ups","group_title":"Connect","group_anchor":"connect","anchor":"topups","section_anchor":"topups","subsection_anchors":["topup_object","create_topup","retrieve_topup","update_topup","list_topups","cancel_topup"],"path":"/topups","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Top-ups","description":"To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping Up your Platform Account](/docs/connect/top-ups).\n","section_tag":"topups","subsection_summaries":[{"anchor":"topup_object","curl_definition":null},{"anchor":"create_topup","curl_definition":"POST /v1/topups"},{"anchor":"retrieve_topup","curl_definition":"GET /v1/topups/:id"},{"anchor":"update_topup","curl_definition":"POST /v1/topups/:id"},{"anchor":"list_topups","curl_definition":"GET /v1/topups"},{"anchor":"cancel_topup","curl_definition":"POST /v1/topups/:id/cancel"}]}},"topup_object":{"title":"The top-up object","group_title":"Connect","group_anchor":"connect","anchor":"topup_object","section_anchor":"topups","subsection_anchors":null,"path":"/topups/object","gate":false,"display_on_load":false},"create_topup":{"title":"Create a top-up","group_title":"Connect","group_anchor":"connect","anchor":"create_topup","section_anchor":"topups","subsection_anchors":null,"path":"/topups/create","gate":false,"display_on_load":false},"retrieve_topup":{"title":"Retrieve a top-up","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_topup","section_anchor":"topups","subsection_anchors":null,"path":"/topups/retrieve","gate":false,"display_on_load":false},"update_topup":{"title":"Update a top-up","group_title":"Connect","group_anchor":"connect","anchor":"update_topup","section_anchor":"topups","subsection_anchors":null,"path":"/topups/update","gate":false,"display_on_load":false},"list_topups":{"title":"List all top-ups","group_title":"Connect","group_anchor":"connect","anchor":"list_topups","section_anchor":"topups","subsection_anchors":null,"path":"/topups/list","gate":false,"display_on_load":false},"cancel_topup":{"title":"Cancel a top-up","group_title":"Connect","group_anchor":"connect","anchor":"cancel_topup","section_anchor":"topups","subsection_anchors":null,"path":"/topups/cancel","gate":false,"display_on_load":false},"transfers":{"title":"Transfers","group_title":"Connect","group_anchor":"connect","anchor":"transfers","section_anchor":"transfers","subsection_anchors":["transfer_object","create_transfer","retrieve_transfer","update_transfer","list_transfers"],"path":"/transfers","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Transfers","description":"A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](/docs/transfer-payout-split).\n\nRelated guide: [Creating Separate Charges and Transfers](/docs/connect/charges-transfers).\n","section_tag":"transfers","subsection_summaries":[{"anchor":"transfer_object","curl_definition":null},{"anchor":"create_transfer","curl_definition":"POST /v1/transfers"},{"anchor":"retrieve_transfer","curl_definition":"GET /v1/transfers/:id"},{"anchor":"update_transfer","curl_definition":"POST /v1/transfers/:id"},{"anchor":"list_transfers","curl_definition":"GET /v1/transfers"}]}},"transfer_object":{"title":"The transfer object","group_title":"Connect","group_anchor":"connect","anchor":"transfer_object","section_anchor":"transfers","subsection_anchors":null,"path":"/transfers/object","gate":false,"display_on_load":false},"create_transfer":{"title":"Create a transfer","group_title":"Connect","group_anchor":"connect","anchor":"create_transfer","section_anchor":"transfers","subsection_anchors":null,"path":"/transfers/create","gate":false,"display_on_load":false},"retrieve_transfer":{"title":"Retrieve a transfer","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_transfer","section_anchor":"transfers","subsection_anchors":null,"path":"/transfers/retrieve","gate":false,"display_on_load":false},"update_transfer":{"title":"Update a transfer","group_title":"Connect","group_anchor":"connect","anchor":"update_transfer","section_anchor":"transfers","subsection_anchors":null,"path":"/transfers/update","gate":false,"display_on_load":false},"list_transfers":{"title":"List all transfers","group_title":"Connect","group_anchor":"connect","anchor":"list_transfers","section_anchor":"transfers","subsection_anchors":null,"path":"/transfers/list","gate":false,"display_on_load":false},"transfer_reversals":{"title":"Transfer Reversals","group_title":"Connect","group_anchor":"connect","anchor":"transfer_reversals","section_anchor":"transfer_reversals","subsection_anchors":["transfer_reversal_object","create_transfer_reversal","retrieve_transfer_reversal","update_transfer_reversal","list_transfer_reversals"],"path":"/transfer_reversals","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Transfer Reversals","description":"[Stripe Connect](/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](/docs/connect/charges-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing Transfers](/docs/connect/charges-transfers#reversing-transfers).\n","section_tag":"transfer_reversals","subsection_summaries":[{"anchor":"transfer_reversal_object","curl_definition":null},{"anchor":"create_transfer_reversal","curl_definition":"POST /v1/transfers/:id/reversals"},{"anchor":"retrieve_transfer_reversal","curl_definition":"GET /v1/transfers/:id/reversals/:id"},{"anchor":"update_transfer_reversal","curl_definition":"POST /v1/transfers/:id/reversals/:id"},{"anchor":"list_transfer_reversals","curl_definition":"GET /v1/transfers/:id/reversals"}]}},"transfer_reversal_object":{"title":"The transfer reversal object","group_title":"Connect","group_anchor":"connect","anchor":"transfer_reversal_object","section_anchor":"transfer_reversals","subsection_anchors":null,"path":"/transfer_reversals/object","gate":false,"display_on_load":false},"create_transfer_reversal":{"title":"Create a transfer reversal","group_title":"Connect","group_anchor":"connect","anchor":"create_transfer_reversal","section_anchor":"transfer_reversals","subsection_anchors":null,"path":"/transfer_reversals/create","gate":false,"display_on_load":false},"retrieve_transfer_reversal":{"title":"Retrieve a reversal","group_title":"Connect","group_anchor":"connect","anchor":"retrieve_transfer_reversal","section_anchor":"transfer_reversals","subsection_anchors":null,"path":"/transfer_reversals/retrieve","gate":false,"display_on_load":false},"update_transfer_reversal":{"title":"Update a reversal","group_title":"Connect","group_anchor":"connect","anchor":"update_transfer_reversal","section_anchor":"transfer_reversals","subsection_anchors":null,"path":"/transfer_reversals/update","gate":false,"display_on_load":false},"list_transfer_reversals":{"title":"List all reversals","group_title":"Connect","group_anchor":"connect","anchor":"list_transfer_reversals","section_anchor":"transfer_reversals","subsection_anchors":null,"path":"/transfer_reversals/list","gate":false,"display_on_load":false},"secret_management":{"title":"Secret Management","group_title":"Connect","group_anchor":"connect","anchor":"secret_management","section_anchor":"secret_management","subsection_anchors":["secret_object","set_secret","find_secret","delete_secret","list_secret"],"path":"/secret_management","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Secrets","description":"Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](/docs/stripe-apps/store-auth-data-custom-objects).\n","section_tag":"secret_management","subsection_summaries":[{"anchor":"secret_object","curl_definition":null},{"anchor":"set_secret","curl_definition":"POST /v1/apps/secrets"},{"anchor":"find_secret","curl_definition":"GET /v1/apps/secrets/find"},{"anchor":"delete_secret","curl_definition":"POST /v1/apps/secrets/delete"},{"anchor":"list_secret","curl_definition":"GET /v1/apps/secrets"}]}},"secret_object":{"title":"The Secret object","group_title":"Connect","group_anchor":"connect","anchor":"secret_object","section_anchor":"secret_management","subsection_anchors":null,"path":"/apps/secret_store/secret_resource","gate":false,"display_on_load":false},"set_secret":{"title":"Set a secret","group_title":"Connect","group_anchor":"connect","anchor":"set_secret","section_anchor":"secret_management","subsection_anchors":null,"path":"/apps/secret_store/set","gate":false,"display_on_load":false},"find_secret":{"title":"Find a secret","group_title":"Connect","group_anchor":"connect","anchor":"find_secret","section_anchor":"secret_management","subsection_anchors":null,"path":"/apps/secret_store/find","gate":false,"display_on_load":false},"delete_secret":{"title":"Delete a secret","group_title":"Connect","group_anchor":"connect","anchor":"delete_secret","section_anchor":"secret_management","subsection_anchors":null,"path":"/apps/secret_store/delete","gate":false,"display_on_load":false},"list_secret":{"title":"List secrets","group_title":"Connect","group_anchor":"connect","anchor":"list_secret","section_anchor":"secret_management","subsection_anchors":null,"path":"/apps/secret_store/list","gate":false,"display_on_load":false},"early_fraud_warnings":{"title":"Early Fraud Warnings","group_title":"Fraud","group_anchor":"fraud","anchor":"early_fraud_warnings","section_anchor":"early_fraud_warnings","subsection_anchors":["early_fraud_warning_object","retrieve_early_fraud_warning","list_early_fraud_warnings"],"path":"/radar/early_fraud_warnings","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Early Fraud Warning","description":"An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early Fraud Warnings](/docs/disputes/measuring#early-fraud-warnings).\n","section_tag":"early_fraud_warnings","subsection_summaries":[{"anchor":"early_fraud_warning_object","curl_definition":null},{"anchor":"retrieve_early_fraud_warning","curl_definition":"GET /v1/radar/early_fraud_warnings/:id"},{"anchor":"list_early_fraud_warnings","curl_definition":"GET /v1/radar/early_fraud_warnings"}]}},"early_fraud_warning_object":{"title":"The early fraud warning object","group_title":"Fraud","group_anchor":"fraud","anchor":"early_fraud_warning_object","section_anchor":"early_fraud_warnings","subsection_anchors":null,"path":"/radar/early_fraud_warnings/object","gate":false,"display_on_load":false},"retrieve_early_fraud_warning":{"title":"Retrieve an early fraud warning","group_title":"Fraud","group_anchor":"fraud","anchor":"retrieve_early_fraud_warning","section_anchor":"early_fraud_warnings","subsection_anchors":null,"path":"/radar/early_fraud_warnings/retrieve","gate":false,"display_on_load":false},"list_early_fraud_warnings":{"title":"List all early fraud warnings","group_title":"Fraud","group_anchor":"fraud","anchor":"list_early_fraud_warnings","section_anchor":"early_fraud_warnings","subsection_anchors":null,"path":"/radar/early_fraud_warnings/list","gate":false,"display_on_load":false},"reviews":{"title":"Reviews","group_title":"Fraud","group_anchor":"fraud","anchor":"reviews","section_anchor":"reviews","subsection_anchors":["review_object","approve_review","retrieve_review","list_reviews"],"path":"/radar/reviews","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Reviews","description":"Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](/docs/radar/reviews).\n","section_tag":"reviews","subsection_summaries":[{"anchor":"review_object","curl_definition":null},{"anchor":"approve_review","curl_definition":"POST /v1/reviews/:id/approve"},{"anchor":"retrieve_review","curl_definition":"GET /v1/reviews/:id"},{"anchor":"list_reviews","curl_definition":"GET /v1/reviews"}]}},"review_object":{"title":"The review object","group_title":"Fraud","group_anchor":"fraud","anchor":"review_object","section_anchor":"reviews","subsection_anchors":null,"path":"/radar/reviews/object","gate":false,"display_on_load":false},"approve_review":{"title":"Approve a review","group_title":"Fraud","group_anchor":"fraud","anchor":"approve_review","section_anchor":"reviews","subsection_anchors":null,"path":"/radar/reviews/approve","gate":false,"display_on_load":false},"retrieve_review":{"title":"Retrieve a review","group_title":"Fraud","group_anchor":"fraud","anchor":"retrieve_review","section_anchor":"reviews","subsection_anchors":null,"path":"/radar/reviews/retrieve","gate":false,"display_on_load":false},"list_reviews":{"title":"List all open reviews","group_title":"Fraud","group_anchor":"fraud","anchor":"list_reviews","section_anchor":"reviews","subsection_anchors":null,"path":"/radar/reviews/list","gate":false,"display_on_load":false},"value_lists":{"title":"Value Lists","group_title":"Fraud","group_anchor":"fraud","anchor":"value_lists","section_anchor":"value_lists","subsection_anchors":["radar_value_list_object","create_value_list","retrieve_value_list","update_value_list","delete_value_list","list_value_lists"],"path":"/radar/value_lists","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Value Lists","description":"Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe Lists](/docs/radar/lists#managing-list-items).\n","section_tag":"value_lists","subsection_summaries":[{"anchor":"radar_value_list_object","curl_definition":null},{"anchor":"create_value_list","curl_definition":"POST /v1/radar/value_lists"},{"anchor":"retrieve_value_list","curl_definition":"GET /v1/radar/value_lists/:id"},{"anchor":"update_value_list","curl_definition":"POST /v1/radar/value_lists/:id"},{"anchor":"delete_value_list","curl_definition":"DELETE /v1/radar/value_lists/:id"},{"anchor":"list_value_lists","curl_definition":"GET /v1/radar/value_lists"}]}},"radar_value_list_object":{"title":"The value list object","group_title":"Fraud","group_anchor":"fraud","anchor":"radar_value_list_object","section_anchor":"value_lists","subsection_anchors":null,"path":"/radar/value_lists/object","gate":false,"display_on_load":false},"create_value_list":{"title":"Create a value list","group_title":"Fraud","group_anchor":"fraud","anchor":"create_value_list","section_anchor":"value_lists","subsection_anchors":null,"path":"/radar/value_lists/create","gate":false,"display_on_load":false},"retrieve_value_list":{"title":"Retrieve a value list","group_title":"Fraud","group_anchor":"fraud","anchor":"retrieve_value_list","section_anchor":"value_lists","subsection_anchors":null,"path":"/radar/value_lists/retrieve","gate":false,"display_on_load":false},"update_value_list":{"title":"Update a value list","group_title":"Fraud","group_anchor":"fraud","anchor":"update_value_list","section_anchor":"value_lists","subsection_anchors":null,"path":"/radar/value_lists/update","gate":false,"display_on_load":false},"delete_value_list":{"title":"Delete a value list","group_title":"Fraud","group_anchor":"fraud","anchor":"delete_value_list","section_anchor":"value_lists","subsection_anchors":null,"path":"/radar/value_lists/delete","gate":false,"display_on_load":false},"list_value_lists":{"title":"List all value lists","group_title":"Fraud","group_anchor":"fraud","anchor":"list_value_lists","section_anchor":"value_lists","subsection_anchors":null,"path":"/radar/value_lists/list","gate":false,"display_on_load":false},"value_list_items":{"title":"Value List Items","group_title":"Fraud","group_anchor":"fraud","anchor":"value_list_items","section_anchor":"value_list_items","subsection_anchors":["radar_value_list_item_object","create_value_list_item","retrieve_value_list_item","delete_value_list_item","list_value_list_items"],"path":"/radar/value_list_items","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Value List Items","description":"Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing List Items](/docs/radar/lists#managing-list-items).\n","section_tag":"value_list_items","subsection_summaries":[{"anchor":"radar_value_list_item_object","curl_definition":null},{"anchor":"create_value_list_item","curl_definition":"POST /v1/radar/value_list_items"},{"anchor":"retrieve_value_list_item","curl_definition":"GET /v1/radar/value_list_items/:id"},{"anchor":"delete_value_list_item","curl_definition":"DELETE /v1/radar/value_list_items/:id"},{"anchor":"list_value_list_items","curl_definition":"GET /v1/radar/value_list_items"}]}},"radar_value_list_item_object":{"title":"The value list item object","group_title":"Fraud","group_anchor":"fraud","anchor":"radar_value_list_item_object","section_anchor":"value_list_items","subsection_anchors":null,"path":"/radar/value_list_items/object","gate":false,"display_on_load":false},"create_value_list_item":{"title":"Create a value list item","group_title":"Fraud","group_anchor":"fraud","anchor":"create_value_list_item","section_anchor":"value_list_items","subsection_anchors":null,"path":"/radar/value_list_items/create","gate":false,"display_on_load":false},"retrieve_value_list_item":{"title":"Retrieve a value list item","group_title":"Fraud","group_anchor":"fraud","anchor":"retrieve_value_list_item","section_anchor":"value_list_items","subsection_anchors":null,"path":"/radar/value_list_items/retrieve","gate":false,"display_on_load":false},"delete_value_list_item":{"title":"Delete a value list item","group_title":"Fraud","group_anchor":"fraud","anchor":"delete_value_list_item","section_anchor":"value_list_items","subsection_anchors":null,"path":"/radar/value_list_items/delete","gate":false,"display_on_load":false},"list_value_list_items":{"title":"List all value list items","group_title":"Fraud","group_anchor":"fraud","anchor":"list_value_list_items","section_anchor":"value_list_items","subsection_anchors":null,"path":"/radar/value_list_items/list","gate":false,"display_on_load":false},"issuing_authorizations":{"title":"Authorizations","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_authorizations","section_anchor":"issuing_authorizations","subsection_anchors":["issuing_authorization_object","retrieve_issuing_authorization","update_issuing_authorization","approve_issuing_authorization","decline_issuing_authorization","list_issuing_authorizations"],"path":"/issuing/authorizations","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Authorizations","description":"When an [issued card](/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued Card Authorizations](/docs/issuing/purchases/authorizations).\n","section_tag":"issuing_authorizations","subsection_summaries":[{"anchor":"issuing_authorization_object","curl_definition":null},{"anchor":"retrieve_issuing_authorization","curl_definition":"GET /v1/issuing/authorizations/:id"},{"anchor":"update_issuing_authorization","curl_definition":"POST /v1/issuing/authorizations/:id"},{"anchor":"approve_issuing_authorization","curl_definition":"POST /v1/issuing/authorizations/:id/approve"},{"anchor":"decline_issuing_authorization","curl_definition":"POST /v1/issuing/authorizations/:id/decline"},{"anchor":"list_issuing_authorizations","curl_definition":"GET /v1/issuing/authorizations"}]}},"issuing_authorization_object":{"title":"The Authorization object","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_authorization_object","section_anchor":"issuing_authorizations","subsection_anchors":null,"path":"/issuing/authorizations/object","gate":false,"display_on_load":false},"retrieve_issuing_authorization":{"title":"Retrieve an authorization","group_title":"Issuing","group_anchor":"issuing","anchor":"retrieve_issuing_authorization","section_anchor":"issuing_authorizations","subsection_anchors":null,"path":"/issuing/authorizations/retrieve","gate":false,"display_on_load":false},"update_issuing_authorization":{"title":"Update an authorization","group_title":"Issuing","group_anchor":"issuing","anchor":"update_issuing_authorization","section_anchor":"issuing_authorizations","subsection_anchors":null,"path":"/issuing/authorizations/update","gate":false,"display_on_load":false},"approve_issuing_authorization":{"title":"Approve an authorization","group_title":"Issuing","group_anchor":"issuing","anchor":"approve_issuing_authorization","section_anchor":"issuing_authorizations","subsection_anchors":null,"path":"/issuing/authorizations/approve","gate":false,"display_on_load":false},"decline_issuing_authorization":{"title":"Decline an authorization","group_title":"Issuing","group_anchor":"issuing","anchor":"decline_issuing_authorization","section_anchor":"issuing_authorizations","subsection_anchors":null,"path":"/issuing/authorizations/decline","gate":false,"display_on_load":false},"list_issuing_authorizations":{"title":"List all authorizations","group_title":"Issuing","group_anchor":"issuing","anchor":"list_issuing_authorizations","section_anchor":"issuing_authorizations","subsection_anchors":null,"path":"/issuing/authorizations/list","gate":false,"display_on_load":false},"issuing_cardholders":{"title":"Cardholders","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_cardholders","section_anchor":"issuing_cardholders","subsection_anchors":["issuing_cardholder_object","create_issuing_cardholder","retrieve_issuing_cardholder","update_issuing_cardholder","list_issuing_cardholders"],"path":"/issuing/cardholders","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Cardholders","description":"An Issuing `Cardholder` object represents an individual or business entity who is [issued](/docs/issuing) cards.\n\nRelated guide: [How to create a Cardholder](/docs/issuing/cards#create-cardholder)\n","section_tag":"issuing_cardholders","subsection_summaries":[{"anchor":"issuing_cardholder_object","curl_definition":null},{"anchor":"create_issuing_cardholder","curl_definition":"POST /v1/issuing/cardholders"},{"anchor":"retrieve_issuing_cardholder","curl_definition":"GET /v1/issuing/cardholders/:id"},{"anchor":"update_issuing_cardholder","curl_definition":"POST /v1/issuing/cardholders/:id"},{"anchor":"list_issuing_cardholders","curl_definition":"GET /v1/issuing/cardholders"}]}},"issuing_cardholder_object":{"title":"The Cardholder object","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_cardholder_object","section_anchor":"issuing_cardholders","subsection_anchors":null,"path":"/issuing/cardholders/object","gate":false,"display_on_load":false},"create_issuing_cardholder":{"title":"Create a cardholder","group_title":"Issuing","group_anchor":"issuing","anchor":"create_issuing_cardholder","section_anchor":"issuing_cardholders","subsection_anchors":null,"path":"/issuing/cardholders/create","gate":false,"display_on_load":false},"retrieve_issuing_cardholder":{"title":"Retrieve a cardholder","group_title":"Issuing","group_anchor":"issuing","anchor":"retrieve_issuing_cardholder","section_anchor":"issuing_cardholders","subsection_anchors":null,"path":"/issuing/cardholders/retrieve","gate":false,"display_on_load":false},"update_issuing_cardholder":{"title":"Update a cardholder","group_title":"Issuing","group_anchor":"issuing","anchor":"update_issuing_cardholder","section_anchor":"issuing_cardholders","subsection_anchors":null,"path":"/issuing/cardholders/update","gate":false,"display_on_load":false},"list_issuing_cardholders":{"title":"List all cardholders","group_title":"Issuing","group_anchor":"issuing","anchor":"list_issuing_cardholders","section_anchor":"issuing_cardholders","subsection_anchors":null,"path":"/issuing/cardholders/list","gate":false,"display_on_load":false},"issuing_cards":{"title":"Cards","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_cards","section_anchor":"issuing_cards","subsection_anchors":["issuing_card_object","create_issuing_card","retrieve_issuing_card","update_issuing_card","list_issuing_cards","test_mode_ship_physical_card","test_mode_deliver_physical_card","test_mode_return_physical_card","test_mode_fail_physical_card"],"path":"/issuing/cards","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Cards","description":"You can [create physical or virtual cards](/docs/issuing/cards) that are issued to cardholders.","section_tag":"issuing_cards","subsection_summaries":[{"anchor":"issuing_card_object","curl_definition":null},{"anchor":"create_issuing_card","curl_definition":"POST /v1/issuing/cards"},{"anchor":"retrieve_issuing_card","curl_definition":"GET /v1/issuing/cards/:id"},{"anchor":"update_issuing_card","curl_definition":"POST /v1/issuing/cards/:id"},{"anchor":"list_issuing_cards","curl_definition":"GET /v1/issuing/cards"},{"anchor":"test_mode_ship_physical_card","curl_definition":"POST /v1/test_helpers/issuing/cards/{:card}/shipping/ship"},{"anchor":"test_mode_deliver_physical_card","curl_definition":"POST /v1/test_helpers/issuing/cards/{:card}/shipping/deliver"},{"anchor":"test_mode_return_physical_card","curl_definition":"POST /v1/test_helpers/issuing/cards/{:card}/shipping/return"},{"anchor":"test_mode_fail_physical_card","curl_definition":"POST /v1/test_helpers/issuing/cards/{:card}/shipping/fail"}]}},"issuing_card_object":{"title":"The Card object","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_card_object","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/object","gate":false,"display_on_load":false},"create_issuing_card":{"title":"Create a card","group_title":"Issuing","group_anchor":"issuing","anchor":"create_issuing_card","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/create","gate":false,"display_on_load":false},"retrieve_issuing_card":{"title":"Retrieve a card","group_title":"Issuing","group_anchor":"issuing","anchor":"retrieve_issuing_card","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/retrieve","gate":false,"display_on_load":false},"update_issuing_card":{"title":"Update a card","group_title":"Issuing","group_anchor":"issuing","anchor":"update_issuing_card","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/update","gate":false,"display_on_load":false},"list_issuing_cards":{"title":"List all cards","group_title":"Issuing","group_anchor":"issuing","anchor":"list_issuing_cards","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/list","gate":false,"display_on_load":false},"test_mode_ship_physical_card":{"title":"Ship a testmode card","group_title":"Issuing","group_anchor":"issuing","anchor":"test_mode_ship_physical_card","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/test_mode_ship","gate":false,"display_on_load":false},"test_mode_deliver_physical_card":{"title":"Deliver a testmode card","group_title":"Issuing","group_anchor":"issuing","anchor":"test_mode_deliver_physical_card","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/test_mode_deliver","gate":false,"display_on_load":false},"test_mode_return_physical_card":{"title":"Return a testmode card","group_title":"Issuing","group_anchor":"issuing","anchor":"test_mode_return_physical_card","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/test_mode_return","gate":false,"display_on_load":false},"test_mode_fail_physical_card":{"title":"Fail a testmode card","group_title":"Issuing","group_anchor":"issuing","anchor":"test_mode_fail_physical_card","section_anchor":"issuing_cards","subsection_anchors":null,"path":"/issuing/cards/test_mode_fail","gate":false,"display_on_load":false},"issuing_disputes":{"title":"Disputes","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_disputes","section_anchor":"issuing_disputes","subsection_anchors":["issuing_dispute_object","create_issuing_dispute","submit_issuing_dispute","retrieve_issuing_dispute","update_issuing_dispute","list_issuing_disputes"],"path":"/issuing/disputes","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Disputes","description":"As a [card issuer](/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Disputing Transactions](/docs/issuing/purchases/disputes)\n","section_tag":"issuing_disputes","subsection_summaries":[{"anchor":"issuing_dispute_object","curl_definition":null},{"anchor":"create_issuing_dispute","curl_definition":"POST /v1/issuing/disputes"},{"anchor":"submit_issuing_dispute","curl_definition":"POST /v1/issuing/disputes/:id/submit"},{"anchor":"retrieve_issuing_dispute","curl_definition":"GET /v1/issuing/disputes/:id"},{"anchor":"update_issuing_dispute","curl_definition":"POST /v1/issuing/disputes/:id"},{"anchor":"list_issuing_disputes","curl_definition":"GET /v1/issuing/disputes"}]}},"issuing_dispute_object":{"title":"The Dispute object","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_dispute_object","section_anchor":"issuing_disputes","subsection_anchors":null,"path":"/issuing/disputes/object","gate":false,"display_on_load":false},"create_issuing_dispute":{"title":"Create a dispute","group_title":"Issuing","group_anchor":"issuing","anchor":"create_issuing_dispute","section_anchor":"issuing_disputes","subsection_anchors":null,"path":"/issuing/disputes/create","gate":false,"display_on_load":false},"submit_issuing_dispute":{"title":"Submit a dispute","group_title":"Issuing","group_anchor":"issuing","anchor":"submit_issuing_dispute","section_anchor":"issuing_disputes","subsection_anchors":null,"path":"/issuing/dispute/submit","gate":false,"display_on_load":false},"retrieve_issuing_dispute":{"title":"Retrieve a dispute","group_title":"Issuing","group_anchor":"issuing","anchor":"retrieve_issuing_dispute","section_anchor":"issuing_disputes","subsection_anchors":null,"path":"/issuing/disputes/retrieve","gate":false,"display_on_load":false},"update_issuing_dispute":{"title":"Update a dispute","group_title":"Issuing","group_anchor":"issuing","anchor":"update_issuing_dispute","section_anchor":"issuing_disputes","subsection_anchors":null,"path":"/issuing/disputes/update","gate":false,"display_on_load":false},"list_issuing_disputes":{"title":"List all disputes","group_title":"Issuing","group_anchor":"issuing","anchor":"list_issuing_disputes","section_anchor":"issuing_disputes","subsection_anchors":null,"path":"/issuing/disputes/list","gate":false,"display_on_load":false},"issuing_funding_instructions":{"title":"Funding Instructions","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_funding_instructions","section_anchor":"issuing_funding_instructions","subsection_anchors":["issuing_funding_instructions_object","create_issuing_funding_instructions","list_issuing_funding_instructions","fund_issuing_funding_instruction"],"path":"/issuing/funding_instructions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Funding Instructions","description":"Funding Instructions contain reusable bank account and routing information. Push funds\nto these addresses via bank transfer to [top up Issuing Balances](/docs/issuing/funding/balance).\n","section_tag":"issuing_funding_instructions","subsection_summaries":[{"anchor":"issuing_funding_instructions_object","curl_definition":null},{"anchor":"create_issuing_funding_instructions","curl_definition":"POST /v1/issuing/funding_instructions"},{"anchor":"list_issuing_funding_instructions","curl_definition":"GET /v1/issuing/funding_instructions"},{"anchor":"fund_issuing_funding_instruction","curl_definition":"POST /v1/test_helpers/issuing/fund_balance"}]}},"issuing_funding_instructions_object":{"title":"The FundingInstruction object","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_funding_instructions_object","section_anchor":"issuing_funding_instructions","subsection_anchors":null,"path":"/issuing/funding_instructions/object","gate":false,"display_on_load":false},"create_issuing_funding_instructions":{"title":"Create funding instructions","group_title":"Issuing","group_anchor":"issuing","anchor":"create_issuing_funding_instructions","section_anchor":"issuing_funding_instructions","subsection_anchors":null,"path":"/issuing/funding_instructions/create","gate":false,"display_on_load":false},"list_issuing_funding_instructions":{"title":"List all funding instructions","group_title":"Issuing","group_anchor":"issuing","anchor":"list_issuing_funding_instructions","section_anchor":"issuing_funding_instructions","subsection_anchors":null,"path":"/issuing/funding_instructions/list","gate":false,"display_on_load":false},"fund_issuing_funding_instruction":{"title":"Simulate a top up","group_title":"Issuing","group_anchor":"issuing","anchor":"fund_issuing_funding_instruction","section_anchor":"issuing_funding_instructions","subsection_anchors":null,"path":"/issuing/funding_instructions/fund","gate":false,"display_on_load":false},"issuing_transactions":{"title":"Transactions","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_transactions","section_anchor":"issuing_transactions","subsection_anchors":["issuing_transaction_object","retrieve_issuing_transaction","update_issuing_transaction","list_issuing_transactions"],"path":"/issuing/transactions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Transactions","description":"Any use of an [issued card](/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued Card Transactions](/docs/issuing/purchases/transactions).\n","section_tag":"issuing_transactions","subsection_summaries":[{"anchor":"issuing_transaction_object","curl_definition":null},{"anchor":"retrieve_issuing_transaction","curl_definition":"GET /v1/issuing/transactions/:id"},{"anchor":"update_issuing_transaction","curl_definition":"POST /v1/issuing/transactions/:id"},{"anchor":"list_issuing_transactions","curl_definition":"GET /v1/issuing/transactions"}]}},"issuing_transaction_object":{"title":"The Transaction object","group_title":"Issuing","group_anchor":"issuing","anchor":"issuing_transaction_object","section_anchor":"issuing_transactions","subsection_anchors":null,"path":"/issuing/transactions/object","gate":false,"display_on_load":false},"retrieve_issuing_transaction":{"title":"Retrieve a transaction","group_title":"Issuing","group_anchor":"issuing","anchor":"retrieve_issuing_transaction","section_anchor":"issuing_transactions","subsection_anchors":null,"path":"/issuing/transactions/retrieve","gate":false,"display_on_load":false},"update_issuing_transaction":{"title":"Update a transaction","group_title":"Issuing","group_anchor":"issuing","anchor":"update_issuing_transaction","section_anchor":"issuing_transactions","subsection_anchors":null,"path":"/issuing/transactions/update","gate":false,"display_on_load":false},"list_issuing_transactions":{"title":"List all transactions","group_title":"Issuing","group_anchor":"issuing","anchor":"list_issuing_transactions","section_anchor":"issuing_transactions","subsection_anchors":null,"path":"/issuing/transactions/list","gate":false,"display_on_load":false},"terminal_connection_tokens":{"title":"Connection Tokens","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_connection_tokens","section_anchor":"terminal_connection_tokens","subsection_anchors":["terminal_connection_token_object","create_terminal_connection_token"],"path":"/terminal/connection_tokens","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Connection Token","description":"A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet Management](/docs/terminal/fleet/locations).\n","section_tag":"terminal_connection_tokens","subsection_summaries":[{"anchor":"terminal_connection_token_object","curl_definition":null},{"anchor":"create_terminal_connection_token","curl_definition":"POST /v1/terminal/connection_tokens"}]}},"terminal_connection_token_object":{"title":"The connection token object","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_connection_token_object","section_anchor":"terminal_connection_tokens","subsection_anchors":null,"path":"/terminal/connection_tokens/object","gate":false,"display_on_load":false},"create_terminal_connection_token":{"title":"Create a Connection Token","group_title":"Terminal","group_anchor":"terminal","anchor":"create_terminal_connection_token","section_anchor":"terminal_connection_tokens","subsection_anchors":null,"path":"/terminal/connection_tokens/create","gate":false,"display_on_load":false},"terminal_locations":{"title":"Locations","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_locations","section_anchor":"terminal_locations","subsection_anchors":["terminal_location_object","create_terminal_location","retrieve_terminal_location","update_terminal_location","delete_terminal_location","list_terminal_locations"],"path":"/terminal/locations","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Location","description":"A Location represents a grouping of readers.\n\nRelated guide: [Fleet Management](/docs/terminal/fleet/locations).\n","section_tag":"terminal_locations","subsection_summaries":[{"anchor":"terminal_location_object","curl_definition":null},{"anchor":"create_terminal_location","curl_definition":"POST /v1/terminal/locations"},{"anchor":"retrieve_terminal_location","curl_definition":"GET /v1/terminal/locations/:id"},{"anchor":"update_terminal_location","curl_definition":"POST /v1/terminal/locations/:id"},{"anchor":"delete_terminal_location","curl_definition":"DELETE /v1/terminal/locations/:id"},{"anchor":"list_terminal_locations","curl_definition":"GET /v1/terminal/locations"}]}},"terminal_location_object":{"title":"The location object","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_location_object","section_anchor":"terminal_locations","subsection_anchors":null,"path":"/terminal/locations/object","gate":false,"display_on_load":false},"create_terminal_location":{"title":"Create a Location","group_title":"Terminal","group_anchor":"terminal","anchor":"create_terminal_location","section_anchor":"terminal_locations","subsection_anchors":null,"path":"/terminal/locations/create","gate":false,"display_on_load":false},"retrieve_terminal_location":{"title":"Retrieve a Location","group_title":"Terminal","group_anchor":"terminal","anchor":"retrieve_terminal_location","section_anchor":"terminal_locations","subsection_anchors":null,"path":"/terminal/locations/retrieve","gate":false,"display_on_load":false},"update_terminal_location":{"title":"Update a Location","group_title":"Terminal","group_anchor":"terminal","anchor":"update_terminal_location","section_anchor":"terminal_locations","subsection_anchors":null,"path":"/terminal/locations/update","gate":false,"display_on_load":false},"delete_terminal_location":{"title":"Delete a Location","group_title":"Terminal","group_anchor":"terminal","anchor":"delete_terminal_location","section_anchor":"terminal_locations","subsection_anchors":null,"path":"/terminal/locations/delete","gate":false,"display_on_load":false},"list_terminal_locations":{"title":"List all Locations","group_title":"Terminal","group_anchor":"terminal","anchor":"list_terminal_locations","section_anchor":"terminal_locations","subsection_anchors":null,"path":"/terminal/locations/list","gate":false,"display_on_load":false},"terminal_readers":{"title":"Readers","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_readers","section_anchor":"terminal_readers","subsection_anchors":["terminal_reader_object","create_terminal_reader","retrieve_terminal_reader","update_terminal_reader","delete_terminal_reader","list_terminal_reader","process_payment_intent","process_setup_intent","set_reader_display","refund_payment","cancel_action","present_payment_method"],"path":"/terminal/readers","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Reader","description":"A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a Reader](/docs/terminal/payments/connect-reader).\n","section_tag":"terminal_readers","subsection_summaries":[{"anchor":"terminal_reader_object","curl_definition":null},{"anchor":"create_terminal_reader","curl_definition":"POST /v1/terminal/readers"},{"anchor":"retrieve_terminal_reader","curl_definition":"GET /v1/terminal/readers/:id"},{"anchor":"update_terminal_reader","curl_definition":"POST /v1/terminal/readers/:id"},{"anchor":"delete_terminal_reader","curl_definition":"DELETE /v1/terminal/readers/:id"},{"anchor":"list_terminal_reader","curl_definition":"GET /v1/terminal/readers"},{"anchor":"process_payment_intent","curl_definition":"POST /v1/terminal/readers/:id/process_payment_intent"},{"anchor":"process_setup_intent","curl_definition":"POST /v1/terminal/readers/:id/process_setup_intent"},{"anchor":"set_reader_display","curl_definition":"POST /v1/terminal/readers/:id/set_reader_display"},{"anchor":"refund_payment","curl_definition":"POST /v1/terminal/readers/:id/refund_payment"},{"anchor":"cancel_action","curl_definition":"POST /v1/terminal/readers/:id/cancel_action"},{"anchor":"present_payment_method","curl_definition":"POST /v1/test_helpers/terminal/readers/:id/present_payment_method"}]}},"terminal_reader_object":{"title":"The reader object","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_reader_object","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/object","gate":false,"display_on_load":false},"create_terminal_reader":{"title":"Create a Reader","group_title":"Terminal","group_anchor":"terminal","anchor":"create_terminal_reader","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/create","gate":false,"display_on_load":false},"retrieve_terminal_reader":{"title":"Retrieve a Reader","group_title":"Terminal","group_anchor":"terminal","anchor":"retrieve_terminal_reader","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/retrieve","gate":false,"display_on_load":false},"update_terminal_reader":{"title":"Update a Reader","group_title":"Terminal","group_anchor":"terminal","anchor":"update_terminal_reader","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/update","gate":false,"display_on_load":false},"delete_terminal_reader":{"title":"Delete a Reader","group_title":"Terminal","group_anchor":"terminal","anchor":"delete_terminal_reader","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/delete","gate":false,"display_on_load":false},"list_terminal_reader":{"title":"List all Readers","group_title":"Terminal","group_anchor":"terminal","anchor":"list_terminal_reader","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/list","gate":false,"display_on_load":false},"process_payment_intent":{"title":"Hand-off a PaymentIntent to a Reader","group_title":"Terminal","group_anchor":"terminal","anchor":"process_payment_intent","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/process_payment_intent","gate":false,"display_on_load":false},"process_setup_intent":{"title":"Hand-off a SetupIntent to a Reader","group_title":"Terminal","group_anchor":"terminal","anchor":"process_setup_intent","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/process_setup_intent","gate":false,"display_on_load":false},"set_reader_display":{"title":"Set reader display","group_title":"Terminal","group_anchor":"terminal","anchor":"set_reader_display","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/set_reader_display","gate":false,"display_on_load":false},"refund_payment":{"title":"Refund a Charge or a PaymentIntent in-person","group_title":"Terminal","group_anchor":"terminal","anchor":"refund_payment","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/refund_payment","gate":false,"display_on_load":false},"cancel_action":{"title":"Cancel the current reader action","group_title":"Terminal","group_anchor":"terminal","anchor":"cancel_action","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/cancel_action","gate":false,"display_on_load":false},"present_payment_method":{"title":"Simulate presenting a payment method","group_title":"Terminal","group_anchor":"terminal","anchor":"present_payment_method","section_anchor":"terminal_readers","subsection_anchors":null,"path":"/terminal/readers/present_payment_method","gate":false,"display_on_load":false},"terminal_configuration":{"title":"Configurations","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_configuration","section_anchor":"terminal_configuration","subsection_anchors":["terminal_configuration_object","create_configuration","retrieve_configuration","update_configuration","delete_configuration","list_configuration"],"path":"/terminal/configuration","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Configuration","description":"A Configurations object represents how features should be configured for terminal readers.\n","section_tag":"terminal_configuration","subsection_summaries":[{"anchor":"terminal_configuration_object","curl_definition":null},{"anchor":"create_configuration","curl_definition":"POST /v1/terminal/configurations"},{"anchor":"retrieve_configuration","curl_definition":"GET /v1/terminal/configurations/:id"},{"anchor":"update_configuration","curl_definition":"POST /v1/terminal/configurations/:id"},{"anchor":"delete_configuration","curl_definition":"DELETE /v1/terminal/configurations/:id"},{"anchor":"list_configuration","curl_definition":"GET /v1/terminal/configurations"}]}},"terminal_configuration_object":{"title":"The Configuration object","group_title":"Terminal","group_anchor":"terminal","anchor":"terminal_configuration_object","section_anchor":"terminal_configuration","subsection_anchors":null,"path":"/terminal/configuration/object","gate":false,"display_on_load":false},"create_configuration":{"title":"Create a Configuration","group_title":"Terminal","group_anchor":"terminal","anchor":"create_configuration","section_anchor":"terminal_configuration","subsection_anchors":null,"path":"/terminal/configuration/create","gate":false,"display_on_load":false},"retrieve_configuration":{"title":"Retrieve a Configuration","group_title":"Terminal","group_anchor":"terminal","anchor":"retrieve_configuration","section_anchor":"terminal_configuration","subsection_anchors":null,"path":"/terminal/configuration/retrieve","gate":false,"display_on_load":false},"update_configuration":{"title":"Update a Configuration","group_title":"Terminal","group_anchor":"terminal","anchor":"update_configuration","section_anchor":"terminal_configuration","subsection_anchors":null,"path":"/terminal/configuration/update","gate":false,"display_on_load":false},"delete_configuration":{"title":"Delete a Configuration","group_title":"Terminal","group_anchor":"terminal","anchor":"delete_configuration","section_anchor":"terminal_configuration","subsection_anchors":null,"path":"/terminal/configuration/delete","gate":false,"display_on_load":false},"list_configuration":{"title":"List all Configurations","group_title":"Terminal","group_anchor":"terminal","anchor":"list_configuration","section_anchor":"terminal_configuration","subsection_anchors":null,"path":"/terminal/configuration/list","gate":false,"display_on_load":false},"financial_accounts":{"title":"FinancialAccounts","group_title":"Treasury","group_anchor":"treasury","anchor":"financial_accounts","section_anchor":"financial_accounts","subsection_anchors":["financial_account_object","create_financial_account","update_financial_account","retrieve_financial_account","list_financial_account"],"path":"/treasury/financial_accounts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"FinancialAccounts","description":"Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs.\n","section_tag":"financial_accounts","subsection_summaries":[{"anchor":"financial_account_object","curl_definition":null},{"anchor":"create_financial_account","curl_definition":"POST /v1/treasury/financial_accounts"},{"anchor":"update_financial_account","curl_definition":"POST /v1/treasury/financial_accounts/:id"},{"anchor":"retrieve_financial_account","curl_definition":"GET /v1/treasury/financial_accounts/:id"},{"anchor":"list_financial_account","curl_definition":"GET /v1/treasury/financial_accounts"}]}},"financial_account_object":{"title":"The FinancialAccount object","group_title":"Treasury","group_anchor":"treasury","anchor":"financial_account_object","section_anchor":"financial_accounts","subsection_anchors":null,"path":"/treasury/financial_accounts/object","gate":false,"display_on_load":false},"create_financial_account":{"title":"Create a FinancialAccount","group_title":"Treasury","group_anchor":"treasury","anchor":"create_financial_account","section_anchor":"financial_accounts","subsection_anchors":null,"path":"/treasury/financial_accounts/create","gate":false,"display_on_load":false},"update_financial_account":{"title":"Update a FinancialAccount","group_title":"Treasury","group_anchor":"treasury","anchor":"update_financial_account","section_anchor":"financial_accounts","subsection_anchors":null,"path":"/treasury/financial_accounts/update","gate":false,"display_on_load":false},"retrieve_financial_account":{"title":"Retrieve a FinancialAccount","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_financial_account","section_anchor":"financial_accounts","subsection_anchors":null,"path":"/treasury/financial_accounts/retrieve","gate":false,"display_on_load":false},"list_financial_account":{"title":"List all FinancialAccounts","group_title":"Treasury","group_anchor":"treasury","anchor":"list_financial_account","section_anchor":"financial_accounts","subsection_anchors":null,"path":"/treasury/financial_accounts/list","gate":false,"display_on_load":false},"financial_account_features":{"title":"FinancialAccount Features","group_title":"Treasury","group_anchor":"treasury","anchor":"financial_account_features","section_anchor":"financial_account_features","subsection_anchors":["financial_account_features_object","update_financial_acccount_features","retrieve_financial_account_features"],"path":"/treasury/financial_account_features","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"FinancialAccount Features","description":"Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field.\n","section_tag":"financial_account_features","subsection_summaries":[{"anchor":"financial_account_features_object","curl_definition":null},{"anchor":"update_financial_acccount_features","curl_definition":"POST /v1/treasury/financial_accounts/:id/features"},{"anchor":"retrieve_financial_account_features","curl_definition":"GET /v1/treasury/financial_accounts/:id/features"}]}},"financial_account_features_object":{"title":"The FinancialAccount Feature object","group_title":"Treasury","group_anchor":"treasury","anchor":"financial_account_features_object","section_anchor":"financial_account_features","subsection_anchors":null,"path":"/treasury/financial_account_features/object","gate":false,"display_on_load":false},"update_financial_acccount_features":{"title":"Update FinancialAccount Features","group_title":"Treasury","group_anchor":"treasury","anchor":"update_financial_acccount_features","section_anchor":"financial_account_features","subsection_anchors":null,"path":"/treasury/financial_account_features/update","gate":false,"display_on_load":false},"retrieve_financial_account_features":{"title":"Retrieve FinancialAccount Features","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_financial_account_features","section_anchor":"financial_account_features","subsection_anchors":null,"path":"/treasury/financial_account_features/retrieve","gate":false,"display_on_load":false},"transactions":{"title":"Transactions","group_title":"Treasury","group_anchor":"treasury","anchor":"transactions","section_anchor":"transactions","subsection_anchors":["transaction_object","retrieve_transaction","list_transactions"],"path":"/treasury/transactions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Transactions","description":"Transactions represent changes to a [FinancialAccount's](#financial_accounts) balance.\n","section_tag":"transactions","subsection_summaries":[{"anchor":"transaction_object","curl_definition":null},{"anchor":"retrieve_transaction","curl_definition":"GET /v1/treasury/transactions/:id"},{"anchor":"list_transactions","curl_definition":"GET /v1/treasury/transactions"}]}},"transaction_object":{"title":"The Transaction object","group_title":"Treasury","group_anchor":"treasury","anchor":"transaction_object","section_anchor":"transactions","subsection_anchors":null,"path":"/treasury/transactions/object","gate":false,"display_on_load":false},"retrieve_transaction":{"title":"Retrieve a Transaction","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_transaction","section_anchor":"transactions","subsection_anchors":null,"path":"/treasury/transactions/retrieve","gate":false,"display_on_load":false},"list_transactions":{"title":"List all Transactions","group_title":"Treasury","group_anchor":"treasury","anchor":"list_transactions","section_anchor":"transactions","subsection_anchors":null,"path":"/treasury/transactions/list","gate":false,"display_on_load":false},"transaction_entries":{"title":"TransactionEntries","group_title":"Treasury","group_anchor":"treasury","anchor":"transaction_entries","section_anchor":"transaction_entries","subsection_anchors":["transaction_entry_object","retrieve_transaction_entry","list_transaction_entries"],"path":"/treasury/transaction_entries","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"TransactionEntries","description":"TransactionEntries represent individual units of money movements within a single [Transaction](#transactions).\n","section_tag":"transaction_entries","subsection_summaries":[{"anchor":"transaction_entry_object","curl_definition":null},{"anchor":"retrieve_transaction_entry","curl_definition":"GET /v1/treasury/transaction_entries/:id"},{"anchor":"list_transaction_entries","curl_definition":"GET /v1/treasury/transaction_entries"}]}},"transaction_entry_object":{"title":"The TransactionEntry object","group_title":"Treasury","group_anchor":"treasury","anchor":"transaction_entry_object","section_anchor":"transaction_entries","subsection_anchors":null,"path":"/treasury/transaction_entries/object","gate":false,"display_on_load":false},"retrieve_transaction_entry":{"title":"Retrieve a TransactionEntry","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_transaction_entry","section_anchor":"transaction_entries","subsection_anchors":null,"path":"/treasury/transaction_entries/retrieve","gate":false,"display_on_load":false},"list_transaction_entries":{"title":"List all TransactionEntries","group_title":"Treasury","group_anchor":"treasury","anchor":"list_transaction_entries","section_anchor":"transaction_entries","subsection_anchors":null,"path":"/treasury/transaction_entries/list","gate":false,"display_on_load":false},"outbound_transfers":{"title":"OutboundTransfers","group_title":"Treasury","group_anchor":"treasury","anchor":"outbound_transfers","section_anchor":"outbound_transfers","subsection_anchors":["outbound_transfer_object","create_outbound_transfer","cancel_outbound_transfer","retrieve_outbound_transfer","list_outbound_transfers","test_mode_post_outbound_transfer","test_mode_return_outbound_transfer","test_mode_fail_outbound_transfer"],"path":"/treasury/outbound_transfers","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"OutboundTransfers","description":"Use OutboundTransfers to transfer funds from a [FinancialAccount](#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n","section_tag":"outbound_transfers","subsection_summaries":[{"anchor":"outbound_transfer_object","curl_definition":null},{"anchor":"create_outbound_transfer","curl_definition":"POST /v1/treasury/outbound_transfers"},{"anchor":"cancel_outbound_transfer","curl_definition":"POST /v1/treasury/outbound_transfers/:id/cancel"},{"anchor":"retrieve_outbound_transfer","curl_definition":"GET /v1/treasury/outbound_transfers/:id"},{"anchor":"list_outbound_transfers","curl_definition":"GET /v1/treasury/outbound_transfers"},{"anchor":"test_mode_post_outbound_transfer","curl_definition":"POST /v1/test_helpers/treasury/outbound_transfers/:id/post"},{"anchor":"test_mode_return_outbound_transfer","curl_definition":"POST /v1/test_helpers/treasury/outbound_transfers/:id/return"},{"anchor":"test_mode_fail_outbound_transfer","curl_definition":"POST /v1/test_helpers/treasury/outbound_transfers/:id/fail"}]}},"outbound_transfer_object":{"title":"The OutboundTransfer object","group_title":"Treasury","group_anchor":"treasury","anchor":"outbound_transfer_object","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/object","gate":false,"display_on_load":false},"create_outbound_transfer":{"title":"Create an OutboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"create_outbound_transfer","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/create","gate":false,"display_on_load":false},"cancel_outbound_transfer":{"title":"Cancel an OutboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"cancel_outbound_transfer","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/cancel","gate":false,"display_on_load":false},"retrieve_outbound_transfer":{"title":"Retrieve an OutboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_outbound_transfer","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/retrieve","gate":false,"display_on_load":false},"list_outbound_transfers":{"title":"List all OutboundTransfers","group_title":"Treasury","group_anchor":"treasury","anchor":"list_outbound_transfers","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/list","gate":false,"display_on_load":false},"test_mode_post_outbound_transfer":{"title":"Test mode: Post an OutboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_post_outbound_transfer","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/test_mode_post","gate":false,"display_on_load":false},"test_mode_return_outbound_transfer":{"title":"Test mode: Return an OutboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_return_outbound_transfer","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/test_mode_return","gate":false,"display_on_load":false},"test_mode_fail_outbound_transfer":{"title":"Test mode: Fail an OutboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_fail_outbound_transfer","section_anchor":"outbound_transfers","subsection_anchors":null,"path":"/treasury/outbound_transfers/test_mode_fail","gate":false,"display_on_load":false},"outbound_payments":{"title":"OutboundPayments","group_title":"Treasury","group_anchor":"treasury","anchor":"outbound_payments","section_anchor":"outbound_payments","subsection_anchors":["outbound_payment_object","create_outbound_payment","cancel_outbound_payment","retrieve_outbound_payment","list_outbound_payment","test_mode_outbound_payment_post","test_mode_outbound_payment_return","test_mode_outbound_payment_fail"],"path":"/treasury/outbound_payments","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Outbound Payments","description":"Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n","section_tag":"outbound_payments","subsection_summaries":[{"anchor":"outbound_payment_object","curl_definition":null},{"anchor":"create_outbound_payment","curl_definition":"POST /v1/treasury/outbound_payments"},{"anchor":"cancel_outbound_payment","curl_definition":"POST /v1/treasury/outbound_payments/:id/cancel"},{"anchor":"retrieve_outbound_payment","curl_definition":"GET /v1/treasury/outbound_payments/:id"},{"anchor":"list_outbound_payment","curl_definition":"GET /v1/treasury/outbound_payments"},{"anchor":"test_mode_outbound_payment_post","curl_definition":"POST /v1/test_helpers/treasury/outbound_payments/:id/post"},{"anchor":"test_mode_outbound_payment_return","curl_definition":"POST /v1/test_helpers/treasury/outbound_payments/:id/return"},{"anchor":"test_mode_outbound_payment_fail","curl_definition":"POST /v1/test_helpers/treasury/outbound_payments/:id/fail"}]}},"outbound_payment_object":{"title":"The OutboundPayment object","group_title":"Treasury","group_anchor":"treasury","anchor":"outbound_payment_object","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/object","gate":false,"display_on_load":false},"create_outbound_payment":{"title":"Create an OutboundPayment","group_title":"Treasury","group_anchor":"treasury","anchor":"create_outbound_payment","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/create","gate":false,"display_on_load":false},"cancel_outbound_payment":{"title":"Cancel an OutboundPayment","group_title":"Treasury","group_anchor":"treasury","anchor":"cancel_outbound_payment","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/cancel","gate":false,"display_on_load":false},"retrieve_outbound_payment":{"title":"Retrieve an OutboundPayment","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_outbound_payment","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/retrieve","gate":false,"display_on_load":false},"list_outbound_payment":{"title":"List all OutboundPayments","group_title":"Treasury","group_anchor":"treasury","anchor":"list_outbound_payment","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/list","gate":false,"display_on_load":false},"test_mode_outbound_payment_post":{"title":"Test mode: Post an OutboundPayment","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_outbound_payment_post","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/test_mode_post","gate":false,"display_on_load":false},"test_mode_outbound_payment_return":{"title":"Test mode: Return an OutboundPayment","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_outbound_payment_return","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/test_mode_return","gate":false,"display_on_load":false},"test_mode_outbound_payment_fail":{"title":"Test mode: Fail an OutboundPayment","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_outbound_payment_fail","section_anchor":"outbound_payments","subsection_anchors":null,"path":"/treasury/outbound_payments/test_mode_fail","gate":false,"display_on_load":false},"inbound_transfers":{"title":"InboundTransfers","group_title":"Treasury","group_anchor":"treasury","anchor":"inbound_transfers","section_anchor":"inbound_transfers","subsection_anchors":["inbound_transfer_object","create_inbound_transfer","cancel_inbound_transfer","retrieve_inbound_transfer","list_inbound_transfer","test_mode_inbound_transfer_fail","test_mode_inbound_transfer_return","test_mode_inbound_transfer_succeed"],"path":"/treasury/inbound_transfers","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"InboundTransfers","description":"Use [InboundTransfers](/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n","section_tag":"inbound_transfers","subsection_summaries":[{"anchor":"inbound_transfer_object","curl_definition":null},{"anchor":"create_inbound_transfer","curl_definition":"POST /v1/treasury/inbound_transfers"},{"anchor":"cancel_inbound_transfer","curl_definition":"POST /v1/treasury/inbound_transfers/:id/cancel"},{"anchor":"retrieve_inbound_transfer","curl_definition":"GET /v1/treasury/inbound_transfers/:id"},{"anchor":"list_inbound_transfer","curl_definition":"GET /v1/treasury/inbound_transfers"},{"anchor":"test_mode_inbound_transfer_fail","curl_definition":"POST /v1/test_helpers/treasury/inbound_transfers/:id/fail"},{"anchor":"test_mode_inbound_transfer_return","curl_definition":"POST /v1/test_helpers/treasury/inbound_transfers/:id/return"},{"anchor":"test_mode_inbound_transfer_succeed","curl_definition":"POST /v1/test_helpers/treasury/inbound_transfers/:id/succeed"}]}},"inbound_transfer_object":{"title":"The InboundTransfer object","group_title":"Treasury","group_anchor":"treasury","anchor":"inbound_transfer_object","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/object","gate":false,"display_on_load":false},"create_inbound_transfer":{"title":"Create an InboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"create_inbound_transfer","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/create","gate":false,"display_on_load":false},"cancel_inbound_transfer":{"title":"Cancel an InboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"cancel_inbound_transfer","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/cancel","gate":false,"display_on_load":false},"retrieve_inbound_transfer":{"title":"Retrieve an InboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_inbound_transfer","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/retrieve","gate":false,"display_on_load":false},"list_inbound_transfer":{"title":"List all InboundTransfers","group_title":"Treasury","group_anchor":"treasury","anchor":"list_inbound_transfer","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/list","gate":false,"display_on_load":false},"test_mode_inbound_transfer_fail":{"title":"Test mode: Fail an InboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_inbound_transfer_fail","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/test_mode_fail","gate":false,"display_on_load":false},"test_mode_inbound_transfer_return":{"title":"Test mode: Return an InboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_inbound_transfer_return","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/test_mode_return","gate":false,"display_on_load":false},"test_mode_inbound_transfer_succeed":{"title":"Test mode: Succeed an InboundTransfer","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_inbound_transfer_succeed","section_anchor":"inbound_transfers","subsection_anchors":null,"path":"/treasury/inbound_transfers/test_mode_succeed","gate":false,"display_on_load":false},"received_credits":{"title":"ReceivedCredits","group_title":"Treasury","group_anchor":"treasury","anchor":"received_credits","section_anchor":"received_credits","subsection_anchors":["received_credit_object","retrieve_received_credit","list_received_credit","test_mode_create_received_credit"],"path":"/treasury/received_credits","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"ReceivedCredits","description":"ReceivedCredits represent funds sent to a [FinancialAccount](#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.\n","section_tag":"received_credits","subsection_summaries":[{"anchor":"received_credit_object","curl_definition":null},{"anchor":"retrieve_received_credit","curl_definition":"GET /v1/treasury/received_credits/:id"},{"anchor":"list_received_credit","curl_definition":"GET /v1/treasury/received_credits"},{"anchor":"test_mode_create_received_credit","curl_definition":"POST /v1/test_helpers/treasury/received_credits"}]}},"received_credit_object":{"title":"The ReceivedCredit object","group_title":"Treasury","group_anchor":"treasury","anchor":"received_credit_object","section_anchor":"received_credits","subsection_anchors":null,"path":"/treasury/received_credits/object","gate":false,"display_on_load":false},"retrieve_received_credit":{"title":"Retrieve a ReceivedCredit","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_received_credit","section_anchor":"received_credits","subsection_anchors":null,"path":"/treasury/received_credits/retrieve","gate":false,"display_on_load":false},"list_received_credit":{"title":"List all ReceivedCredits","group_title":"Treasury","group_anchor":"treasury","anchor":"list_received_credit","section_anchor":"received_credits","subsection_anchors":null,"path":"/treasury/received_credits/list","gate":false,"display_on_load":false},"test_mode_create_received_credit":{"title":"Test mode: Create a ReceivedCredit","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_create_received_credit","section_anchor":"received_credits","subsection_anchors":null,"path":"/treasury/received_credits/test_mode_create","gate":false,"display_on_load":false},"received_debits":{"title":"ReceivedDebits","group_title":"Treasury","group_anchor":"treasury","anchor":"received_debits","section_anchor":"received_debits","subsection_anchors":["received_debit_object","retrieve_received_debit","list_received_debit","test_mode_create_received_debit"],"path":"/treasury/received_debits","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"ReceivedDebits","description":"ReceivedDebits represent funds pulled from a [FinancialAccount](#financial_accounts). These are not initiated from the FinancialAccount.\n","section_tag":"received_debits","subsection_summaries":[{"anchor":"received_debit_object","curl_definition":null},{"anchor":"retrieve_received_debit","curl_definition":"GET /v1/treasury/received_debits/:id"},{"anchor":"list_received_debit","curl_definition":"GET /v1/treasury/received_debits"},{"anchor":"test_mode_create_received_debit","curl_definition":"POST /v1/test_helpers/treasury/received_debits"}]}},"received_debit_object":{"title":"The ReceivedDebit object","group_title":"Treasury","group_anchor":"treasury","anchor":"received_debit_object","section_anchor":"received_debits","subsection_anchors":null,"path":"/treasury/received_debits/object","gate":false,"display_on_load":false},"retrieve_received_debit":{"title":"Retrieve a ReceivedDebit","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_received_debit","section_anchor":"received_debits","subsection_anchors":null,"path":"/treasury/received_debits/retrieve","gate":false,"display_on_load":false},"list_received_debit":{"title":"List all ReceivedDebits","group_title":"Treasury","group_anchor":"treasury","anchor":"list_received_debit","section_anchor":"received_debits","subsection_anchors":null,"path":"/treasury/received_debits/list","gate":false,"display_on_load":false},"test_mode_create_received_debit":{"title":"Test mode: Create a ReceivedDebit","group_title":"Treasury","group_anchor":"treasury","anchor":"test_mode_create_received_debit","section_anchor":"received_debits","subsection_anchors":null,"path":"/treasury/received_debits/test_mode_create","gate":false,"display_on_load":false},"credit_reversals":{"title":"CreditReversals","group_title":"Treasury","group_anchor":"treasury","anchor":"credit_reversals","section_anchor":"credit_reversals","subsection_anchors":["credit_reversal_object","create_credit_reversal","retrieve_credit_reversal","list_credit_reversal"],"path":"/treasury/credit_reversals","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"CreditReversals","description":"You can reverse some [ReceivedCredits](#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.\n","section_tag":"credit_reversals","subsection_summaries":[{"anchor":"credit_reversal_object","curl_definition":null},{"anchor":"create_credit_reversal","curl_definition":"POST /v1/treasury/credit_reversals"},{"anchor":"retrieve_credit_reversal","curl_definition":"GET /v1/treasury/credit_reversals/:id"},{"anchor":"list_credit_reversal","curl_definition":"GET /v1/treasury/credit_reversals"}]}},"credit_reversal_object":{"title":"The CreditReversal object","group_title":"Treasury","group_anchor":"treasury","anchor":"credit_reversal_object","section_anchor":"credit_reversals","subsection_anchors":null,"path":"/treasury/credit_reversals/object","gate":false,"display_on_load":false},"create_credit_reversal":{"title":"Create a CreditReversal","group_title":"Treasury","group_anchor":"treasury","anchor":"create_credit_reversal","section_anchor":"credit_reversals","subsection_anchors":null,"path":"/treasury/credit_reversals/create","gate":false,"display_on_load":false},"retrieve_credit_reversal":{"title":"Retrieve a CreditReversal","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_credit_reversal","section_anchor":"credit_reversals","subsection_anchors":null,"path":"/treasury/credit_reversals/retrieve","gate":false,"display_on_load":false},"list_credit_reversal":{"title":"List all CreditReversals","group_title":"Treasury","group_anchor":"treasury","anchor":"list_credit_reversal","section_anchor":"credit_reversals","subsection_anchors":null,"path":"/treasury/credit_reversals/list","gate":false,"display_on_load":false},"debit_reversals":{"title":"DebitReversals","group_title":"Treasury","group_anchor":"treasury","anchor":"debit_reversals","section_anchor":"debit_reversals","subsection_anchors":["debit_reversal_object","create_debit_reversal","retrieve_debit_reversal","list_debit_reversal"],"path":"/treasury/debit_reversals","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"DebitReversals","description":"You can reverse some [ReceivedDebits](#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.\n","section_tag":"debit_reversals","subsection_summaries":[{"anchor":"debit_reversal_object","curl_definition":null},{"anchor":"create_debit_reversal","curl_definition":"POST /v1/treasury/debit_reversals"},{"anchor":"retrieve_debit_reversal","curl_definition":"GET /v1/treasury/debit_reversals/:id"},{"anchor":"list_debit_reversal","curl_definition":"GET /v1/treasury/debit_reversals"}]}},"debit_reversal_object":{"title":"The DebitReversal object","group_title":"Treasury","group_anchor":"treasury","anchor":"debit_reversal_object","section_anchor":"debit_reversals","subsection_anchors":null,"path":"/treasury/debit_reversals/object","gate":false,"display_on_load":false},"create_debit_reversal":{"title":"Create a DebitReversal","group_title":"Treasury","group_anchor":"treasury","anchor":"create_debit_reversal","section_anchor":"debit_reversals","subsection_anchors":null,"path":"/treasury/debit_reversals/create","gate":false,"display_on_load":false},"retrieve_debit_reversal":{"title":"Retrieve a DebitReversal","group_title":"Treasury","group_anchor":"treasury","anchor":"retrieve_debit_reversal","section_anchor":"debit_reversals","subsection_anchors":null,"path":"/treasury/debit_reversals/retrieve","gate":false,"display_on_load":false},"list_debit_reversal":{"title":"List all DebitReversals","group_title":"Treasury","group_anchor":"treasury","anchor":"list_debit_reversal","section_anchor":"debit_reversals","subsection_anchors":null,"path":"/treasury/debit_reversals/list","gate":false,"display_on_load":false},"scheduled_queries":{"title":"Scheduled Queries","group_title":"Sigma","group_anchor":"sigma","anchor":"scheduled_queries","section_anchor":"scheduled_queries","subsection_anchors":["scheduled_query_run_object","retrieve_scheduled_query_run","list_scheduled_query_run"],"path":"/sigma/scheduled_queries","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Scheduled Queries","description":"If you have [scheduled a Sigma query](/docs/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results.\n","section_tag":"scheduled_queries","subsection_summaries":[{"anchor":"scheduled_query_run_object","curl_definition":null},{"anchor":"retrieve_scheduled_query_run","curl_definition":"GET /v1/sigma/scheduled_query_runs/:id"},{"anchor":"list_scheduled_query_run","curl_definition":"GET /v1/sigma/scheduled_query_runs"}]}},"scheduled_query_run_object":{"title":"The scheduled query run object","group_title":"Sigma","group_anchor":"sigma","anchor":"scheduled_query_run_object","section_anchor":"scheduled_queries","subsection_anchors":null,"path":"/sigma/scheduled_queries/object","gate":false,"display_on_load":false},"retrieve_scheduled_query_run":{"title":"Retrieve a scheduled query run","group_title":"Sigma","group_anchor":"sigma","anchor":"retrieve_scheduled_query_run","section_anchor":"scheduled_queries","subsection_anchors":null,"path":"/sigma/scheduled_queries/retrieve","gate":false,"display_on_load":false},"list_scheduled_query_run":{"title":"List all scheduled query runs","group_title":"Sigma","group_anchor":"sigma","anchor":"list_scheduled_query_run","section_anchor":"scheduled_queries","subsection_anchors":null,"path":"/sigma/scheduled_queries/list","gate":false,"display_on_load":false},"reporting_report_run":{"title":"Report Runs","group_title":"Reporting","group_anchor":"reporting","anchor":"reporting_report_run","section_anchor":"reporting_report_run","subsection_anchors":["reporting_report_run_object","create_reporting_report_run","retrieve_reporting_report_run","list_reporting_report_run"],"path":"/reporting/report_run","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Report Runs","description":"The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](/docs/keys#test-live-modes).\n","section_tag":"reporting_report_run","subsection_summaries":[{"anchor":"reporting_report_run_object","curl_definition":null},{"anchor":"create_reporting_report_run","curl_definition":"POST /v1/reporting/report_runs"},{"anchor":"retrieve_reporting_report_run","curl_definition":"GET /v1/reporting/report_runs/:id"},{"anchor":"list_reporting_report_run","curl_definition":"GET /v1/reporting/report_runs"}]}},"reporting_report_run_object":{"title":"The Report Run object","group_title":"Reporting","group_anchor":"reporting","anchor":"reporting_report_run_object","section_anchor":"reporting_report_run","subsection_anchors":null,"path":"/reporting/report_run/object","gate":false,"display_on_load":false},"create_reporting_report_run":{"title":"Create a Report Run","group_title":"Reporting","group_anchor":"reporting","anchor":"create_reporting_report_run","section_anchor":"reporting_report_run","subsection_anchors":null,"path":"/reporting/report_run/create","gate":false,"display_on_load":false},"retrieve_reporting_report_run":{"title":"Retrieve a Report Run","group_title":"Reporting","group_anchor":"reporting","anchor":"retrieve_reporting_report_run","section_anchor":"reporting_report_run","subsection_anchors":null,"path":"/reporting/report_run/retrieve","gate":false,"display_on_load":false},"list_reporting_report_run":{"title":"List all Report Runs","group_title":"Reporting","group_anchor":"reporting","anchor":"list_reporting_report_run","section_anchor":"reporting_report_run","subsection_anchors":null,"path":"/reporting/report_run/list","gate":false,"display_on_load":false},"reporting_report_type":{"title":"Report Types","group_title":"Reporting","group_anchor":"reporting","anchor":"reporting_report_type","section_anchor":"reporting_report_type","subsection_anchors":["reporting_report_type_object","retrieve_reporting_report_type","list_reporting_report_type"],"path":"/reporting/report_type","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Report Types","description":"The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](/docs/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](/docs/keys#test-live-modes).\n","section_tag":"reporting_report_type","subsection_summaries":[{"anchor":"reporting_report_type_object","curl_definition":null},{"anchor":"retrieve_reporting_report_type","curl_definition":"GET /v1/reporting/report_types/:id"},{"anchor":"list_reporting_report_type","curl_definition":"GET /v1/reporting/report_types"}]}},"reporting_report_type_object":{"title":"The Report Type object","group_title":"Reporting","group_anchor":"reporting","anchor":"reporting_report_type_object","section_anchor":"reporting_report_type","subsection_anchors":null,"path":"/reporting/report_type/object","gate":false,"display_on_load":false},"retrieve_reporting_report_type":{"title":"Retrieve a Report Type","group_title":"Reporting","group_anchor":"reporting","anchor":"retrieve_reporting_report_type","section_anchor":"reporting_report_type","subsection_anchors":null,"path":"/reporting/report_type/retrieve","gate":false,"display_on_load":false},"list_reporting_report_type":{"title":"List all Report Types","group_title":"Reporting","group_anchor":"reporting","anchor":"list_reporting_report_type","section_anchor":"reporting_report_type","subsection_anchors":null,"path":"/reporting/report_type/list","gate":false,"display_on_load":false},"financial_connections_accounts":{"title":"Accounts","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_accounts","section_anchor":"financial_connections_accounts","subsection_anchors":["financial_connections_account_object","financial_connections_retrieve_account","financial_connections_refresh_account","financial_connections_subscribe_account","financial_connections_unsubscribe_account","financial_connections_disconnect_account","financial_connections_list_accounts"],"path":"/financial_connections/accounts","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Accounts","description":"A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.\n","section_tag":"financial_connections_accounts","subsection_summaries":[{"anchor":"financial_connections_account_object","curl_definition":null},{"anchor":"financial_connections_retrieve_account","curl_definition":"GET /v1/financial_connections/accounts/:id"},{"anchor":"financial_connections_refresh_account","curl_definition":"POST /v1/financial_connections/accounts/:id/refresh"},{"anchor":"financial_connections_subscribe_account","curl_definition":"POST /v1/financial_connections/accounts/:id/subscribe"},{"anchor":"financial_connections_unsubscribe_account","curl_definition":"POST /v1/financial_connections/accounts/:id/unsubscribe"},{"anchor":"financial_connections_disconnect_account","curl_definition":"POST /v1/financial_connections/accounts/:id/disconnect"},{"anchor":"financial_connections_list_accounts","curl_definition":"GET /v1/financial_connections/accounts"}]}},"financial_connections_account_object":{"title":"The Account object","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_account_object","section_anchor":"financial_connections_accounts","subsection_anchors":null,"path":"/financial_connections/accounts/object","gate":false,"display_on_load":false},"financial_connections_retrieve_account":{"title":"Retrieve an Account","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_retrieve_account","section_anchor":"financial_connections_accounts","subsection_anchors":null,"path":"/financial_connections/accounts/retrieve","gate":false,"display_on_load":false},"financial_connections_refresh_account":{"title":"Refresh Account data","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_refresh_account","section_anchor":"financial_connections_accounts","subsection_anchors":null,"path":"/financial_connections/accounts/refresh","gate":false,"display_on_load":false},"financial_connections_subscribe_account":{"title":"Subscribe to data refreshes for an Account","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_subscribe_account","section_anchor":"financial_connections_accounts","subsection_anchors":null,"path":"/financial_connections/accounts/subscribe","gate":false,"display_on_load":false},"financial_connections_unsubscribe_account":{"title":"Unsubscribe from data refreshes for an Account","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_unsubscribe_account","section_anchor":"financial_connections_accounts","subsection_anchors":null,"path":"/financial_connections/accounts/unsubscribe","gate":false,"display_on_load":false},"financial_connections_disconnect_account":{"title":"Disconnect an Account","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_disconnect_account","section_anchor":"financial_connections_accounts","subsection_anchors":null,"path":"/financial_connections/accounts/disconnect","gate":false,"display_on_load":false},"financial_connections_list_accounts":{"title":"List Accounts","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_list_accounts","section_anchor":"financial_connections_accounts","subsection_anchors":null,"path":"/financial_connections/accounts/list","gate":false,"display_on_load":false},"financial_connections_ownership":{"title":"Account Ownership","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_ownership","section_anchor":"financial_connections_ownership","subsection_anchors":["financial_connections_ownership_object","financial_connections_owner_object","financial_connections_list_account_owners"],"path":"/financial_connections/ownership","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Account Ownership","description":"Describes a snapshot of the owners of an account at a particular point in time.","section_tag":"financial_connections_ownership","subsection_summaries":[{"anchor":"financial_connections_ownership_object","curl_definition":null},{"anchor":"financial_connections_owner_object","curl_definition":null},{"anchor":"financial_connections_list_account_owners","curl_definition":"GET /v1/financial_connections/accounts/:id/owners?ownership=:ownership_id"}]}},"financial_connections_ownership_object":{"title":"The Account Ownership object","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_ownership_object","section_anchor":"financial_connections_ownership","subsection_anchors":null,"path":"/financial_connections/ownership/object","gate":false,"display_on_load":false},"financial_connections_owner_object":{"title":"The Account Owner object","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_owner_object","section_anchor":"financial_connections_ownership","subsection_anchors":null,"path":"/financial_connections/ownership/owner-object","gate":false,"display_on_load":false},"financial_connections_list_account_owners":{"title":"List Account Owners","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_list_account_owners","section_anchor":"financial_connections_ownership","subsection_anchors":null,"path":"/financial_connections/ownership/list","gate":false,"display_on_load":false},"financial_connections_session":{"title":"Sessions","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_session","section_anchor":"financial_connections_session","subsection_anchors":["financial_connections_session_object","financial_connections_create_session","financial_connections_retrieve_session"],"path":"/financial_connections/session","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Session","description":"A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.\n","section_tag":"financial_connections_session","subsection_summaries":[{"anchor":"financial_connections_session_object","curl_definition":null},{"anchor":"financial_connections_create_session","curl_definition":"POST /v1/financial_connections/sessions"},{"anchor":"financial_connections_retrieve_session","curl_definition":"GET /v1/financial_connections/sessions/:id"}]}},"financial_connections_session_object":{"title":"The Session object","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_session_object","section_anchor":"financial_connections_session","subsection_anchors":null,"path":"/financial_connections/sessions/object","gate":false,"display_on_load":false},"financial_connections_create_session":{"title":"Create a Session","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_create_session","section_anchor":"financial_connections_session","subsection_anchors":null,"path":"/financial_connections/sessions/create","gate":false,"display_on_load":false},"financial_connections_retrieve_session":{"title":"Retrieve a Session","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_retrieve_session","section_anchor":"financial_connections_session","subsection_anchors":null,"path":"/financial_connections/sessions/retrieve","gate":false,"display_on_load":false},"financial_connections_transaction":{"title":"Transactions","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_transaction","section_anchor":"financial_connections_transaction","subsection_anchors":["financial_connections_transaction_object","financial_connections_list_transactions"],"path":"/financial_connections/transaction","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Transactions","description":"A Transaction represents a real transaction that affects a Financial Connections Account balance.\n","section_tag":"financial_connections_transaction","subsection_summaries":[{"anchor":"financial_connections_transaction_object","curl_definition":null},{"anchor":"financial_connections_list_transactions","curl_definition":"GET /v1/financial_connections/transactions"}]}},"financial_connections_transaction_object":{"title":"The Transaction object","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_transaction_object","section_anchor":"financial_connections_transaction","subsection_anchors":null,"path":"/financial_connections/transactions/object","gate":false,"display_on_load":false},"financial_connections_list_transactions":{"title":"List Transactions","group_title":"Financial Connections","group_anchor":"financial_connections","anchor":"financial_connections_list_transactions","section_anchor":"financial_connections_transaction","subsection_anchors":null,"path":"/financial_connections/transactions/list","gate":false,"display_on_load":false},"identity_verification_sessions":{"title":"VerificationSessions","group_title":"Identity","group_anchor":"identity","anchor":"identity_verification_sessions","section_anchor":"identity_verification_sessions","subsection_anchors":["identity_verification_session_object","create_identity_verification_session","list_identity_verification_session","retrieve_identity_verification_session","update_identity_verification_session","cancel_identity_verification_session","redact_identity_verification_session"],"path":"/identity/verification_sessions","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"VerificationSession","description":"A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](/docs/identity/verification-sessions)\n","section_tag":"identity_verification_sessions","subsection_summaries":[{"anchor":"identity_verification_session_object","curl_definition":null},{"anchor":"create_identity_verification_session","curl_definition":"POST /v1/identity/verification_sessions"},{"anchor":"list_identity_verification_session","curl_definition":"GET /v1/identity/verification_sessions"},{"anchor":"retrieve_identity_verification_session","curl_definition":"GET /v1/identity/verification_sessions/:id"},{"anchor":"update_identity_verification_session","curl_definition":"POST /v1/identity/verification_sessions/:id"},{"anchor":"cancel_identity_verification_session","curl_definition":"POST /v1/identity/verification_sessions/:id/cancel"},{"anchor":"redact_identity_verification_session","curl_definition":"POST /v1/identity/verification_sessions/:id/redact"}]}},"identity_verification_session_object":{"title":"The VerificationSession object","group_title":"Identity","group_anchor":"identity","anchor":"identity_verification_session_object","section_anchor":"identity_verification_sessions","subsection_anchors":null,"path":"/identity/verification_sessions/object","gate":false,"display_on_load":false},"create_identity_verification_session":{"title":"Create a VerificationSession","group_title":"Identity","group_anchor":"identity","anchor":"create_identity_verification_session","section_anchor":"identity_verification_sessions","subsection_anchors":null,"path":"/identity/verification_sessions/create","gate":false,"display_on_load":false},"list_identity_verification_session":{"title":"List VerificationSessions","group_title":"Identity","group_anchor":"identity","anchor":"list_identity_verification_session","section_anchor":"identity_verification_sessions","subsection_anchors":null,"path":"/identity/verification_sessions/list","gate":false,"display_on_load":false},"retrieve_identity_verification_session":{"title":"Retrieve a VerificationSession","group_title":"Identity","group_anchor":"identity","anchor":"retrieve_identity_verification_session","section_anchor":"identity_verification_sessions","subsection_anchors":null,"path":"/identity/verification_sessions/retrieve","gate":false,"display_on_load":false},"update_identity_verification_session":{"title":"Update a VerificationSession","group_title":"Identity","group_anchor":"identity","anchor":"update_identity_verification_session","section_anchor":"identity_verification_sessions","subsection_anchors":null,"path":"/identity/verification_sessions/update","gate":false,"display_on_load":false},"cancel_identity_verification_session":{"title":"Cancel a VerificationSession","group_title":"Identity","group_anchor":"identity","anchor":"cancel_identity_verification_session","section_anchor":"identity_verification_sessions","subsection_anchors":null,"path":"/identity/verification_sessions/cancel","gate":false,"display_on_load":false},"redact_identity_verification_session":{"title":"Redact a VerificationSession","group_title":"Identity","group_anchor":"identity","anchor":"redact_identity_verification_session","section_anchor":"identity_verification_sessions","subsection_anchors":null,"path":"/identity/verification_sessions/redact","gate":false,"display_on_load":false},"identity_verification_reports":{"title":"VerificationReports","group_title":"Identity","group_anchor":"identity","anchor":"identity_verification_reports","section_anchor":"identity_verification_reports","subsection_anchors":["identity_verification_report_object","retrieve_identity_verification_report","list_identity_verification_report"],"path":"/identity/verification_reports","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"VerificationReport","description":"A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](/docs/identity/verification-sessions#results).\n","section_tag":"identity_verification_reports","subsection_summaries":[{"anchor":"identity_verification_report_object","curl_definition":null},{"anchor":"retrieve_identity_verification_report","curl_definition":"GET /v1/identity/verification_reports/:id"},{"anchor":"list_identity_verification_report","curl_definition":"GET /v1/identity/verification_reports"}]}},"identity_verification_report_object":{"title":"The VerificationReport object","group_title":"Identity","group_anchor":"identity","anchor":"identity_verification_report_object","section_anchor":"identity_verification_reports","subsection_anchors":null,"path":"/identity/verification_reports/object","gate":false,"display_on_load":false},"retrieve_identity_verification_report":{"title":"Retrieve a VerificationReport","group_title":"Identity","group_anchor":"identity","anchor":"retrieve_identity_verification_report","section_anchor":"identity_verification_reports","subsection_anchors":null,"path":"/identity/verification_reports/retrieve","gate":false,"display_on_load":false},"list_identity_verification_report":{"title":"List VerificationReports","group_title":"Identity","group_anchor":"identity","anchor":"list_identity_verification_report","section_anchor":"identity_verification_reports","subsection_anchors":null,"path":"/identity/verification_reports/list","gate":false,"display_on_load":false},"webhook_endpoints":{"title":"Webhook Endpoints","group_title":"Webhooks","group_anchor":"webhooks","anchor":"webhook_endpoints","section_anchor":"webhook_endpoints","subsection_anchors":["webhook_endpoint_object","create_webhook_endpoint","retrieve_webhook_endpoint","update_webhook_endpoint","list_webhook_endpoints","delete_webhook_endpoints"],"path":"/webhook_endpoints","gate":false,"display_on_load":false,"data":{"section_type":"resource","title":"Webhook Endpoints","description":"You can configure [webhook endpoints](/docs/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up Webhooks](/docs/webhooks/configure).\n","section_tag":"webhook_endpoints","subsection_summaries":[{"anchor":"webhook_endpoint_object","curl_definition":null},{"anchor":"create_webhook_endpoint","curl_definition":"POST /v1/webhook_endpoints"},{"anchor":"retrieve_webhook_endpoint","curl_definition":"GET /v1/webhook_endpoints/:id"},{"anchor":"update_webhook_endpoint","curl_definition":"POST /v1/webhook_endpoints/:id"},{"anchor":"list_webhook_endpoints","curl_definition":"GET /v1/webhook_endpoints"},{"anchor":"delete_webhook_endpoints","curl_definition":"DELETE /v1/webhook_endpoints/:id"}]}},"webhook_endpoint_object":{"title":"The webhook endpoint object","group_title":"Webhooks","group_anchor":"webhooks","anchor":"webhook_endpoint_object","section_anchor":"webhook_endpoints","subsection_anchors":null,"path":"/webhook_endpoints/object","gate":false,"display_on_load":false},"create_webhook_endpoint":{"title":"Create a webhook endpoint","group_title":"Webhooks","group_anchor":"webhooks","anchor":"create_webhook_endpoint","section_anchor":"webhook_endpoints","subsection_anchors":null,"path":"/webhook_endpoints/create","gate":false,"display_on_load":false},"retrieve_webhook_endpoint":{"title":"Retrieve a webhook endpoint","group_title":"Webhooks","group_anchor":"webhooks","anchor":"retrieve_webhook_endpoint","section_anchor":"webhook_endpoints","subsection_anchors":null,"path":"/webhook_endpoints/retrieve","gate":false,"display_on_load":false},"update_webhook_endpoint":{"title":"Update a webhook endpoint","group_title":"Webhooks","group_anchor":"webhooks","anchor":"update_webhook_endpoint","section_anchor":"webhook_endpoints","subsection_anchors":null,"path":"/webhook_endpoints/update","gate":false,"display_on_load":false},"list_webhook_endpoints":{"title":"List all webhook endpoints","group_title":"Webhooks","group_anchor":"webhooks","anchor":"list_webhook_endpoints","section_anchor":"webhook_endpoints","subsection_anchors":null,"path":"/webhook_endpoints/list","gate":false,"display_on_load":false},"delete_webhook_endpoints":{"title":"Delete a webhook endpoint","group_title":"Webhooks","group_anchor":"webhooks","anchor":"delete_webhook_endpoints","section_anchor":"webhook_endpoints","subsection_anchors":null,"path":"/webhook_endpoints/delete","gate":false,"display_on_load":false}}, -[2m2023-03-06T20:20:37.131333Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UPDATE for Account: POST /v1/accounts/{account}/capabilities/{capability} (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.131409Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Account: POST /v1/accounts/{account}/external_accounts (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.131457Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UPDATE for Account: POST /v1/accounts/{account}/external_accounts/{id} (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.131481Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled DELETE for Account: /v1/accounts/{account}/external_accounts/{id} -[2m2023-03-06T20:20:37.131514Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Account: POST /v1/accounts/{account}/login_links (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.131571Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Account: POST /v1/accounts/{account}/persons (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.131612Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UPDATE for Account: POST /v1/accounts/{account}/persons/{person} (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.131661Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled DELETE for Account: /v1/accounts/{account}/persons/{person} -[2m2023-03-06T20:20:37.131699Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0maccount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Account: POST /v1/accounts/{account}/reject (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.178296Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.179001Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mlegal_entity_japan_address[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m legal_entity_japan_address not in html -[2m2023-03-06T20:20:37.180512Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mapple_pay_domain[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m apple_pay_domain not in html -[2m2023-03-06T20:20:37.180925Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mapplication[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m application not in html -[2m2023-03-06T20:20:37.182285Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mapplication_fee[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UPDATE for ApplicationFee: POST /v1/application_fees/{fee}/refunds/{id} (already have [List]) -[2m2023-03-06T20:20:37.182396Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mapplication_fee[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for ApplicationFee: POST /v1/application_fees/{id}/refunds (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.182827Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mapps.secret[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m apps.secret not in html -[2m2023-03-06T20:20:37.187385Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mbank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m bank_account not in html -[2m2023-03-06T20:20:37.188678Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mbilling_portal.configuration[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m billing_portal.configuration not in html -[2m2023-03-06T20:20:37.192093Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mbilling_portal.session[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m billing_portal.session not in html -[2m2023-03-06T20:20:37.208136Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcharge[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Charge: POST /v1/charges/{charge}/capture (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.244007Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.244834Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mbilling_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m billing_details not in html -[2m2023-03-06T20:20:37.245352Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mpayment_method_details_card_installments_plan[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m payment_method_details_card_installments_plan not in html -[2m2023-03-06T20:20:37.246003Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mradar_radar_options[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m radar_radar_options not in html -[2m2023-03-06T20:20:37.246293Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mshipping[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m shipping not in html -[2m2023-03-06T20:20:37.246819Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mthree_d_secure_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m three_d_secure_details not in html -[2m2023-03-06T20:20:37.253021Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcheckout.session[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for CheckoutSession: POST /v1/checkout/sessions/{session}/expire (already have [List, Create]) -[2m2023-03-06T20:20:37.346687Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.348100Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_setting_rendering_options[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_setting_rendering_options not in html -[2m2023-03-06T20:20:37.348603Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mlinked_account_options_us_bank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m linked_account_options_us_bank_account not in html -[2m2023-03-06T20:20:37.349543Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mpayment_method_options_customer_balance_eu_bank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m payment_method_options_customer_balance_eu_bank_account not in html -[2m2023-03-06T20:20:37.350332Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mshipping[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m shipping not in html -[2m2023-03-06T20:20:37.351137Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mconnect_collection_transfer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m connect_collection_transfer not in html -[2m2023-03-06T20:20:37.361767Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcredit_note[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for CreditNote: POST /v1/credit_notes/{id}/void (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.365947Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoices_shipping_cost[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoices_shipping_cost not in html -[2m2023-03-06T20:20:37.373066Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Customer: POST /v1/customers/{customer}/balance_transactions (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.373159Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UPDATE for Customer: POST /v1/customers/{customer}/balance_transactions/{transaction} (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.373231Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Customer: POST /v1/customers/{customer}/cash_balance (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.373286Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled DELETE for Customer: /v1/customers/{customer}/discount -[2m2023-03-06T20:20:37.373339Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Customer: POST /v1/customers/{customer}/funding_instructions (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.373410Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Customer: POST /v1/customers/{customer}/sources (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.373468Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Customer: POST /v1/customers/{customer}/sources/{id}/verify (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.373521Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Customer: POST /v1/customers/{customer}/tax_ids (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.373575Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mcustomer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled DELETE for Customer: /v1/customers/{customer}/tax_ids/{id} -[2m2023-03-06T20:20:37.385760Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.386533Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_setting_rendering_options[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_setting_rendering_options not in html -[2m2023-03-06T20:20:37.386871Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mshipping[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m shipping not in html -[2m2023-03-06T20:20:37.396502Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mdispute[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Dispute: POST /v1/disputes/{dispute} (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.396599Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mdispute[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Dispute: POST /v1/disputes/{dispute}/close (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.401782Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mephemeral_key[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m ephemeral_key not in html -[2m2023-03-06T20:20:37.404672Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mexchange_rate[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m exchange_rate not in html -[2m2023-03-06T20:20:37.407368Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mfile[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for File: POST /v1/files (already have [List]) -[2m2023-03-06T20:20:37.415881Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mbank_connections_resource_accountholder[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m bank_connections_resource_accountholder not in html -[2m2023-03-06T20:20:37.416800Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mfinancial_connections.account_owner[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m financial_connections.account_owner not in html -[2m2023-03-06T20:20:37.417563Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mfinancial_connections.account_ownership[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m financial_connections.account_ownership not in html -[2m2023-03-06T20:20:37.421322Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mbank_connections_resource_accountholder[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m bank_connections_resource_accountholder not in html -[2m2023-03-06T20:20:37.422167Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mfunding_instructions[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m funding_instructions not in html -[2m2023-03-06T20:20:37.432821Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.437849Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.448519Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0minvoice[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Invoice: POST /v1/invoices/{invoice} (already have [List, Create, Retrieve]) -[2m2023-03-06T20:20:37.448747Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0minvoice[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Invoice: POST /v1/invoices/{invoice}/finalize (already have [List, Create, Retrieve, Delete]) -[2m2023-03-06T20:20:37.448833Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0minvoice[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Invoice: POST /v1/invoices/{invoice}/mark_uncollectible (already have [List, Create, Retrieve, Delete]) -[2m2023-03-06T20:20:37.448893Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0minvoice[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Invoice: POST /v1/invoices/{invoice}/pay (already have [List, Create, Retrieve, Delete]) -[2m2023-03-06T20:20:37.448954Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0minvoice[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Invoice: POST /v1/invoices/{invoice}/send (already have [List, Create, Retrieve, Delete]) -[2m2023-03-06T20:20:37.449021Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0minvoice[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Invoice: POST /v1/invoices/{invoice}/void (already have [List, Create, Retrieve, Delete]) -[2m2023-03-06T20:20:37.476117Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.477447Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mapi_errors[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m api_errors not in html -[2m2023-03-06T20:20:37.479342Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_acss_debit[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_acss_debit not in html -[2m2023-03-06T20:20:37.480732Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_bancontact[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_bancontact not in html -[2m2023-03-06T20:20:37.481393Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_customer_balance[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_customer_balance not in html -[2m2023-03-06T20:20:37.482584Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_konbini[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_konbini not in html -[2m2023-03-06T20:20:37.482865Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_us_bank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_us_bank_account not in html -[2m2023-03-06T20:20:37.483775Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_setting_rendering_options[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_setting_rendering_options not in html -[2m2023-03-06T20:20:37.484111Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoices_shipping_cost[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoices_shipping_cost not in html -[2m2023-03-06T20:20:37.484942Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mshipping[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m shipping not in html -[2m2023-03-06T20:20:37.495305Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0missuing_authorization_amount_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m issuing_authorization_amount_details not in html -[2m2023-03-06T20:20:37.495643Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0missuing_authorization_merchant_data[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m issuing_authorization_merchant_data not in html -[2m2023-03-06T20:20:37.519118Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.547180Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.559909Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0missuing_authorization_merchant_data[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m issuing_authorization_merchant_data not in html -[2m2023-03-06T20:20:37.560884Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mitem[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m item not in html -[2m2023-03-06T20:20:37.562118Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mline_item[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m line_item not in html -[2m2023-03-06T20:20:37.568334Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mmandate_options_off_session_details_blik[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m mandate_options_off_session_details_blik not in html -[2m2023-03-06T20:20:37.568950Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mnotification_event_data[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m notification_event_data not in html -[2m2023-03-06T20:20:37.573511Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for PaymentIntent: POST /v1/payment_intents/{intent}/apply_customer_balance (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.573576Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for PaymentIntent: POST /v1/payment_intents/{intent}/cancel (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.573617Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for PaymentIntent: POST /v1/payment_intents/{intent}/capture (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.573687Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for PaymentIntent: POST /v1/payment_intents/{intent}/confirm (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.573747Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UPDATE for PaymentIntent: POST /v1/payment_intents/{intent}/increment_authorization (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.573784Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for PaymentIntent: POST /v1/payment_intents/{intent}/verify_microdeposits (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.696303Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mapi_errors[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m api_errors not in html -[2m2023-03-06T20:20:37.698222Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mlinked_account_options_us_bank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m linked_account_options_us_bank_account not in html -[2m2023-03-06T20:20:37.698868Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mpayment_method_details_card_installments_plan[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m payment_method_details_card_installments_plan not in html -[2m2023-03-06T20:20:37.699513Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mpayment_method_options_customer_balance_eu_bank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m payment_method_options_customer_balance_eu_bank_account not in html -[2m2023-03-06T20:20:37.699999Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mshipping[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m shipping not in html -[2m2023-03-06T20:20:37.739709Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_setting_rendering_options[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_setting_rendering_options not in html -[2m2023-03-06T20:20:37.743309Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_method[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for PaymentMethod: POST /v1/payment_methods/{payment_method}/attach (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.743437Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayment_method[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for PaymentMethod: POST /v1/payment_methods/{payment_method}/detach (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.769801Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.770432Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mbilling_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m billing_details not in html -[2m2023-03-06T20:20:37.770924Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mradar_radar_options[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m radar_radar_options not in html -[2m2023-03-06T20:20:37.773014Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayout[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Payout: POST /v1/payouts/{payout}/cancel (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.773073Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpayout[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Payout: POST /v1/payouts/{payout}/reverse (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.782416Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.783135Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mlegal_entity_japan_address[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m legal_entity_japan_address not in html -[2m2023-03-06T20:20:37.785333Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mplan[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Plan: POST /v1/plans (already have [List]) -[2m2023-03-06T20:20:37.786975Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mplatform_tax_fee[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m platform_tax_fee not in html -[2m2023-03-06T20:20:37.801176Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mcustom_unit_amount[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m custom_unit_amount not in html -[2m2023-03-06T20:20:37.808476Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mpromotion_code[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for PromotionCode: POST /v1/promotion_codes (already have [List]) -[2m2023-03-06T20:20:37.812566Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mquote[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Quote: POST /v1/quotes (already have [List]) -[2m2023-03-06T20:20:37.812656Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mquote[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Quote: POST /v1/quotes/{quote} (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.812699Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mquote[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Quote: POST /v1/quotes/{quote}/accept (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.812733Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mquote[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Quote: POST /v1/quotes/{quote}/cancel (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.812789Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mquote[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Quote: POST /v1/quotes/{quote}/finalize (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.816344Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mquotes_resource_total_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m quotes_resource_total_details not in html -[2m2023-03-06T20:20:37.817186Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mradar.early_fraud_warning[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m radar.early_fraud_warning not in html -[2m2023-03-06T20:20:37.820683Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mrefund[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Refund: POST /v1/refunds/{refund}/cancel (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.823804Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mreserve_transaction[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m reserve_transaction not in html -[2m2023-03-06T20:20:37.825132Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mreview[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Review: POST /v1/reviews/{review}/approve (already have [List, Retrieve]) -[2m2023-03-06T20:20:37.833540Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mapi_errors[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m api_errors not in html -[2m2023-03-06T20:20:37.834531Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mthree_d_secure_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m three_d_secure_details not in html -[2m2023-03-06T20:20:37.838162Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msetup_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for SetupIntent: POST /v1/setup_intents/{intent}/cancel (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.838224Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msetup_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for SetupIntent: POST /v1/setup_intents/{intent}/confirm (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.838264Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msetup_intent[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for SetupIntent: POST /v1/setup_intents/{intent}/verify_microdeposits (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.887160Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mapi_errors[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m api_errors not in html -[2m2023-03-06T20:20:37.888536Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mlinked_account_options_us_bank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m linked_account_options_us_bank_account not in html -[2m2023-03-06T20:20:37.889146Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mmandate_options_off_session_details_blik[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m mandate_options_off_session_details_blik not in html -[2m2023-03-06T20:20:37.897870Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msource[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Source: POST /v1/sources/{source}/verify (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.914196Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.914752Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mshipping[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m shipping not in html -[2m2023-03-06T20:20:37.915214Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msource_mandate_notification[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m source_mandate_notification not in html -[2m2023-03-06T20:20:37.916275Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msource_transaction[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m source_transaction not in html -[2m2023-03-06T20:20:37.922479Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msubscription[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled DELETE for Subscription: /v1/subscriptions/{subscription_exposed_id}/discount -[2m2023-03-06T20:20:37.922536Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msubscription[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Subscription: POST /v1/subscriptions/{subscription}/resume (already have [List, Create, Retrieve, Update, Delete]) -[2m2023-03-06T20:20:37.953646Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_acss_debit[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_acss_debit not in html -[2m2023-03-06T20:20:37.954518Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_bancontact[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_bancontact not in html -[2m2023-03-06T20:20:37.954993Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_customer_balance[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_customer_balance not in html -[2m2023-03-06T20:20:37.955942Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_konbini[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_konbini not in html -[2m2023-03-06T20:20:37.956183Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_payment_method_options_us_bank_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_payment_method_options_us_bank_account not in html -[2m2023-03-06T20:20:37.957090Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msubscription_billing_thresholds[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m subscription_billing_thresholds not in html -[2m2023-03-06T20:20:37.957491Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msubscription_transfer_data[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m subscription_transfer_data not in html -[2m2023-03-06T20:20:37.961766Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msubscription_item_billing_thresholds[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m subscription_item_billing_thresholds not in html -[2m2023-03-06T20:20:37.963852Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msubscription_schedule[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for SubscriptionSchedule: POST /v1/subscription_schedules/{schedule}/cancel (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.963915Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0msubscription_schedule[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for SubscriptionSchedule: POST /v1/subscription_schedules/{schedule}/release (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:37.982834Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0minvoice_setting_subscription_schedule_setting[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m invoice_setting_subscription_schedule_setting not in html -[2m2023-03-06T20:20:37.983149Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msubscription_billing_thresholds[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m subscription_billing_thresholds not in html -[2m2023-03-06T20:20:37.983556Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msubscription_item_billing_thresholds[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m subscription_item_billing_thresholds not in html -[2m2023-03-06T20:20:37.983840Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0msubscription_transfer_data[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m subscription_transfer_data not in html -[2m2023-03-06T20:20:37.984920Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtax_deducted_at_source[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m tax_deducted_at_source not in html -[2m2023-03-06T20:20:37.991799Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0maddress[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m address not in html -[2m2023-03-06T20:20:37.995728Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtest_helpers.test_clock[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m test_helpers.test_clock not in html -[2m2023-03-06T20:20:38.004716Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mtopup[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Topup: POST /v1/topups (already have [List]) -[2m2023-03-06T20:20:38.004869Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mtopup[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UNKNOWN for Topup: POST /v1/topups/{topup}/cancel (already have [List, Retrieve, Update]) -[2m2023-03-06T20:20:38.006890Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mtransfer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for Transfer: POST /v1/transfers/{id}/reversals (already have [List, Create]) -[2m2023-03-06T20:20:38.007052Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0mtransfer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled UPDATE for Transfer: POST /v1/transfers/{transfer}/reversals/{id} (already have [List, Create, Retrieve, Update]) -[2m2023-03-06T20:20:38.008856Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.credit_reversal[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.credit_reversal not in html -[2m2023-03-06T20:20:38.010190Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.debit_reversal[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.debit_reversal not in html -[2m2023-03-06T20:20:38.011637Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.financial_account[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.financial_account not in html -[2m2023-03-06T20:20:38.015847Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.financial_account_features[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.financial_account_features not in html -[2m2023-03-06T20:20:38.016926Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_financial_accounts_resource_ach_toggle_settings[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_financial_accounts_resource_ach_toggle_settings not in html -[2m2023-03-06T20:20:38.018467Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_financial_accounts_resource_toggle_settings[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_financial_accounts_resource_toggle_settings not in html -[2m2023-03-06T20:20:38.019970Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.inbound_transfer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.inbound_transfer not in html -[2m2023-03-06T20:20:38.023535Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_shared_resource_billing_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_shared_resource_billing_details not in html -[2m2023-03-06T20:20:38.023928Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.outbound_payment[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.outbound_payment not in html -[2m2023-03-06T20:20:38.028232Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_shared_resource_billing_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_shared_resource_billing_details not in html -[2m2023-03-06T20:20:38.028625Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.outbound_transfer[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.outbound_transfer not in html -[2m2023-03-06T20:20:38.032130Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_shared_resource_billing_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_shared_resource_billing_details not in html -[2m2023-03-06T20:20:38.032510Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.received_credit[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.received_credit not in html -[2m2023-03-06T20:20:38.035534Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details not in html -[2m2023-03-06T20:20:38.036951Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.received_debit[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.received_debit not in html -[2m2023-03-06T20:20:38.039211Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details not in html -[2m2023-03-06T20:20:38.040678Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.transaction[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.transaction not in html -[2m2023-03-06T20:20:38.042395Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_transactions_resource_balance_impact[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_transactions_resource_balance_impact not in html -[2m2023-03-06T20:20:38.042831Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_transactions_resource_flow_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_transactions_resource_flow_details not in html -[2m2023-03-06T20:20:38.043838Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury.transaction_entry[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury.transaction_entry not in html -[2m2023-03-06T20:20:38.045892Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_transactions_resource_balance_impact[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_transactions_resource_balance_impact not in html -[2m2023-03-06T20:20:38.046299Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0mtreasury_transactions_resource_flow_details[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m treasury_transactions_resource_flow_details not in html -[2m2023-03-06T20:20:38.047569Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_impl_requests[0m[1m{[0m[3mname[0m[2m=[0musage_record[1m}[0m[2m:[0m [2mstripe_openapi_codegen::codegen[0m[2m:[0m unhandled CREATE for UsageRecord: POST /v1/subscription_items/{subscription_item}/usage_records (already have []) -[2m2023-03-06T20:20:38.047801Z[0m [33m WARN[0m [1mwrite[0m[1m{[0m[3mbase[0m[2m=[0m"out"[1m}[0m[2m:[0m[1mgenerate[0m[2m:[0m[1mgen_struct[0m[1m{[0m[3mname[0m[2m=[0musage_record_summary[1m}[0m[2m:[0m [2mstripe_openapi_codegen::url_finder[0m[2m:[0m usage_record_summary not in html -[2m2023-03-06T20:20:38.059087Z[0m [33m WARN[0m [2mstripe_openapi_codegen[0m[2m:[0m leftover objects: { - FileGenerator { - name: "address", - use_ids: {}, - use_config: {}, - use_params: {}, - use_resources: {}, - inferred_enums: {}, - inferred_unions: {}, - inferred_structs: {}, - inferred_parameters: {}, - generated_schemas: {}, - generated_objects: {}, - }, - FileGenerator { - name: "payment_source", - use_ids: {}, - use_config: {}, - use_params: {}, - use_resources: {}, - inferred_enums: {}, - inferred_unions: {}, - inferred_structs: {}, - inferred_parameters: {}, - generated_schemas: {}, - generated_objects: {}, - }, - FileGenerator { - name: "treasury_shared_resource_billing_details", - use_ids: {}, - use_config: {}, - use_params: {}, - use_resources: {}, - inferred_enums: {}, - inferred_unions: {}, - inferred_structs: {}, - inferred_parameters: {}, - generated_schemas: {}, - generated_objects: {}, - }, -} -[cargo-make] INFO - Execute Command: "rsync" "-a" "--delete-during" "out/" "../src/resources/generated" -[cargo-make] INFO - Execute Command: "rustup" "run" "nightly" "cargo" "fmt" -[cargo-make] INFO - Build Done in 8.82 seconds. diff --git a/stripe.json b/stripe.json deleted file mode 100644 index f22fbd265..000000000 --- a/stripe.json +++ /dev/null @@ -1,42430 +0,0 @@ -{ - "intro": { - "title": "Introduction", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "intro", - "section_anchor": "intro", - "subsection_anchors": [], - "path": "/", - "gate": false, - "display_on_load": true, - "data": { - "merchant": false, - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "user_email": null, - "login_as": null, - "section_type": "override", - "section_tag": "intro", - "version": null - } - }, - "authentication": { - "title": "Authentication", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "authentication", - "section_anchor": "authentication", - "subsection_anchors": [], - "path": "/authentication", - "gate": false, - "display_on_load": true, - "data": { - "example_explicit_api_key": "", - "merchant": false, - "request": "curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:\n# The colon prevents curl from asking for a password.", - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "section_type": "override", - "section_tag": "authentication", - "version": null - } - }, - "connected_accounts": { - "title": "Connected Accounts", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "connected_accounts", - "section_anchor": "connected_accounts", - "subsection_anchors": [], - "path": "/connected_accounts", - "gate": false, - "display_on_load": true, - "data": { - "example_explicit_account": "curl https://api.stripe.com/v1/charges/ch_3MWb7X2eZvKYlo2C1KB2kTo6 \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -H \"Stripe-Account: acct_1032D82eZvKYlo2C\" \\\n -G \n", - "section_type": "override", - "section_tag": "connected_accounts", - "version": null - } - }, - "errors": { - "title": "Errors", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "errors", - "section_anchor": "errors", - "subsection_anchors": ["error_handling"], - "path": "/errors", - "gate": false, - "display_on_load": true, - "data": { - "changes": {}, - "specs": { - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`", - "undocumented": false, - "html": "The type of error returned. One of \u003Ccode\u003Eapi_error\u003C/code\u003E, \u003Ccode\u003Ecard_error\u003C/code\u003E, \u003Ccode\u003Eidempotency_error\u003C/code\u003E, or \u003Ccode\u003Einvalid_request_error\u003C/code\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - }, - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For card errors, the ID of the failed charge.", - "undocumented": false, - "html": "For card errors, the ID of the failed charge." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "charge", - "less_common": true - }, - "code": { - "name": "code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For some errors that could be handled programmatically, a short string indicating the [error code](/docs/error-codes) reported.", - "undocumented": false, - "html": "For some errors that could be handled programmatically, a short string indicating the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "code" - }, - "decline_code": { - "name": "decline_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](/docs/declines#issuer-declines) if they provide one.", - "undocumented": false, - "html": "For card errors resulting from a card issuer decline, a short string indicating the \u003Ca href=\"/docs/declines#issuer-declines\"\u003Ecard issuer’s reason for the decline\u003C/a\u003E if they provide one." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "decline_code" - }, - "doc_url": { - "name": "doc_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A URL to more information about the [error code](/docs/error-codes) reported.", - "undocumented": false, - "html": "A URL to more information about the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "doc_url", - "less_common": true - }, - "message": { - "name": "message", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.", - "undocumented": false, - "html": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "message" - }, - "param": { - "name": "param", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "param" - }, - "payment_intent": { - "name": "payment_intent", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The PaymentIntent object for errors returned on a request involving a PaymentIntent.", - "undocumented": false, - "html": "The PaymentIntent object for errors returned on a request involving a PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_intent", - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "amount": { - "name": "amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](/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](/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).", - "undocumented": false, - "html": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the \u003Ca href=\"/docs/currencies#zero-decimal\"\u003Esmallest currency unit\u003C/a\u003E (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 \u003Ca href=\"/docs/currencies#minimum-and-maximum-charge-amounts\"\u003Eequivalent in charge currency\u003C/a\u003E. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "amount_capturable": { - "name": "amount_capturable", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount that can be captured from this PaymentIntent.", - "undocumented": false, - "html": "Amount that can be captured from this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_capturable", - "less_common": true - }, - "amount_details": { - "name": "amount_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Details about items included in the amount", - "undocumented": false, - "html": "Details about items included in the amount" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "tip": { - "name": "tip", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Portion of the amount that corresponds to a tip.\n", - "undocumented": false, - "html": "Portion of the amount that corresponds to a tip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount": { - "name": "amount", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Portion of the amount that corresponds to a tip.\n", - "undocumented": false, - "html": "Portion of the amount that corresponds to a tip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - } - }, - "object_type": "tip" - } - }, - "object_type": "amount_details", - "less_common": true - }, - "amount_received": { - "name": "amount_received", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount that was collected by this PaymentIntent.", - "undocumented": false, - "html": "Amount that was collected by this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_received", - "less_common": true - }, - "application": { - "name": "application", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the Connect application that created the PaymentIntent.", - "undocumented": false, - "html": "ID of the Connect application that created the PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["application"], - "object_type": "application", - "less_common": true - }, - "application_fee_amount": { - "name": "application_fee_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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](/docs/payments/connected-accounts).\n", - "undocumented": false, - "html": "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 \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_fee_amount", - "less_common": true - }, - "automatic_payment_methods": { - "name": "automatic_payment_methods", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)", - "undocumented": false, - "html": "Settings to configure compatible payment methods from the \u003Ca href=\"https://dashboard.stripe.com/settings/payment_methods\"\u003EStripe Dashboard\u003C/a\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "enabled": { - "name": "enabled", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Automatically calculates compatible payment methods", - "undocumented": false, - "html": "Automatically calculates compatible payment methods" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "enabled" - } - }, - "object_type": "automatic_payment_methods" - }, - "canceled_at": { - "name": "canceled_at", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Populated when \u003Ccode\u003Estatus\u003C/code\u003E is \u003Ccode\u003Ecanceled\u003C/code\u003E, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "canceled_at", - "less_common": true - }, - "cancellation_reason": { - "name": "cancellation_reason", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`).", - "undocumented": false, - "html": "Reason for cancellation of this PaymentIntent, either user-provided (\u003Ccode\u003Eduplicate\u003C/code\u003E, \u003Ccode\u003Efraudulent\u003C/code\u003E, \u003Ccode\u003Erequested_by_customer\u003C/code\u003E, or \u003Ccode\u003Eabandoned\u003C/code\u003E) or generated by Stripe internally (\u003Ccode\u003Efailed_invoice\u003C/code\u003E, \u003Ccode\u003Evoid_invoice\u003C/code\u003E, or \u003Ccode\u003Eautomatic\u003C/code\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cancellation_reason", - "less_common": true - }, - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "(Default) Stripe automatically captures funds when the customer authorizes the payment.", - "undocumented": false, - "html": "(Default) Stripe automatically captures funds when the customer authorizes the payment." - } - }, - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Place a hold on the funds when the customer authorizes the payment, but [don't capture the funds until later](/docs/payments/capture-later). (Not all payment methods support this.)", - "undocumented": false, - "html": "Place a hold on the funds when the customer authorizes the payment, but \u003Ca href=\"/docs/payments/capture-later\"\u003Edon’t capture the funds until later\u003C/a\u003E. (Not all payment methods support this.)" - } - } - }, - "object_type": "capture_method", - "less_common": true - }, - "client_secret": { - "name": "client_secret", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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, 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](/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.", - "undocumented": false, - "html": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \u003C/p\u003E\n\n\u003Cp\u003EThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\u003C/p\u003E\n\n\u003Cp\u003ERefer to our docs to \u003Ca href=\"/docs/payments/accept-a-payment?ui=elements\"\u003Eaccept a payment\u003C/a\u003E and learn about how \u003Ccode\u003Eclient_secret\u003C/code\u003E should be handled." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "client_secret" - }, - "confirmation_method": { - "name": "confirmation_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "", - "undocumented": false, - "html": "" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "(Default) PaymentIntent can be confirmed using a publishable key. After `next_action`s are handled, no additional confirmation is required to complete the payment.", - "undocumented": false, - "html": "(Default) PaymentIntent can be confirmed using a publishable key. After \u003Ccode\u003Enext_action\u003C/code\u003Es are handled, no additional confirmation is required to complete the payment." - } - }, - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All payment attempts must be made using a secret key. The PaymentIntent returns to the `requires_confirmation` state after handling `next_action`s, and requires your server to initiate each payment attempt with an explicit confirmation.", - "undocumented": false, - "html": "All payment attempts must be made using a secret key. The PaymentIntent returns to the \u003Ccode\u003Erequires_confirmation\u003C/code\u003E state after handling \u003Ccode\u003Enext_action\u003C/code\u003Es, and requires your server to initiate each payment attempt with an explicit confirmation." - } - } - }, - "object_type": "confirmation_method", - "less_common": true - }, - "created": { - "name": "created", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Time at which the object was created. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "created", - "less_common": true - }, - "currency": { - "name": "currency", - "check": "currency", - "validation": "currency", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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).", - "undocumented": false, - "html": "Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "currency" - }, - "customer": { - "name": "customer", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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](#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.\n", - "undocumented": false, - "html": "ID of the Customer this PaymentIntent belongs to, if one exists.\u003C/p\u003E\n\n\u003Cp\u003EPayment methods attached to other Customers cannot be used with this PaymentIntent.\u003C/p\u003E\n\n\u003Cp\u003EIf present in combination with \u003Ca href=\"#payment_intent_object-setup_future_usage\"\u003Esetup_future_usage\u003C/a\u003E, 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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["customer"], - "object_type": "customer" - }, - "description": { - "name": "description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An arbitrary string attached to the object. Often useful for displaying to users.", - "undocumented": false, - "html": "An arbitrary string attached to the object. Often useful for displaying to users." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "description" - }, - "invoice": { - "name": "invoice", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the invoice that created this PaymentIntent, if it exists.", - "undocumented": false, - "html": "ID of the invoice that created this PaymentIntent, if it exists." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["invoice"], - "object_type": "invoice", - "less_common": true - }, - "last_payment_error": { - "name": "last_payment_error", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.", - "undocumented": false, - "html": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For card errors, the ID of the failed charge.", - "undocumented": false, - "html": "For card errors, the ID of the failed charge." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "charge", - "less_common": true - }, - "code": { - "name": "code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For some errors that could be handled programmatically, a short string indicating the [error code](/docs/error-codes) reported.", - "undocumented": false, - "html": "For some errors that could be handled programmatically, a short string indicating the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "code" - }, - "decline_code": { - "name": "decline_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](/docs/declines#issuer-declines) if they provide one.", - "undocumented": false, - "html": "For card errors resulting from a card issuer decline, a short string indicating the \u003Ca href=\"/docs/declines#issuer-declines\"\u003Ecard issuer’s reason for the decline\u003C/a\u003E if they provide one." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "decline_code" - }, - "doc_url": { - "name": "doc_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A URL to more information about the [error code](/docs/error-codes) reported.", - "undocumented": false, - "html": "A URL to more information about the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "doc_url", - "less_common": true - }, - "message": { - "name": "message", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.", - "undocumented": false, - "html": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "message" - }, - "param": { - "name": "param", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "param" - }, - "payment_method": { - "name": "payment_method", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The PaymentMethod object for errors returned on a request involving a PaymentMethod.", - "undocumented": false, - "html": "The PaymentMethod object for errors returned on a request involving a PaymentMethod." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "acss_debit": { - "name": "acss_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eacss_debit\u003C/code\u003E PaymentMethod, this hash contains details about the ACSS Debit payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Name of the bank associated with the bank account.", - "undocumented": false, - "html": "Name of the bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "institution_number": { - "name": "institution_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Institution number of the bank account.", - "undocumented": false, - "html": "Institution number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "institution_number" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "transit_number": { - "name": "transit_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transit number of the bank account.", - "undocumented": false, - "html": "Transit number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "transit_number" - } - }, - "object_type": "acss_debit", - "less_common": true - }, - "affirm": { - "name": "affirm", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eaffirm\u003C/code\u003E PaymentMethod, this hash contains details about the Affirm payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "affirm", - "less_common": true - }, - "afterpay_clearpay": { - "name": "afterpay_clearpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003EAfterpayClearpay\u003C/code\u003E PaymentMethod, this hash contains details about the AfterpayClearpay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "afterpay_clearpay", - "less_common": true - }, - "alipay": { - "name": "alipay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003EAlipay\u003C/code\u003E PaymentMethod, this hash contains details about the Alipay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "alipay", - "less_common": true - }, - "au_becs_debit": { - "name": "au_becs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eau_becs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bsb_number": { - "name": "bsb_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Six-digit number identifying bank and branch associated with this bank account.", - "undocumented": false, - "html": "Six-digit number identifying bank and branch associated with this bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bsb_number" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - } - }, - "object_type": "au_becs_debit", - "less_common": true - }, - "bacs_debit": { - "name": "bacs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ebacs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the Bacs Direct Debit bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "sort_code": { - "name": "sort_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Sort code of the bank account. (e.g., `10-20-30`)", - "undocumented": false, - "html": "Sort code of the bank account. (e.g., \u003Ccode\u003E10-20-30\u003C/code\u003E)" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "sort_code" - } - }, - "object_type": "bacs_debit", - "less_common": true - }, - "bancontact": { - "name": "bancontact", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ebancontact\u003C/code\u003E PaymentMethod, this hash contains details about the Bancontact payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "bancontact", - "less_common": true - }, - "billing_details": { - "name": "billing_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", - "undocumented": false, - "html": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "address": { - "name": "address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing address.", - "undocumented": false, - "html": "Billing address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Email address.", - "undocumented": false, - "html": "Email address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Full name.", - "undocumented": false, - "html": "Full name." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "phone": { - "name": "phone", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing phone number (including extension).", - "undocumented": false, - "html": "Billing phone number (including extension)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "phone" - } - }, - "object_type": "billing_details" - }, - "blik": { - "name": "blik", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eblik\u003C/code\u003E PaymentMethod, this hash contains details about the BLIK payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "blik", - "less_common": true - }, - "boleto": { - "name": "boleto", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eboleto\u003C/code\u003E PaymentMethod, this hash contains details about the Boleto payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": null, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "tax_id": { - "name": "tax_id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies the customer tax id (CNPJ or CPF)", - "undocumented": false, - "html": "Uniquely identifies the customer tax id (CNPJ or CPF)" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tax_id" - } - }, - "object_type": "boleto", - "less_common": true - }, - "card": { - "name": "card", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `card` PaymentMethod, this hash contains the user's card details.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecard\u003C/code\u003E PaymentMethod, this hash contains the user’s card details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "checks": { - "name": "checks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checks on Card address and CVC if provided.", - "undocumented": false, - "html": "Checks on Card address and CVC if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "address_line1_check": { - "name": "address_line1_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a address line1 was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "address_line1_check" - }, - "address_postal_code_check": { - "name": "address_postal_code_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a address postal code was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "address_postal_code_check" - }, - "cvc_check": { - "name": "cvc_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a CVC was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cvc_check" - } - }, - "object_type": "checks" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": "card_fingerprint_read", - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "generated_from": { - "name": "generated_from", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": { - "sdk_client_public": { - "gate_specific": {}, - "localize_terms": [], - "undocumented": true, - "html": null - } - }, - "localize_terms": [], - "markdown": "Details of the original PaymentMethod that created this object.", - "undocumented": false, - "html": "Details of the original PaymentMethod that created this object." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The charge that created this object.", - "undocumented": false, - "html": "The charge that created this object." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "charge" - }, - "payment_method_details": { - "name": "payment_method_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transaction-specific details of the payment method used in the payment.", - "undocumented": false, - "html": "Transaction-specific details of the payment method used in the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "card_present": { - "name": "card_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "This hash contains the snapshot of the `card_present` transaction-specific details which generated this `card` payment method.", - "undocumented": false, - "html": "This hash contains the snapshot of the \u003Ccode\u003Ecard_present\u003C/code\u003E transaction-specific details which generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount_authorized": { - "name": "amount_authorized", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The authorized amount", - "undocumented": false, - "html": "The authorized amount" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_authorized" - }, - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "capture_before": { - "name": "capture_before", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.", - "undocumented": false, - "html": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "capture_before" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "emv_auth_data": { - "name": "emv_auth_data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Authorization response cryptogram.", - "undocumented": false, - "html": "Authorization response cryptogram." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "emv_auth_data" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "generated_card": { - "name": "generated_card", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "generated_card" - }, - "incremental_authorization_supported": { - "name": "incremental_authorization_supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether this [PaymentIntent](/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).", - "undocumented": false, - "html": "Whether this \u003Ca href=\"/docs/api/payment_intents\"\u003EPaymentIntent\u003C/a\u003E is eligible for incremental authorizations. Request support using \u003Ca href=\"/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support\"\u003Erequest_incremental_authorization_support\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "incremental_authorization_supported" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "network": { - "name": "network", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Identifies which network this charge was processed on. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ecartes_bancaires\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "network" - }, - "overcapture_supported": { - "name": "overcapture_supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Defines whether the authorized amount can be over-captured or not", - "undocumented": false, - "html": "Defines whether the authorized amount can be over-captured or not" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "overcapture_supported" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - }, - "receipt": { - "name": "receipt", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", - "undocumented": false, - "html": "A collection of fields required to be displayed on receipts. Only required for EMV transactions." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_type": { - "name": "account_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of account being debited or credited", - "undocumented": false, - "html": "The type of account being debited or credited" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "credit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A credit account, as when using a credit card", - "undocumented": false, - "html": "A credit account, as when using a credit card" - } - }, - "checking": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A checking account, as when using a debit card", - "undocumented": false, - "html": "A checking account, as when using a debit card" - } - }, - "prepaid": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A prepaid account, as when using a debit gift card", - "undocumented": false, - "html": "A prepaid account, as when using a debit gift card" - } - }, - "unknown": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An unknown account", - "undocumented": false, - "html": "An unknown account" - } - } - }, - "object_type": "account_type" - }, - "application_cryptogram": { - "name": "application_cryptogram", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 9F26, cryptogram generated by the integrated circuit chip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_cryptogram" - }, - "application_preferred_name": { - "name": "application_preferred_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Mnenomic of the Application Identifier.", - "undocumented": false, - "html": "Mnenomic of the Application Identifier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_preferred_name" - }, - "authorization_code": { - "name": "authorization_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Identifier for this transaction.", - "undocumented": false, - "html": "Identifier for this transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "authorization_code" - }, - "authorization_response_code": { - "name": "authorization_response_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 8A. A code returned by the card issuer.", - "undocumented": false, - "html": "EMV tag 8A. A code returned by the card issuer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "authorization_response_code" - }, - "cardholder_verification_method": { - "name": "cardholder_verification_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How the cardholder verified ownership of the card.", - "undocumented": false, - "html": "How the cardholder verified ownership of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_verification_method" - }, - "dedicated_file_name": { - "name": "dedicated_file_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "dedicated_file_name" - }, - "terminal_verification_results": { - "name": "terminal_verification_results", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The outcome of a series of EMV functions performed by the card reader.", - "undocumented": false, - "html": "The outcome of a series of EMV functions performed by the card reader." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "terminal_verification_results" - }, - "transaction_status_information": { - "name": "transaction_status_information", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An indication of various EMV functions performed during the transaction.", - "undocumented": false, - "html": "An indication of various EMV functions performed during the transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "transaction_status_information" - } - }, - "object_type": "receipt" - } - }, - "object_type": "card_present" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.", - "undocumented": false, - "html": "The type of payment method transaction-specific details from the transaction that generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method. Always \u003Ccode\u003Ecard_present\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "payment_method_details" - }, - "setup_attempt": { - "name": "setup_attempt", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the SetupAttempt that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["setup_attempt"], - "object_type": "setup_attempt" - } - }, - "object_type": "generated_from" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "three_d_secure_usage": { - "name": "three_d_secure_usage", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains details on how this Card may be used for 3D Secure authentication.", - "undocumented": false, - "html": "Contains details on how this Card may be used for 3D Secure authentication." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "supported": { - "name": "supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether 3D Secure is supported on this card.", - "undocumented": false, - "html": "Whether 3D Secure is supported on this card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported" - } - }, - "object_type": "three_d_secure_usage" - }, - "wallet": { - "name": "wallet", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this Card is part of a card wallet, this contains the details of the card wallet.", - "undocumented": false, - "html": "If this Card is part of a card wallet, this contains the details of the card wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amex_express_checkout": { - "name": "amex_express_checkout", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `amex_express_checkout` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "amex_express_checkout" - }, - "apple_pay": { - "name": "apple_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `apple_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eapple_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "apple_pay" - }, - "dynamic_last4": { - "name": "dynamic_last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "(For tokenized numbers only.) The last four digits of the device account number.", - "undocumented": false, - "html": "(For tokenized numbers only.) The last four digits of the device account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "dynamic_last4" - }, - "google_pay": { - "name": "google_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `google_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egoogle_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "google_pay" - }, - "masterpass": { - "name": "masterpass", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `masterpass` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Emasterpass\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "billing_address": { - "name": "billing_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "billing_address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "shipping_address": { - "name": "shipping_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "shipping_address" - } - }, - "object_type": "masterpass" - }, - "samsung_pay": { - "name": "samsung_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `samsung_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esamsung_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "samsung_pay" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "The type of the card wallet, one of \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E, \u003Ccode\u003Eapple_pay\u003C/code\u003E, \u003Ccode\u003Egoogle_pay\u003C/code\u003E, \u003Ccode\u003Emasterpass\u003C/code\u003E, \u003Ccode\u003Esamsung_pay\u003C/code\u003E, or \u003Ccode\u003Evisa_checkout\u003C/code\u003E. 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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - }, - "visa_checkout": { - "name": "visa_checkout", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `visa_checkout` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Evisa_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "billing_address": { - "name": "billing_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "billing_address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "shipping_address": { - "name": "shipping_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "shipping_address" - } - }, - "object_type": "visa_checkout" - } - }, - "object_type": "wallet" - } - }, - "object_type": "card", - "less_common": true - }, - "card_present": { - "name": "card_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `card_present` PaymentMethod, this hash contains details about the Card Present payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecard_present\u003C/code\u003E PaymentMethod, this hash contains details about the Card Present payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - } - }, - "object_type": "card_present", - "less_common": true - }, - "created": { - "name": "created", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Time at which the object was created. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "created", - "less_common": true - }, - "customer": { - "name": "customer", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["customer"], - "object_type": "customer" - }, - "customer_balance": { - "name": "customer_balance", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecustomer_balance\u003C/code\u003E PaymentMethod, this hash contains details about the CustomerBalance payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "customer_balance", - "less_common": true - }, - "eps": { - "name": "eps", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eeps\u003C/code\u003E PaymentMethod, this hash contains details about the EPS payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`, `deutsche_bank_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`.", - "undocumented": false, - "html": "The customer’s bank. Should be one of \u003Ccode\u003Earzte_und_apotheker_bank\u003C/code\u003E, \u003Ccode\u003Eaustrian_anadi_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebank_austria\u003C/code\u003E, \u003Ccode\u003Ebankhaus_carl_spangler\u003C/code\u003E, \u003Ccode\u003Ebankhaus_schelhammer_und_schattera_ag\u003C/code\u003E, \u003Ccode\u003Ebawag_psk_ag\u003C/code\u003E, \u003Ccode\u003Ebks_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebrull_kallmus_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebtv_vier_lander_bank\u003C/code\u003E, \u003Ccode\u003Ecapital_bank_grawe_gruppe_ag\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank_ag\u003C/code\u003E, \u003Ccode\u003Edolomitenbank\u003C/code\u003E, \u003Ccode\u003Eeasybank_ag\u003C/code\u003E, \u003Ccode\u003Eerste_bank_und_sparkassen\u003C/code\u003E, \u003Ccode\u003Ehypo_alpeadriabank_international_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_noe_lb_fur_niederosterreich_u_wien\u003C/code\u003E, \u003Ccode\u003Ehypo_oberosterreich_salzburg_steiermark\u003C/code\u003E, \u003Ccode\u003Ehypo_tirol_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_vorarlberg_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_bank_burgenland_aktiengesellschaft\u003C/code\u003E, \u003Ccode\u003Emarchfelder_bank\u003C/code\u003E, \u003Ccode\u003Eoberbank_ag\u003C/code\u003E, \u003Ccode\u003Eraiffeisen_bankengruppe_osterreich\u003C/code\u003E, \u003Ccode\u003Eschoellerbank_ag\u003C/code\u003E, \u003Ccode\u003Esparda_bank_wien\u003C/code\u003E, \u003Ccode\u003Evolksbank_gruppe\u003C/code\u003E, \u003Ccode\u003Evolkskreditbank_ag\u003C/code\u003E, or \u003Ccode\u003Evr_bank_braunau\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - } - }, - "object_type": "eps", - "less_common": true - }, - "fpx": { - "name": "fpx", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Efpx\u003C/code\u003E PaymentMethod, this hash contains details about the FPX payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `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`, `pb_enterprise`, or `bank_of_china`.", - "undocumented": false, - "html": "The customer’s bank, if provided. Can be one of \u003Ccode\u003Eaffin_bank\u003C/code\u003E, \u003Ccode\u003Eagrobank\u003C/code\u003E, \u003Ccode\u003Ealliance_bank\u003C/code\u003E, \u003Ccode\u003Eambank\u003C/code\u003E, \u003Ccode\u003Ebank_islam\u003C/code\u003E, \u003Ccode\u003Ebank_muamalat\u003C/code\u003E, \u003Ccode\u003Ebank_rakyat\u003C/code\u003E, \u003Ccode\u003Ebsn\u003C/code\u003E, \u003Ccode\u003Ecimb\u003C/code\u003E, \u003Ccode\u003Ehong_leong_bank\u003C/code\u003E, \u003Ccode\u003Ehsbc\u003C/code\u003E, \u003Ccode\u003Ekfh\u003C/code\u003E, \u003Ccode\u003Emaybank2u\u003C/code\u003E, \u003Ccode\u003Eocbc\u003C/code\u003E, \u003Ccode\u003Epublic_bank\u003C/code\u003E, \u003Ccode\u003Erhb\u003C/code\u003E, \u003Ccode\u003Estandard_chartered\u003C/code\u003E, \u003Ccode\u003Euob\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank\u003C/code\u003E, \u003Ccode\u003Emaybank2e\u003C/code\u003E, \u003Ccode\u003Epb_enterprise\u003C/code\u003E, or \u003Ccode\u003Ebank_of_china\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - } - }, - "object_type": "fpx", - "less_common": true - }, - "giropay": { - "name": "giropay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egiropay\u003C/code\u003E PaymentMethod, this hash contains details about the Giropay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "giropay", - "less_common": true - }, - "grabpay": { - "name": "grabpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egrabpay\u003C/code\u003E PaymentMethod, this hash contains details about the GrabPay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "grabpay", - "less_common": true - }, - "ideal": { - "name": "ideal", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eideal\u003C/code\u003E PaymentMethod, this hash contains details about the iDEAL payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`.", - "undocumented": false, - "html": "The customer’s bank, if provided. Can be one of \u003Ccode\u003Eabn_amro\u003C/code\u003E, \u003Ccode\u003Easn_bank\u003C/code\u003E, \u003Ccode\u003Ebunq\u003C/code\u003E, \u003Ccode\u003Ehandelsbanken\u003C/code\u003E, \u003Ccode\u003Eing\u003C/code\u003E, \u003Ccode\u003Eknab\u003C/code\u003E, \u003Ccode\u003Emoneyou\u003C/code\u003E, \u003Ccode\u003Erabobank\u003C/code\u003E, \u003Ccode\u003Eregiobank\u003C/code\u003E, \u003Ccode\u003Erevolut\u003C/code\u003E, \u003Ccode\u003Esns_bank\u003C/code\u003E, \u003Ccode\u003Etriodos_bank\u003C/code\u003E, or \u003Ccode\u003Evan_lanschot\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - }, - "bic": { - "name": "bic", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Bank Identifier Code of the customer's bank, if the bank was provided.", - "undocumented": false, - "html": "The Bank Identifier Code of the customer’s bank, if the bank was provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bic" - } - }, - "object_type": "ideal", - "less_common": true - }, - "interac_present": { - "name": "interac_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Einterac_present\u003C/code\u003E PaymentMethod, this hash contains details about the Interac Present payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `interac`, `mastercard` or `visa`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E or \u003Ccode\u003Evisa\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "preferred_locales": { - "name": "preferred_locales", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred_locales" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - } - }, - "object_type": "interac_present", - "less_common": true - }, - "klarna": { - "name": "klarna", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eklarna\u003C/code\u003E PaymentMethod, this hash contains details about the Klarna payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "dob": { - "name": "dob", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's date of birth, if provided.", - "undocumented": false, - "html": "The customer’s date of birth, if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "day": { - "name": "day", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The day of birth, between 1 and 31.", - "undocumented": false, - "html": "The day of birth, between 1 and 31." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "day" - }, - "month": { - "name": "month", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The month of birth, between 1 and 12.", - "undocumented": false, - "html": "The month of birth, between 1 and 12." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "month" - }, - "year": { - "name": "year", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The four-digit year of birth.", - "undocumented": false, - "html": "The four-digit year of birth." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "year" - } - }, - "object_type": "dob" - } - }, - "object_type": "klarna", - "less_common": true - }, - "konbini": { - "name": "konbini", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ekonbini\u003C/code\u003E PaymentMethod, this hash contains details about the Konbini payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "konbini", - "less_common": true - }, - "link": { - "name": "link", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003ELink\u003C/code\u003E PaymentMethod, this hash contains details about the Link payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account owner's email address.", - "undocumented": false, - "html": "Account owner’s email address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "persistent_token": { - "name": "persistent_token", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Token used for persistent Link logins.", - "undocumented": false, - "html": "Token used for persistent Link logins." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "persistent_token" - } - }, - "object_type": "link", - "less_common": true - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "oxxo": { - "name": "oxxo", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eoxxo\u003C/code\u003E PaymentMethod, this hash contains details about the OXXO payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "oxxo", - "less_common": true - }, - "p24": { - "name": "p24", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ep24\u003C/code\u003E PaymentMethod, this hash contains details about the P24 payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's bank, if provided.", - "undocumented": false, - "html": "The customer’s bank, if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "ing": { "documentation": null }, - "citi_handlowy": { "documentation": null }, - "tmobile_usbugi_bankowe": { "documentation": null }, - "plus_bank": { "documentation": null }, - "etransfer_pocztowy24": { "documentation": null }, - "banki_spbdzielcze": { "documentation": null }, - "bank_nowy_bfg_sa": { "documentation": null }, - "getin_bank": { "documentation": null }, - "blik": { "documentation": null }, - "noble_pay": { "documentation": null }, - "ideabank": { "documentation": null }, - "envelobank": { "documentation": null }, - "santander_przelew24": { "documentation": null }, - "nest_przelew": { "documentation": null }, - "mbank_mtransfer": { "documentation": null }, - "inteligo": { "documentation": null }, - "pbac_z_ipko": { "documentation": null }, - "bnp_paribas": { "documentation": null }, - "credit_agricole": { "documentation": null }, - "toyota_bank": { "documentation": null }, - "bank_pekao_sa": { "documentation": null }, - "volkswagen_bank": { "documentation": null }, - "bank_millennium": { "documentation": null }, - "alior_bank": { "documentation": null }, - "boz": { "documentation": null } - }, - "object_type": "bank" - } - }, - "object_type": "p24", - "less_common": true - }, - "paynow": { - "name": "paynow", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epaynow\u003C/code\u003E PaymentMethod, this hash contains details about the PayNow payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "paynow", - "less_common": true - }, - "pix": { - "name": "pix", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epix\u003C/code\u003E PaymentMethod, this hash contains details about the Pix payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "pix", - "less_common": true - }, - "promptpay": { - "name": "promptpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epromptpay\u003C/code\u003E PaymentMethod, this hash contains details about the PromptPay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "promptpay", - "less_common": true - }, - "radar_options": { - "name": "radar_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Options to configure Radar. See [Radar Session](/docs/radar/radar-session) for more information.", - "undocumented": false, - "html": "Options to configure Radar. See \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E for more information." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "session": { - "name": "session", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A [Radar Session](/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", - "undocumented": false, - "html": "A \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "session" - } - }, - "object_type": "radar_options", - "less_common": true - }, - "sepa_debit": { - "name": "sepa_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esepa_debit\u003C/code\u003E PaymentMethod, this hash contains details about the SEPA debit bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_code": { - "name": "bank_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank code of bank associated with the bank account.", - "undocumented": false, - "html": "Bank code of bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_code" - }, - "branch_code": { - "name": "branch_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Branch code of bank associated with the bank account.", - "undocumented": false, - "html": "Branch code of bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "branch_code" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter ISO code representing the country the bank account is located in.", - "undocumented": false, - "html": "Two-letter ISO code representing the country the bank account is located in." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "generated_from": { - "name": "generated_from", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Information about the object that generated this PaymentMethod.", - "undocumented": false, - "html": "Information about the object that generated this PaymentMethod." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Charge that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the Charge that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["charge"], - "object_type": "charge" - }, - "setup_attempt": { - "name": "setup_attempt", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the SetupAttempt that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["setup_attempt"], - "object_type": "setup_attempt" - } - }, - "object_type": "generated_from" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four characters of the IBAN.", - "undocumented": false, - "html": "Last four characters of the IBAN." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - } - }, - "object_type": "sepa_debit", - "less_common": true - }, - "sofort": { - "name": "sofort", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esofort\u003C/code\u003E PaymentMethod, this hash contains details about the SOFORT payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter ISO code representing the country the bank account is located in.", - "undocumented": false, - "html": "Two-letter ISO code representing the country the bank account is located in." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - } - }, - "object_type": "sofort", - "less_common": true - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "acss_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Pre-authorized debit payments](/docs/payments/acss-debit) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/acss-debit\"\u003EPre-authorized debit payments\u003C/a\u003E are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS)." - } - }, - "affirm": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Affirm](/docs/payments/affirm) is a buy now, pay later payment method in the US.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/affirm\"\u003EAffirm\u003C/a\u003E is a buy now, pay later payment method in the US." - } - }, - "afterpay_clearpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Afterpay / Clearpay](/docs/payments/afterpay-clearpay) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/afterpay-clearpay\"\u003EAfterpay / Clearpay\u003C/a\u003E is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US." - } - }, - "alipay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Alipay](/docs/payments/alipay) is a digital wallet payment method used in China.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/alipay\"\u003EAlipay\u003C/a\u003E is a digital wallet payment method used in China." - } - }, - "au_becs_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[BECS Direct Debit](/docs/payments/au-becs-debit) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/au-becs-debit\"\u003EBECS Direct Debit\u003C/a\u003E is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS)." - } - }, - "bacs_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Bacs Direct Debit](/docs/payments/payment-methods/bacs-debit) is used to debit UK bank accounts.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/payment-methods/bacs-debit\"\u003EBacs Direct Debit\u003C/a\u003E is used to debit UK bank accounts." - } - }, - "bancontact": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Bancontact](/docs/payments/bancontact) is a bank redirect payment method used in Belgium.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/bancontact\"\u003EBancontact\u003C/a\u003E is a bank redirect payment method used in Belgium." - } - }, - "blik": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[BLIK](/docs/payments/blik) is a single-use payment method common in Poland.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/blik\"\u003EBLIK\u003C/a\u003E is a single-use payment method common in Poland." - } - }, - "boleto": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Boleto](/docs/payments/boleto) is a voucher-based payment method used in Brazil.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/boleto\"\u003EBoleto\u003C/a\u003E is a voucher-based payment method used in Brazil." - } - }, - "card": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Card payments](/docs/payments/payment-methods/overview#cards) are supported through many networks and card brands.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/payment-methods/overview#cards\"\u003ECard payments\u003C/a\u003E are supported through many networks and card brands." - } - }, - "card_present": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Stripe Terminal](/docs/terminal/payments/collect-payment) is used to collect in-person card payments.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E is used to collect in-person card payments." - } - }, - "customer_balance": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uses a customer’s [cash balance](/docs/payments/customer-balance) for the payment.", - "undocumented": false, - "html": "Uses a customer’s \u003Ca href=\"/docs/payments/customer-balance\"\u003Ecash balance\u003C/a\u003E for the payment." - } - }, - "eps": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[EPS](/docs/payments/eps) is an Austria-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/eps\"\u003EEPS\u003C/a\u003E is an Austria-based bank redirect payment method." - } - }, - "fpx": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[FPX](/docs/payments/fpx) is a Malaysia-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/fpx\"\u003EFPX\u003C/a\u003E is a Malaysia-based bank redirect payment method." - } - }, - "giropay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[giropay](/docs/payments/giropay) is a German bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/giropay\"\u003Egiropay\u003C/a\u003E is a German bank redirect payment method." - } - }, - "grabpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[GrabPay](/docs/payments/grabpay) is a digital wallet payment method used in Southeast Asia.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/grabpay\"\u003EGrabPay\u003C/a\u003E is a digital wallet payment method used in Southeast Asia." - } - }, - "ideal": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[iDEAL](/docs/payments/ideal) is a Netherlands-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/ideal\"\u003EiDEAL\u003C/a\u003E is a Netherlands-based bank redirect payment method." - } - }, - "interac_present": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Stripe Terminal](/docs/terminal/payments/collect-payment) accepts [Interac](/docs/terminal/payments/regional?integration-country=CA#interac-payments) debit cards for in-person payments in Canada.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E accepts \u003Ca href=\"/docs/terminal/payments/regional?integration-country=CA#interac-payments\"\u003EInterac\u003C/a\u003E debit cards for in-person payments in Canada." - } - }, - "klarna": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Klarna](/docs/payments/klarna) is a global buy now, pay later payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/klarna\"\u003EKlarna\u003C/a\u003E is a global buy now, pay later payment method." - } - }, - "konbini": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Konbini](/docs/payments/konbini) is a cash-based voucher payment method used in Japan.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/konbini\"\u003EKonbini\u003C/a\u003E is a cash-based voucher payment method used in Japan." - } - }, - "link": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Link](/docs/payments/link) allows customers to pay with their saved payment details.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/link\"\u003ELink\u003C/a\u003E allows customers to pay with their saved payment details." - } - }, - "oxxo": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[OXXO](/docs/payments/oxxo) is a cash-based voucher payment method used in Mexico.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/oxxo\"\u003EOXXO\u003C/a\u003E is a cash-based voucher payment method used in Mexico." - } - }, - "p24": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Przelewy24](/docs/payments/p24) is a bank redirect payment method used in Poland.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/p24\"\u003EPrzelewy24\u003C/a\u003E is a bank redirect payment method used in Poland." - } - }, - "paynow": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[PayNow](/docs/payments/paynow) is a QR code payment method used in Singapore.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/paynow\"\u003EPayNow\u003C/a\u003E is a QR code payment method used in Singapore." - } - }, - "pix": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Pix](/docs/payments/pix) is an instant bank transfer payment method in Brazil.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/pix\"\u003EPix\u003C/a\u003E is an instant bank transfer payment method in Brazil." - } - }, - "promptpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[PromptPay](/docs/payments/promptpay) is an instant funds transfer service popular in Thailand.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/promptpay\"\u003EPromptPay\u003C/a\u003E is an instant funds transfer service popular in Thailand." - } - }, - "sepa_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[SEPA Direct Debit](/docs/payments/sepa-debit) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/sepa-debit\"\u003ESEPA Direct Debit\u003C/a\u003E is used to debit bank accounts within the Single Euro Payments Area (SEPA) region." - } - }, - "sofort": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Sofort](/docs/payments/sofort) is a bank redirect payment method used in Europe.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/sofort\"\u003ESofort\u003C/a\u003E is a bank redirect payment method used in Europe." - } - }, - "us_bank_account": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[ACH Direct Debit](/docs/payments/ach-debit) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/ach-debit\"\u003EACH Direct Debit\u003C/a\u003E is used to debit US bank accounts through the Automated Clearing House (ACH) payments system." - } - }, - "wechat_pay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[WeChat Pay](/docs/payments/wechat-pay) is a digital wallet payment method based in China.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/wechat-pay\"\u003EWeChat Pay\u003C/a\u003E is a digital wallet payment method based in China." - } - } - }, - "object_type": "type" - }, - "us_bank_account": { - "name": "us_bank_account", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eus_bank_account\u003C/code\u003E PaymentMethod, this hash contains details about the US bank account payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_holder_type": { - "name": "account_holder_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account holder type: individual or company.", - "undocumented": false, - "html": "Account holder type: individual or company." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "individual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account belongs to an individual", - "undocumented": false, - "html": "Account belongs to an individual" - } - }, - "company": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account belongs to a company", - "undocumented": false, - "html": "Account belongs to a company" - } - } - }, - "object_type": "account_holder_type" - }, - "account_type": { - "name": "account_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account type: checkings or savings. Defaults to checking if omitted.", - "undocumented": false, - "html": "Account type: checkings or savings. Defaults to checking if omitted." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "checking": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account type is checking", - "undocumented": false, - "html": "Bank account type is checking" - } - }, - "savings": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account type is savings", - "undocumented": false, - "html": "Bank account type is savings" - } - } - }, - "object_type": "account_type" - }, - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The name of the bank.", - "undocumented": false, - "html": "The name of the bank." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "financial_connections_account": { - "name": "financial_connections_account", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Financial Connections Account used to create the payment method.", - "undocumented": false, - "html": "The ID of the Financial Connections Account used to create the payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "financial_connections_account" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about US bank account networks that can be used.", - "undocumented": false, - "html": "Contains information about US bank account networks that can be used." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network.", - "undocumented": false, - "html": "The preferred network." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - }, - "supported": { - "name": "supported", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All supported networks.", - "undocumented": false, - "html": "All supported networks." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported" - } - }, - "object_type": "networks" - }, - "routing_number": { - "name": "routing_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Routing number of the bank account.", - "undocumented": false, - "html": "Routing number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "routing_number" - } - }, - "object_type": "us_bank_account", - "less_common": true - }, - "wechat_pay": { - "name": "wechat_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Ewechat_pay\u003C/code\u003E PaymentMethod, this hash contains details about the wechat_pay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "wechat_pay", - "less_common": true - } - }, - "object_type": "payment_method", - "less_common": true - }, - "payment_method_type": { - "name": "payment_method_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_method_type", - "less_common": true - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`", - "undocumented": false, - "html": "The type of error returned. One of \u003Ccode\u003Eapi_error\u003C/code\u003E, \u003Ccode\u003Ecard_error\u003C/code\u003E, \u003Ccode\u003Eidempotency_error\u003C/code\u003E, or \u003Ccode\u003Einvalid_request_error\u003C/code\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "last_payment_error" - }, - "latest_charge": { - "name": "latest_charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The latest charge created by this payment intent.", - "undocumented": false, - "html": "The latest charge created by this payment intent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["charge"], - "object_type": "latest_charge" - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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](/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E 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 \u003Ca href=\"/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata\"\u003Edocumentation\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "next_action": { - "name": "next_action", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "alipay_handle_redirect": { - "name": "alipay_handle_redirect", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains instructions for authenticating a payment by redirecting your customer to Alipay App or website.", - "undocumented": false, - "html": "Contains instructions for authenticating a payment by redirecting your customer to Alipay App or website." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "native_data": { - "name": "native_data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "native_data" - }, - "native_url": { - "name": "native_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.", - "undocumented": false, - "html": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "native_url" - }, - "return_url": { - "name": "return_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", - "undocumented": false, - "html": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "return_url" - }, - "url": { - "name": "url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL you must redirect your customer to in order to authenticate the payment.", - "undocumented": false, - "html": "The URL you must redirect your customer to in order to authenticate the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "url" - } - }, - "object_type": "alipay_handle_redirect" - }, - "boleto_display_details": { - "name": "boleto_display_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains Boleto details necessary for the customer to complete the payment.", - "undocumented": false, - "html": "Contains Boleto details necessary for the customer to complete the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "expires_at": { - "name": "expires_at", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The timestamp after which the boleto expires.", - "undocumented": false, - "html": "The timestamp after which the boleto expires." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_at" - }, - "hosted_voucher_url": { - "name": "hosted_voucher_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.", - "undocumented": false, - "html": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_voucher_url" - }, - "number": { - "name": "number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The boleto number.", - "undocumented": false, - "html": "The boleto number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "number" - }, - "pdf": { - "name": "pdf", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL to the downloadable boleto voucher PDF.", - "undocumented": false, - "html": "The URL to the downloadable boleto voucher PDF." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "pdf" - } - }, - "object_type": "boleto_display_details" - }, - "card_await_notification": { - "name": "card_await_notification", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains instructions for processing off session recurring payments with Indian issued cards.", - "undocumented": false, - "html": "Contains instructions for processing off session recurring payments with Indian issued cards." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge_attempt_at": { - "name": "charge_attempt_at", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.", - "undocumented": false, - "html": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "charge_attempt_at" - }, - "customer_approval_required": { - "name": "customer_approval_required", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.", - "undocumented": false, - "html": "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "customer_approval_required" - } - }, - "object_type": "card_await_notification" - }, - "display_bank_transfer_instructions": { - "name": "display_bank_transfer_instructions", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains the bank transfer details necessary for the customer to complete the payment.", - "undocumented": false, - "html": "Contains the bank transfer details necessary for the customer to complete the payment." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount_remaining": { - "name": "amount_remaining", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The remaining amount that needs to be transferred to complete the payment.", - "undocumented": false, - "html": "The remaining amount that needs to be transferred to complete the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_remaining" - }, - "currency": { - "name": "currency", - "check": "currency", - "validation": "currency", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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).", - "undocumented": false, - "html": "Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "currency" - }, - "financial_addresses": { - "name": "financial_addresses", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A list of financial addresses that can be used to fund the customer balance", - "undocumented": false, - "html": "A list of financial addresses that can be used to fund the customer balance" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "iban": { - "name": "iban", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An IBAN-based FinancialAddress", - "undocumented": false, - "html": "An IBAN-based FinancialAddress" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_holder_name": { - "name": "account_holder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The name of the person or business that owns the bank account", - "undocumented": false, - "html": "The name of the person or business that owns the bank account" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "account_holder_name" - }, - "bic": { - "name": "bic", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The BIC/SWIFT code of the account.", - "undocumented": false, - "html": "The BIC/SWIFT code of the account." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bic" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "iban": { - "name": "iban", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The IBAN of the account.", - "undocumented": false, - "html": "The IBAN of the account." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "iban" - } - }, - "object_type": "iban" - }, - "sort_code": { - "name": "sort_code", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An account number and sort code-based FinancialAddress", - "undocumented": false, - "html": "An account number and sort code-based FinancialAddress" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_holder_name": { - "name": "account_holder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The name of the person or business that owns the bank account", - "undocumented": false, - "html": "The name of the person or business that owns the bank account" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "account_holder_name" - }, - "account_number": { - "name": "account_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account number", - "undocumented": false, - "html": "The account number" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "account_number" - }, - "sort_code": { - "name": "sort_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The six-digit sort code", - "undocumented": false, - "html": "The six-digit sort code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "sort_code" - } - }, - "object_type": "sort_code" - }, - "spei": { - "name": "spei", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A SPEI-based FinancialAddress", - "undocumented": false, - "html": "A SPEI-based FinancialAddress" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_code": { - "name": "bank_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The three-digit bank code", - "undocumented": false, - "html": "The three-digit bank code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_code" - }, - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The short banking institution name", - "undocumented": false, - "html": "The short banking institution name" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "clabe": { - "name": "clabe", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The CLABE number", - "undocumented": false, - "html": "The CLABE number" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "clabe" - } - }, - "object_type": "spei" - }, - "supported_networks": { - "name": "supported_networks", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The payment networks supported by this FinancialAddress", - "undocumented": false, - "html": "The payment networks supported by this FinancialAddress" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "bacs": { "documentation": null }, - "fps": { "documentation": null }, - "sepa": { "documentation": null }, - "spei": { "documentation": null }, - "zengin": { "documentation": null } - }, - "object_type": "supported_networks" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of financial address", - "undocumented": false, - "html": "The type of financial address" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "iban": { "documentation": null }, - "sort_code": { "documentation": null }, - "spei": { "documentation": null }, - "zengin": { "documentation": null } - }, - "object_type": "type" - }, - "zengin": { - "name": "zengin", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A Zengin-based FinancialAddress", - "undocumented": false, - "html": "A Zengin-based FinancialAddress" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_holder_name": { - "name": "account_holder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account holder name", - "undocumented": false, - "html": "The account holder name" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "account_holder_name" - }, - "account_number": { - "name": "account_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account number", - "undocumented": false, - "html": "The account number" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "account_number" - }, - "account_type": { - "name": "account_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The bank account type. In Japan, this can only be `futsu` or `toza`.", - "undocumented": false, - "html": "The bank account type. In Japan, this can only be \u003Ccode\u003Efutsu\u003C/code\u003E or \u003Ccode\u003Etoza\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "account_type" - }, - "bank_code": { - "name": "bank_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The bank code of the account", - "undocumented": false, - "html": "The bank code of the account" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_code" - }, - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The bank name of the account", - "undocumented": false, - "html": "The bank name of the account" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "branch_code": { - "name": "branch_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The branch code of the account", - "undocumented": false, - "html": "The branch code of the account" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "branch_code" - }, - "branch_name": { - "name": "branch_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The branch name of the account", - "undocumented": false, - "html": "The branch name of the account" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "branch_name" - } - }, - "object_type": "zengin" - } - }, - "object_type": "financial_addresses" - }, - "hosted_instructions_url": { - "name": "hosted_instructions_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A link to a hosted page that guides your customer through completing the transfer.", - "undocumented": false, - "html": "A link to a hosted page that guides your customer through completing the transfer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_instructions_url" - }, - "reference": { - "name": "reference", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.", - "undocumented": false, - "html": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "reference" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Type of bank transfer", - "undocumented": false, - "html": "Type of bank transfer" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "eu_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type eu_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type eu_bank_transfer" - } - }, - "gb_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type gb_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type gb_bank_transfer" - } - }, - "jp_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type jp_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type jp_bank_transfer" - } - }, - "mx_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type mx_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type mx_bank_transfer" - } - } - }, - "object_type": "type" - } - }, - "object_type": "display_bank_transfer_instructions" - }, - "konbini_display_details": { - "name": "konbini_display_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains Konbini details necessary for the customer to complete the payment.", - "undocumented": false, - "html": "Contains Konbini details necessary for the customer to complete the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "expires_at": { - "name": "expires_at", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The timestamp at which the pending Konbini payment expires.", - "undocumented": false, - "html": "The timestamp at which the pending Konbini payment expires." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_at" - }, - "hosted_voucher_url": { - "name": "hosted_voucher_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.", - "undocumented": false, - "html": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_voucher_url" - }, - "stores": { - "name": "stores", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payment instruction details grouped by convenience store chain.", - "undocumented": false, - "html": "Payment instruction details grouped by convenience store chain." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "familymart": { - "name": "familymart", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "FamilyMart instruction details.", - "undocumented": false, - "html": "FamilyMart instruction details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "confirmation_number": { - "name": "confirmation_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The confirmation number.", - "undocumented": false, - "html": "The confirmation number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "confirmation_number" - }, - "payment_code": { - "name": "payment_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The payment code.", - "undocumented": false, - "html": "The payment code." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_code" - } - }, - "object_type": "familymart" - }, - "lawson": { - "name": "lawson", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Lawson instruction details.", - "undocumented": false, - "html": "Lawson instruction details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "confirmation_number": { - "name": "confirmation_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The confirmation number.", - "undocumented": false, - "html": "The confirmation number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "confirmation_number" - }, - "payment_code": { - "name": "payment_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The payment code.", - "undocumented": false, - "html": "The payment code." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_code" - } - }, - "object_type": "lawson" - }, - "ministop": { - "name": "ministop", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Ministop instruction details.", - "undocumented": false, - "html": "Ministop instruction details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "confirmation_number": { - "name": "confirmation_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The confirmation number.", - "undocumented": false, - "html": "The confirmation number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "confirmation_number" - }, - "payment_code": { - "name": "payment_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The payment code.", - "undocumented": false, - "html": "The payment code." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_code" - } - }, - "object_type": "ministop" - }, - "seicomart": { - "name": "seicomart", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Seicomart instruction details.", - "undocumented": false, - "html": "Seicomart instruction details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "confirmation_number": { - "name": "confirmation_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The confirmation number.", - "undocumented": false, - "html": "The confirmation number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "confirmation_number" - }, - "payment_code": { - "name": "payment_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The payment code.", - "undocumented": false, - "html": "The payment code." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_code" - } - }, - "object_type": "seicomart" - } - }, - "object_type": "stores" - } - }, - "object_type": "konbini_display_details" - }, - "oxxo_display_details": { - "name": "oxxo_display_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains OXXO details necessary for the customer to complete the payment.", - "undocumented": false, - "html": "Contains OXXO details necessary for the customer to complete the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "expires_after": { - "name": "expires_after", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The timestamp after which the OXXO voucher expires.", - "undocumented": false, - "html": "The timestamp after which the OXXO voucher expires." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_after" - }, - "hosted_voucher_url": { - "name": "hosted_voucher_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.", - "undocumented": false, - "html": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_voucher_url" - }, - "number": { - "name": "number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "OXXO reference number.", - "undocumented": false, - "html": "OXXO reference number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "number" - } - }, - "object_type": "oxxo_display_details" - }, - "paynow_display_qr_code": { - "name": "paynow_display_qr_code", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The field that contains PayNow QR code info", - "undocumented": false, - "html": "The field that contains PayNow QR code info" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "data": { - "name": "data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The raw data string used to generate QR code, it should be used together with QR code library.", - "undocumented": false, - "html": "The raw data string used to generate QR code, it should be used together with QR code library." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "data" - }, - "hosted_instructions_url": { - "name": "hosted_instructions_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.", - "undocumented": false, - "html": "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_instructions_url" - }, - "image_url_png": { - "name": "image_url_png", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The image_url_png string used to render QR code", - "undocumented": false, - "html": "The image_url_png string used to render QR code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_png" - }, - "image_url_svg": { - "name": "image_url_svg", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The image_url_svg string used to render QR code", - "undocumented": false, - "html": "The image_url_svg string used to render QR code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_svg" - } - }, - "object_type": "paynow_display_qr_code" - }, - "pix_display_qr_code": { - "name": "pix_display_qr_code", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The field that contains Pix QR code info", - "undocumented": false, - "html": "The field that contains Pix QR code info" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "data": { - "name": "data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The raw data string used to generate QR code, it should be used together with QR code library.", - "undocumented": false, - "html": "The raw data string used to generate QR code, it should be used together with QR code library." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "data" - }, - "expires_at": { - "name": "expires_at", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The date (unix timestamp) when the PIX expires.", - "undocumented": false, - "html": "The date (unix timestamp) when the PIX expires." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_at" - }, - "hosted_instructions_url": { - "name": "hosted_instructions_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code.", - "undocumented": false, - "html": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_instructions_url" - }, - "image_url_png": { - "name": "image_url_png", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The image_url_png string used to render png QR code", - "undocumented": false, - "html": "The image_url_png string used to render png QR code" - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_png" - }, - "image_url_svg": { - "name": "image_url_svg", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The image_url_svg string used to render svg QR code", - "undocumented": false, - "html": "The image_url_svg string used to render svg QR code" - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_svg" - } - }, - "object_type": "pix_display_qr_code" - }, - "promptpay_display_qr_code": { - "name": "promptpay_display_qr_code", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The field that contains PromptPay QR code info", - "undocumented": false, - "html": "The field that contains PromptPay QR code info" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "data": { - "name": "data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The raw data string used to generate QR code, it should be used together with QR code library.", - "undocumented": false, - "html": "The raw data string used to generate QR code, it should be used together with QR code library." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "data" - }, - "hosted_instructions_url": { - "name": "hosted_instructions_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.", - "undocumented": false, - "html": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_instructions_url" - }, - "image_url_png": { - "name": "image_url_png", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The PNG path used to render the QR code, can be used as the source in an HTML img tag", - "undocumented": false, - "html": "The PNG path used to render the QR code, can be used as the source in an HTML img tag" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_png" - }, - "image_url_svg": { - "name": "image_url_svg", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The SVG path used to render the QR code, can be used as the source in an HTML img tag", - "undocumented": false, - "html": "The SVG path used to render the QR code, can be used as the source in an HTML img tag" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_svg" - } - }, - "object_type": "promptpay_display_qr_code" - }, - "redirect_to_url": { - "name": "redirect_to_url", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains instructions for authenticating a payment by redirecting your customer to another page or application.", - "undocumented": false, - "html": "Contains instructions for authenticating a payment by redirecting your customer to another page or application." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "return_url": { - "name": "return_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", - "undocumented": false, - "html": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "return_url" - }, - "url": { - "name": "url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL you must redirect your customer to in order to authenticate the payment.", - "undocumented": false, - "html": "The URL you must redirect your customer to in order to authenticate the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "url" - } - }, - "object_type": "redirect_to_url" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.", - "undocumented": false, - "html": "Type of the next action to perform, one of \u003Ccode\u003Eredirect_to_url\u003C/code\u003E, \u003Ccode\u003Euse_stripe_sdk\u003C/code\u003E, \u003Ccode\u003Ealipay_handle_redirect\u003C/code\u003E, \u003Ccode\u003Eoxxo_display_details\u003C/code\u003E, or \u003Ccode\u003Everify_with_microdeposits\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - }, - "use_stripe_sdk": { - "name": "use_stripe_sdk", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.", - "undocumented": false, - "html": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "use_stripe_sdk" - }, - "verify_with_microdeposits": { - "name": "verify_with_microdeposits", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains details describing microdeposits verification flow.", - "undocumented": false, - "html": "Contains details describing microdeposits verification flow." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "arrival_date": { - "name": "arrival_date", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The timestamp when the microdeposits are expected to land.", - "undocumented": false, - "html": "The timestamp when the microdeposits are expected to land." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "arrival_date" - }, - "hosted_verification_url": { - "name": "hosted_verification_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL for the hosted verification page, which allows customers to verify their bank account.", - "undocumented": false, - "html": "The URL for the hosted verification page, which allows customers to verify their bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_verification_url" - }, - "microdeposit_type": { - "name": "microdeposit_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.", - "undocumented": false, - "html": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "descriptor_code": { "documentation": null }, - "amounts": { "documentation": null } - }, - "object_type": "microdeposit_type" - } - }, - "object_type": "verify_with_microdeposits" - }, - "wechat_pay_display_qr_code": { - "name": "wechat_pay_display_qr_code", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The field that contains WeChat Pay QR code info", - "undocumented": false, - "html": "The field that contains WeChat Pay QR code info" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "data": { - "name": "data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The data being used to generate QR code", - "undocumented": false, - "html": "The data being used to generate QR code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "data" - }, - "hosted_instructions_url": { - "name": "hosted_instructions_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.", - "undocumented": false, - "html": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_instructions_url" - }, - "image_data_url": { - "name": "image_data_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The base64 image data for a pre-generated QR code", - "undocumented": false, - "html": "The base64 image data for a pre-generated QR code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_data_url" - }, - "image_url_png": { - "name": "image_url_png", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The image_url_png string used to render QR code", - "undocumented": false, - "html": "The image_url_png string used to render QR code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_png" - }, - "image_url_svg": { - "name": "image_url_svg", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The image_url_svg string used to render QR code", - "undocumented": false, - "html": "The image_url_svg string used to render QR code" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "image_url_svg" - } - }, - "object_type": "wechat_pay_display_qr_code" - }, - "wechat_pay_redirect_to_android_app": { - "name": "wechat_pay_redirect_to_android_app", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Info required for android app to app redirect", - "undocumented": false, - "html": "Info required for android app to app redirect" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "app_id": { - "name": "app_id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "app_id is the APP ID registered on WeChat open platform", - "undocumented": false, - "html": "app_id is the APP ID registered on WeChat open platform" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "app_id" - }, - "nonce_str": { - "name": "nonce_str", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "nonce_str is a random string", - "undocumented": false, - "html": "nonce_str is a random string" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "nonce_str" - }, - "package": { - "name": "package", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "package is static value", - "undocumented": false, - "html": "package is static value" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "package" - }, - "partner_id": { - "name": "partner_id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "an unique merchant ID assigned by WeChat Pay", - "undocumented": false, - "html": "an unique merchant ID assigned by WeChat Pay" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "partner_id" - }, - "prepay_id": { - "name": "prepay_id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "an unique trading ID assigned by WeChat Pay", - "undocumented": false, - "html": "an unique trading ID assigned by WeChat Pay" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "prepay_id" - }, - "sign": { - "name": "sign", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A signature", - "undocumented": false, - "html": "A signature" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "sign" - }, - "timestamp": { - "name": "timestamp", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Specifies the current time in epoch format", - "undocumented": false, - "html": "Specifies the current time in epoch format" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "timestamp" - } - }, - "object_type": "wechat_pay_redirect_to_android_app" - }, - "wechat_pay_redirect_to_ios_app": { - "name": "wechat_pay_redirect_to_ios_app", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Info required for iOS app to app redirect", - "undocumented": false, - "html": "Info required for iOS app to app redirect" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "native_url": { - "name": "native_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An universal link that redirect to WeChat Pay app", - "undocumented": false, - "html": "An universal link that redirect to WeChat Pay app" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "native_url" - } - }, - "object_type": "wechat_pay_redirect_to_ios_app" - } - }, - "object_type": "next_action" - }, - "on_behalf_of": { - "name": "on_behalf_of", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](/docs/payments/connected-accounts) for details.", - "undocumented": false, - "html": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E for details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["account"], - "object_type": "on_behalf_of", - "less_common": true - }, - "payment_method": { - "name": "payment_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the payment method used in this PaymentIntent.", - "undocumented": false, - "html": "ID of the payment method used in this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["payment_method"], - "object_type": "payment_method" - }, - "payment_method_options": { - "name": "payment_method_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payment-method-specific configuration for this PaymentIntent.", - "undocumented": false, - "html": "Payment-method-specific configuration for this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "acss_debit": { - "name": "acss_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `acss_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eacss_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "mandate_options": { - "name": "mandate_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Additional fields for Mandate creation", - "undocumented": false, - "html": "Additional fields for Mandate creation" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "custom_mandate_url": { - "name": "custom_mandate_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A URL for custom mandate text", - "undocumented": false, - "html": "A URL for custom mandate text" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "custom_mandate_url" - }, - "interval_description": { - "name": "interval_description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", - "undocumented": false, - "html": "Description of the interval. Only required if the ‘payment_schedule’ parameter is ‘interval’ or ‘combined’." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval_description" - }, - "payment_schedule": { - "name": "payment_schedule", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payment schedule for the mandate.", - "undocumented": false, - "html": "Payment schedule for the mandate." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "interval": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments are initiated at a regular pre-defined interval", - "undocumented": false, - "html": "Payments are initiated at a regular pre-defined interval" - } - }, - "sporadic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments are initiated sporadically", - "undocumented": false, - "html": "Payments are initiated sporadically" - } - }, - "combined": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments can be initiated at a pre-defined interval or sporadically", - "undocumented": false, - "html": "Payments can be initiated at a pre-defined interval or sporadically" - } - } - }, - "object_type": "payment_schedule" - }, - "transaction_type": { - "name": "transaction_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transaction type of the mandate.", - "undocumented": false, - "html": "Transaction type of the mandate." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "personal": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transactions are made for personal reasons", - "undocumented": false, - "html": "Transactions are made for personal reasons" - } - }, - "business": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transactions are made for business reasons", - "undocumented": false, - "html": "Transactions are made for business reasons" - } - } - }, - "object_type": "transaction_type" - } - }, - "object_type": "mandate_options" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - }, - "verification_method": { - "name": "verification_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account verification method.", - "undocumented": false, - "html": "Bank account verification method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification with fallback to microdeposits.", - "undocumented": false, - "html": "Instant verification with fallback to microdeposits." - } - }, - "instant": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification.", - "undocumented": false, - "html": "Instant verification." - } - }, - "microdeposits": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Verification using microdeposits.", - "undocumented": false, - "html": "Verification using microdeposits." - } - } - }, - "object_type": "verification_method" - } - }, - "object_type": "acss_debit" - }, - "affirm": { - "name": "affirm", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `affirm`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eaffirm\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "capture_method" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "affirm" - }, - "afterpay_clearpay": { - "name": "afterpay_clearpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `afterpay_clearpay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eafterpay_clearpay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "capture_method" - }, - "reference": { - "name": "reference", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Order identifier shown to the customer 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.\n", - "undocumented": false, - "html": "Order identifier shown to the customer 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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "reference" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "afterpay_clearpay" - }, - "alipay": { - "name": "alipay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `alipay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ealipay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "alipay" - }, - "au_becs_debit": { - "name": "au_becs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `au_becs_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eau_becs_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "au_becs_debit" - }, - "bacs_debit": { - "name": "bacs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `bacs_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ebacs_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "bacs_debit" - }, - "bancontact": { - "name": "bancontact", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `bancontact`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ebancontact\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "preferred_language": { - "name": "preferred_language", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Preferred language of the Bancontact authorization page that the customer is redirected to.", - "undocumented": false, - "html": "Preferred language of the Bancontact authorization page that the customer is redirected to." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred_language" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "bancontact" - }, - "blik": { - "name": "blik", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `blik`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eblik\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "blik" - }, - "boleto": { - "name": "boleto", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `boleto`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eboleto\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "expires_after_days": { - "name": "expires_after_days", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_after_days" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "boleto" - }, - "card": { - "name": "card", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `card`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecard\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "capture_method" - }, - "installments": { - "name": "installments", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](/docs/payments/installments).\n", - "undocumented": false, - "html": "Installment details for this payment (Mexico only).\u003C/p\u003E\n\n\u003Cp\u003EFor more information, see the \u003Ca href=\"/docs/payments/installments\"\u003Einstallments integration guide\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available_plans": { - "name": "available_plans", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Installment plans that may be selected for this PaymentIntent.", - "undocumented": false, - "html": "Installment plans that may be selected for this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "count": { - "name": "count", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", - "undocumented": false, - "html": "For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the number of installment payments your customer will make to their credit card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "count" - }, - "interval": { - "name": "interval", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.\n", - "undocumented": false, - "html": "For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of \u003Ccode\u003Emonth\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Type of installment plan, one of `fixed_count`.", - "undocumented": false, - "html": "Type of installment plan, one of \u003Ccode\u003Efixed_count\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "available_plans" - }, - "enabled": { - "name": "enabled", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether Installments are enabled for this PaymentIntent.", - "undocumented": false, - "html": "Whether Installments are enabled for this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "enabled" - }, - "plan": { - "name": "plan", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Installment plan selected for this PaymentIntent.", - "undocumented": false, - "html": "Installment plan selected for this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "count": { - "name": "count", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", - "undocumented": false, - "html": "For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the number of installment payments your customer will make to their credit card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "count" - }, - "interval": { - "name": "interval", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.\n", - "undocumented": false, - "html": "For \u003Ccode\u003Efixed_count\u003C/code\u003E installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of \u003Ccode\u003Emonth\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Type of installment plan, one of `fixed_count`.", - "undocumented": false, - "html": "Type of installment plan, one of \u003Ccode\u003Efixed_count\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "plan" - } - }, - "object_type": "installments" - }, - "mandate_options": { - "name": "mandate_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration options for setting up an eMandate for cards issued in India.", - "undocumented": false, - "html": "Configuration options for setting up an eMandate for cards issued in India." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount": { - "name": "amount", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount to be charged for future payments.", - "undocumented": false, - "html": "Amount to be charged for future payments." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "amount_type": { - "name": "amount_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.\n", - "undocumented": false, - "html": "One of \u003Ccode\u003Efixed\u003C/code\u003E or \u003Ccode\u003Emaximum\u003C/code\u003E. If \u003Ccode\u003Efixed\u003C/code\u003E, the \u003Ccode\u003Eamount\u003C/code\u003E param refers to the exact amount to be charged in future payments. If \u003Ccode\u003Emaximum\u003C/code\u003E, the amount charged can be up to the value passed for the \u003Ccode\u003Eamount\u003C/code\u003E param." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_type" - }, - "description": { - "name": "description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A description of the mandate or subscription that is meant to be displayed to the customer.", - "undocumented": false, - "html": "A description of the mandate or subscription that is meant to be displayed to the customer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "description" - }, - "end_date": { - "name": "end_date", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.\n", - "undocumented": false, - "html": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "end_date" - }, - "interval": { - "name": "interval", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.\n", - "undocumented": false, - "html": "Specifies payment frequency. One of \u003Ccode\u003Eday\u003C/code\u003E, \u003Ccode\u003Eweek\u003C/code\u003E, \u003Ccode\u003Emonth\u003C/code\u003E, \u003Ccode\u003Eyear\u003C/code\u003E, or \u003Ccode\u003Esporadic\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval" - }, - "interval_count": { - "name": "interval_count", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.\n", - "undocumented": false, - "html": "The number of intervals between payments. For example, \u003Ccode\u003Einterval=month\u003C/code\u003E and \u003Ccode\u003Einterval_count=3\u003C/code\u003E indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when \u003Ccode\u003Einterval=sporadic\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval_count" - }, - "reference": { - "name": "reference", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the mandate or subscription.", - "undocumented": false, - "html": "Unique identifier for the mandate or subscription." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "reference" - }, - "start_date": { - "name": "start_date", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.\n", - "undocumented": false, - "html": "Start date of the mandate or subscription. Start date should not be lesser than yesterday." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "start_date" - }, - "supported_types": { - "name": "supported_types", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Specifies the type of mandates supported. Possible values are `india`.\n", - "undocumented": false, - "html": "Specifies the type of mandates supported. Possible values are \u003Ccode\u003Eindia\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported_types" - } - }, - "object_type": "mandate_options" - }, - "network": { - "name": "network", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "network" - }, - "request_three_d_secure": { - "name": "request_three_d_secure", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](/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](/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", - "undocumented": false, - "html": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and \u003Ca href=\"/docs/strong-customer-authentication\"\u003Eother requirements\u003C/a\u003E. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: \u003Ccode\u003Eautomatic\u003C/code\u003E or \u003Ccode\u003Eany\u003C/code\u003E. If not provided, defaults to \u003Ccode\u003Eautomatic\u003C/code\u003E. Read our guide on \u003Ca href=\"/docs/payments/3d-secure#manual-three-ds\"\u003Emanually requesting 3D Secure\u003C/a\u003E for more information on how this configuration interacts with Radar and our SCA Engine." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "advanced", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "request_three_d_secure" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - }, - "statement_descriptor_suffix_kana": { - "name": "statement_descriptor_suffix_kana", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.", - "undocumented": false, - "html": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the \u003Cem\u003Econcatenation\u003C/em\u003E of both prefix and suffix (including separators) will appear truncated to 22 characters." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "statement_descriptor_suffix_kana" - }, - "statement_descriptor_suffix_kanji": { - "name": "statement_descriptor_suffix_kanji", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.", - "undocumented": false, - "html": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the \u003Cem\u003Econcatenation\u003C/em\u003E of both prefix and suffix (including separators) will appear truncated to 17 characters." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "statement_descriptor_suffix_kanji" - } - }, - "object_type": "card" - }, - "card_present": { - "name": "card_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `card_present`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecard_present\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "manual_preferred": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `manual_preferred` if you prefer `manual` capture_method but support falling back to `automatic` based on the presented payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Emanual_preferred\u003C/code\u003E if you prefer \u003Ccode\u003Emanual\u003C/code\u003E capture_method but support falling back to \u003Ccode\u003Eautomatic\u003C/code\u003E based on the presented payment method." - } - } - }, - "object_type": "capture_method" - }, - "request_extended_authorization": { - "name": "request_extended_authorization", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Request ability to capture this payment beyond the standard [authorization validity window](/docs/terminal/features/extended-authorizations#authorization-validity)", - "undocumented": false, - "html": "Request ability to capture this payment beyond the standard \u003Ca href=\"/docs/terminal/features/extended-authorizations#authorization-validity\"\u003Eauthorization validity window\u003C/a\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "request_extended_authorization" - }, - "request_incremental_authorization_support": { - "name": "request_incremental_authorization_support", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Request ability to [increment](/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](/docs/api/payment_intents/confirm) response to verify support.", - "undocumented": false, - "html": "Request ability to \u003Ca href=\"/docs/terminal/features/incremental-authorizations\"\u003Eincrement\u003C/a\u003E this PaymentIntent if the combination of MCC and card brand is eligible. Check \u003Ca href=\"/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported\"\u003Eincremental_authorization_supported\u003C/a\u003E in the \u003Ca href=\"/docs/api/payment_intents/confirm\"\u003EConfirm\u003C/a\u003E response to verify support." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "request_incremental_authorization_support" - } - }, - "object_type": "card_present" - }, - "customer_balance": { - "name": "customer_balance", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `customer_balance`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecustomer_balance\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_transfer": { - "name": "bank_transfer", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.\n", - "undocumented": false, - "html": "Configuration for the bank transfer funding type, if the \u003Ccode\u003Efunding_type\u003C/code\u003E is set to \u003Ccode\u003Ebank_transfer\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "eu_bank_transfer": { - "name": "eu_bank_transfer", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for eu_bank_transfer", - "undocumented": false, - "html": "Configuration for eu_bank_transfer" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.\n", - "undocumented": false, - "html": "The desired country code of the bank account information. Permitted values include: \u003Ccode\u003EBE\u003C/code\u003E, \u003Ccode\u003EDE\u003C/code\u003E, \u003Ccode\u003EES\u003C/code\u003E, \u003Ccode\u003EFR\u003C/code\u003E, \u003Ccode\u003EIE\u003C/code\u003E, or \u003Ccode\u003ENL\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - } - }, - "object_type": "eu_bank_transfer" - }, - "requested_address_types": { - "name": "requested_address_types", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.\n", - "undocumented": false, - "html": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\u003C/p\u003E\n\n\u003Cp\u003EPermitted values include: \u003Ccode\u003Esort_code\u003C/code\u003E, \u003Ccode\u003Ezengin\u003C/code\u003E, \u003Ccode\u003Eiban\u003C/code\u003E, or \u003Ccode\u003Espei\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "sort_code": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "sort_code bank account address type", - "undocumented": false, - "html": "sort_code bank account address type" - } - }, - "zengin": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "zengin bank account address type", - "undocumented": false, - "html": "zengin bank account address type" - } - }, - "sepa": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "sepa bank account address type", - "undocumented": false, - "html": "sepa bank account address type" - } - }, - "spei": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "spei bank account address type", - "undocumented": false, - "html": "spei bank account address type" - } - }, - "iban": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "iban bank account address type", - "undocumented": false, - "html": "iban bank account address type" - } - } - }, - "object_type": "requested_address_types" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.\n", - "undocumented": false, - "html": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: \u003Ccode\u003Eeu_bank_transfer\u003C/code\u003E, \u003Ccode\u003Egb_bank_transfer\u003C/code\u003E, \u003Ccode\u003Ejp_bank_transfer\u003C/code\u003E, or \u003Ccode\u003Emx_bank_transfer\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "eu_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type eu_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type eu_bank_transfer" - } - }, - "gb_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type gb_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type gb_bank_transfer" - } - }, - "jp_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type jp_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type jp_bank_transfer" - } - }, - "mx_bank_transfer": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A bank transfer of type mx_bank_transfer", - "undocumented": false, - "html": "A bank transfer of type mx_bank_transfer" - } - } - }, - "object_type": "type" - } - }, - "object_type": "bank_transfer" - }, - "funding_type": { - "name": "funding_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.\n", - "undocumented": false, - "html": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: \u003Ccode\u003Ebank_transfer\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding_type" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "customer_balance" - }, - "eps": { - "name": "eps", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `eps`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eeps\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "eps" - }, - "fpx": { - "name": "fpx", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `fpx`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Efpx\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "fpx" - }, - "giropay": { - "name": "giropay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `giropay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Egiropay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "giropay" - }, - "grabpay": { - "name": "grabpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `grabpay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Egrabpay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "grabpay" - }, - "ideal": { - "name": "ideal", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `ideal`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eideal\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "ideal" - }, - "interac_present": { - "name": "interac_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `interac_present`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Einterac_present\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "interac_present" - }, - "klarna": { - "name": "klarna", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `klarna`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eklarna\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "capture_method" - }, - "preferred_locale": { - "name": "preferred_locale", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Preferred locale of the Klarna checkout page that the customer is redirected to.", - "undocumented": false, - "html": "Preferred locale of the Klarna checkout page that the customer is redirected to." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred_locale" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "klarna" - }, - "konbini": { - "name": "konbini", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `konbini`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ekonbini\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "confirmation_number": { - "name": "confirmation_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.", - "undocumented": false, - "html": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "confirmation_number" - }, - "expires_after_days": { - "name": "expires_after_days", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.", - "undocumented": false, - "html": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and \u003Ccode\u003Eexpires_after_days\u003C/code\u003E set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_after_days" - }, - "expires_at": { - "name": "expires_at", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.", - "undocumented": false, - "html": "The timestamp at which the Konbini payment instructions will expire. Only one of \u003Ccode\u003Eexpires_after_days\u003C/code\u003E or \u003Ccode\u003Eexpires_at\u003C/code\u003E may be set." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_at" - }, - "product_description": { - "name": "product_description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.", - "undocumented": false, - "html": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "product_description" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "konbini" - }, - "link": { - "name": "link", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `link`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Elink\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `manual` if you intend to place the funds on hold and want to override the top-level `capture_method` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Emanual\u003C/code\u003E if you intend to place the funds on hold and want to override the top-level \u003Ccode\u003Ecapture_method\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "capture_method" - }, - "persistent_token": { - "name": "persistent_token", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Token used for persistent Link logins.", - "undocumented": false, - "html": "Token used for persistent Link logins." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "persistent_token" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "link" - }, - "oxxo": { - "name": "oxxo", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `oxxo`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eoxxo\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "expires_after_days": { - "name": "expires_after_days", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_after_days" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "oxxo" - }, - "p24": { - "name": "p24", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `p24`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ep24\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "p24" - }, - "paynow": { - "name": "paynow", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `paynow`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Epaynow\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "paynow" - }, - "pix": { - "name": "pix", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `pix`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Epix\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "expires_after_seconds": { - "name": "expires_after_seconds", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The number of seconds (between 10 and 1209600) after which Pix payment will expire.", - "undocumented": false, - "html": "The number of seconds (between 10 and 1209600) after which Pix payment will expire." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_after_seconds" - }, - "expires_at": { - "name": "expires_at", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The timestamp at which the Pix expires.", - "undocumented": false, - "html": "The timestamp at which the Pix expires." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_at" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "pix" - }, - "promptpay": { - "name": "promptpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `promptpay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Epromptpay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "promptpay" - }, - "sepa_debit": { - "name": "sepa_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `sepa_debit`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Esepa_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "mandate_options": { - "name": "mandate_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Additional fields for Mandate creation", - "undocumented": false, - "html": "Additional fields for Mandate creation" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "mandate_options" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "sepa_debit" - }, - "sofort": { - "name": "sofort", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `sofort`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Esofort\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "preferred_language": { - "name": "preferred_language", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Preferred language of the SOFORT authorization page that the customer is redirected to.", - "undocumented": false, - "html": "Preferred language of the SOFORT authorization page that the customer is redirected to." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred_language" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "sofort" - }, - "us_bank_account": { - "name": "us_bank_account", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `us_bank_account`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Eus_bank_account\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "financial_connections": { - "name": "financial_connections", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Additional fields for Financial Connections Session creation", - "undocumented": false, - "html": "Additional fields for Financial Connections Session creation" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "permissions": { - "name": "permissions", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The list of permissions to request. The `payment_method` permission must be included.", - "undocumented": false, - "html": "The list of permissions to request. The \u003Ccode\u003Epayment_method\u003C/code\u003E permission must be included." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "payment_method": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows the creation of a payment method from the account.", - "undocumented": false, - "html": "Allows the creation of a payment method from the account." - } - }, - "balances": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows accessing balance data from the account.", - "undocumented": false, - "html": "Allows accessing balance data from the account." - } - }, - "transactions": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows accessing transactions data from the account.", - "undocumented": false, - "html": "Allows accessing transactions data from the account." - } - }, - "ownership": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows accessing ownership data from the account.", - "undocumented": false, - "html": "Allows accessing ownership data from the account." - } - } - }, - "object_type": "permissions" - } - }, - "object_type": "financial_connections" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - }, - "verification_method": { - "name": "verification_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account verification method.", - "undocumented": false, - "html": "Bank account verification method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification with fallback to microdeposits.", - "undocumented": false, - "html": "Instant verification with fallback to microdeposits." - } - }, - "instant": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification only.", - "undocumented": false, - "html": "Instant verification only." - } - }, - "microdeposits": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices.", - "undocumented": false, - "html": "Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices." - } - } - }, - "object_type": "verification_method" - } - }, - "object_type": "us_bank_account" - }, - "wechat_pay": { - "name": "wechat_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `wechat_pay`, this hash contains the configurations that will be applied to each payment attempt of that type.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ewechat_pay\u003C/code\u003E, this hash contains the configurations that will be applied to each payment attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "app_id": { - "name": "app_id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The app ID registered with WeChat Pay. Only required when client is ios or android.", - "undocumented": false, - "html": "The app ID registered with WeChat Pay. Only required when client is ios or android." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "app_id" - }, - "client": { - "name": "client", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The client type that the end customer will pay from", - "undocumented": false, - "html": "The client type that the end customer will pay from" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "web": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The end customer will pay from web browser", - "undocumented": false, - "html": "The end customer will pay from web browser" - } - }, - "ios": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The end customer will pay from an iOS app", - "undocumented": false, - "html": "The end customer will pay from an iOS app" - } - }, - "android": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The end customer will pay from an Android app", - "undocumented": false, - "html": "The end customer will pay from an Android app" - } - } - }, - "object_type": "client" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.", - "undocumented": false, - "html": "Use \u003Ccode\u003Enone\u003C/code\u003E if you do not intend to reuse this payment method and want to override the top-level \u003Ccode\u003Esetup_future_usage\u003C/code\u003E value for this payment method." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "wechat_pay" - } - }, - "object_type": "payment_method_options", - "less_common": true - }, - "payment_method_types": { - "name": "payment_method_types", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.", - "undocumented": false, - "html": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_method_types" - }, - "processing": { - "name": "processing", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If present, this property tells you about the processing state of the payment.", - "undocumented": false, - "html": "If present, this property tells you about the processing state of the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "card": { - "name": "card", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the PaymentIntent's payment_method_types includes `card`, this hash contains the details on the `processing` state of the payment.\n", - "undocumented": false, - "html": "If the PaymentIntent’s payment_method_types includes \u003Ccode\u003Ecard\u003C/code\u003E, this hash contains the details on the \u003Ccode\u003Eprocessing\u003C/code\u003E state of the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "customer_notification": { - "name": "customer_notification", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For recurring payments of Indian cards, this hash contains details on whether customer approval is required, and until when the payment will be in `processing` state", - "undocumented": false, - "html": "For recurring payments of Indian cards, this hash contains details on whether customer approval is required, and until when the payment will be in \u003Ccode\u003Eprocessing\u003C/code\u003E state" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "approval_requested": { - "name": "approval_requested", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.", - "undocumented": false, - "html": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "approval_requested" - }, - "completes_at": { - "name": "completes_at", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If customer approval is required, they need to provide approval before this time.", - "undocumented": false, - "html": "If customer approval is required, they need to provide approval before this time." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "completes_at" - } - }, - "object_type": "customer_notification" - } - }, - "object_type": "card" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Type of the payment method for which payment is in `processing` state, one of `card`.", - "undocumented": false, - "html": "Type of the payment method for which payment is in \u003Ccode\u003Eprocessing\u003C/code\u003E state, one of \u003Ccode\u003Ecard\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "processing", - "less_common": true - }, - "receipt_email": { - "name": "receipt_email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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).", - "undocumented": false, - "html": "Email address that the receipt for the resulting payment will be sent to. If \u003Ccode\u003Ereceipt_email\u003C/code\u003E is specified for a payment in live mode, a receipt will be sent regardless of your \u003Ca href=\"https://dashboard.stripe.com/account/emails\"\u003Eemail settings\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "receipt_email" - }, - "review": { - "name": "review", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the review associated with this PaymentIntent, if any.", - "undocumented": false, - "html": "ID of the review associated with this PaymentIntent, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["review"], - "object_type": "review", - "less_common": true - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](/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](/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](/docs/strong-customer-authentication).\n", - "undocumented": false, - "html": "Indicates that you intend to make future payments with this PaymentIntent’s payment method.\u003C/p\u003E\n\n\u003Cp\u003EProviding this parameter will \u003Ca href=\"/docs/payments/save-during-payment\"\u003Eattach the payment method\u003C/a\u003E 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 \u003Ca href=\"/docs/api/payment_methods/attach\"\u003Eattached\u003C/a\u003E to a Customer after the transaction completes.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Stripe also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as \u003Ca href=\"/docs/strong-customer-authentication\"\u003ESCA\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - } - }, - "object_type": "setup_future_usage" - }, - "shipping": { - "name": "shipping", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Shipping information for this PaymentIntent.", - "undocumented": false, - "html": "Shipping information for this PaymentIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "address": { - "name": "address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Shipping address.", - "undocumented": false, - "html": "Shipping address." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "address" - }, - "carrier": { - "name": "carrier", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", - "undocumented": false, - "html": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "carrier" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Recipient name.", - "undocumented": false, - "html": "Recipient name." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "phone": { - "name": "phone", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Recipient phone (including extension).", - "undocumented": false, - "html": "Recipient phone (including extension)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "phone" - }, - "tracking_number": { - "name": "tracking_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tracking_number" - } - }, - "object_type": "shipping" - }, - "statement_descriptor": { - "name": "statement_descriptor", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "statement_descriptor" - }, - "statement_descriptor_suffix": { - "name": "statement_descriptor_suffix", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "statement_descriptor_suffix" - }, - "status": { - "name": "status", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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](/docs/payments/intents#intent-statuses).", - "undocumented": false, - "html": "Status of this PaymentIntent, one of \u003Ccode\u003Erequires_payment_method\u003C/code\u003E, \u003Ccode\u003Erequires_confirmation\u003C/code\u003E, \u003Ccode\u003Erequires_action\u003C/code\u003E, \u003Ccode\u003Eprocessing\u003C/code\u003E, \u003Ccode\u003Erequires_capture\u003C/code\u003E, \u003Ccode\u003Ecanceled\u003C/code\u003E, or \u003Ccode\u003Esucceeded\u003C/code\u003E. Read more about each PaymentIntent \u003Ca href=\"/docs/payments/intents#intent-statuses\"\u003Estatus\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "status" - }, - "transfer_data": { - "name": "transfer_data", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](/docs/payments/connected-accounts) for details.", - "undocumented": false, - "html": "The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E for details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount": { - "name": "amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](/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](/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).", - "undocumented": false, - "html": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the \u003Ca href=\"/docs/currencies#zero-decimal\"\u003Esmallest currency unit\u003C/a\u003E (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 \u003Ca href=\"/docs/currencies#minimum-and-maximum-charge-amounts\"\u003Eequivalent in charge currency\u003C/a\u003E. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "destination": { - "name": "destination", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.\n", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["account"], - "object_type": "destination" - } - }, - "object_type": "transfer_data", - "less_common": true - }, - "transfer_group": { - "name": "transfer_group", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](/docs/payments/connected-accounts) for details.", - "undocumented": false, - "html": "A string that identifies the resulting payment as part of a group. See the PaymentIntents \u003Ca href=\"/docs/payments/connected-accounts\"\u003Euse case for connected accounts\u003C/a\u003E for details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "transfer_group", - "less_common": true - } - } - }, - "payment_method": { - "name": "payment_method", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The PaymentMethod object for errors returned on a request involving a PaymentMethod.", - "undocumented": false, - "html": "The PaymentMethod object for errors returned on a request involving a PaymentMethod." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "acss_debit": { - "name": "acss_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eacss_debit\u003C/code\u003E PaymentMethod, this hash contains details about the ACSS Debit payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Name of the bank associated with the bank account.", - "undocumented": false, - "html": "Name of the bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "institution_number": { - "name": "institution_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Institution number of the bank account.", - "undocumented": false, - "html": "Institution number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "institution_number" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "transit_number": { - "name": "transit_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transit number of the bank account.", - "undocumented": false, - "html": "Transit number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "transit_number" - } - }, - "object_type": "acss_debit", - "less_common": true - }, - "affirm": { - "name": "affirm", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eaffirm\u003C/code\u003E PaymentMethod, this hash contains details about the Affirm payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "affirm", - "less_common": true - }, - "afterpay_clearpay": { - "name": "afterpay_clearpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003EAfterpayClearpay\u003C/code\u003E PaymentMethod, this hash contains details about the AfterpayClearpay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "afterpay_clearpay", - "less_common": true - }, - "alipay": { - "name": "alipay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003EAlipay\u003C/code\u003E PaymentMethod, this hash contains details about the Alipay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "alipay", - "less_common": true - }, - "au_becs_debit": { - "name": "au_becs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eau_becs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bsb_number": { - "name": "bsb_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Six-digit number identifying bank and branch associated with this bank account.", - "undocumented": false, - "html": "Six-digit number identifying bank and branch associated with this bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bsb_number" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - } - }, - "object_type": "au_becs_debit", - "less_common": true - }, - "bacs_debit": { - "name": "bacs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ebacs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the Bacs Direct Debit bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "sort_code": { - "name": "sort_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Sort code of the bank account. (e.g., `10-20-30`)", - "undocumented": false, - "html": "Sort code of the bank account. (e.g., \u003Ccode\u003E10-20-30\u003C/code\u003E)" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "sort_code" - } - }, - "object_type": "bacs_debit", - "less_common": true - }, - "bancontact": { - "name": "bancontact", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ebancontact\u003C/code\u003E PaymentMethod, this hash contains details about the Bancontact payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "bancontact", - "less_common": true - }, - "billing_details": { - "name": "billing_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", - "undocumented": false, - "html": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "address": { - "name": "address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing address.", - "undocumented": false, - "html": "Billing address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Email address.", - "undocumented": false, - "html": "Email address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Full name.", - "undocumented": false, - "html": "Full name." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "phone": { - "name": "phone", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing phone number (including extension).", - "undocumented": false, - "html": "Billing phone number (including extension)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "phone" - } - }, - "object_type": "billing_details" - }, - "blik": { - "name": "blik", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eblik\u003C/code\u003E PaymentMethod, this hash contains details about the BLIK payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "blik", - "less_common": true - }, - "boleto": { - "name": "boleto", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eboleto\u003C/code\u003E PaymentMethod, this hash contains details about the Boleto payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": null, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "tax_id": { - "name": "tax_id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies the customer tax id (CNPJ or CPF)", - "undocumented": false, - "html": "Uniquely identifies the customer tax id (CNPJ or CPF)" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tax_id" - } - }, - "object_type": "boleto", - "less_common": true - }, - "card": { - "name": "card", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `card` PaymentMethod, this hash contains the user's card details.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecard\u003C/code\u003E PaymentMethod, this hash contains the user’s card details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "checks": { - "name": "checks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checks on Card address and CVC if provided.", - "undocumented": false, - "html": "Checks on Card address and CVC if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "address_line1_check": { - "name": "address_line1_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a address line1 was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "address_line1_check" - }, - "address_postal_code_check": { - "name": "address_postal_code_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a address postal code was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "address_postal_code_check" - }, - "cvc_check": { - "name": "cvc_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a CVC was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cvc_check" - } - }, - "object_type": "checks" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": "card_fingerprint_read", - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "generated_from": { - "name": "generated_from", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": { - "sdk_client_public": { - "gate_specific": {}, - "localize_terms": [], - "undocumented": true, - "html": null - } - }, - "localize_terms": [], - "markdown": "Details of the original PaymentMethod that created this object.", - "undocumented": false, - "html": "Details of the original PaymentMethod that created this object." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The charge that created this object.", - "undocumented": false, - "html": "The charge that created this object." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "charge" - }, - "payment_method_details": { - "name": "payment_method_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transaction-specific details of the payment method used in the payment.", - "undocumented": false, - "html": "Transaction-specific details of the payment method used in the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "card_present": { - "name": "card_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "This hash contains the snapshot of the `card_present` transaction-specific details which generated this `card` payment method.", - "undocumented": false, - "html": "This hash contains the snapshot of the \u003Ccode\u003Ecard_present\u003C/code\u003E transaction-specific details which generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount_authorized": { - "name": "amount_authorized", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The authorized amount", - "undocumented": false, - "html": "The authorized amount" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_authorized" - }, - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "capture_before": { - "name": "capture_before", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.", - "undocumented": false, - "html": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "capture_before" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "emv_auth_data": { - "name": "emv_auth_data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Authorization response cryptogram.", - "undocumented": false, - "html": "Authorization response cryptogram." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "emv_auth_data" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "generated_card": { - "name": "generated_card", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "generated_card" - }, - "incremental_authorization_supported": { - "name": "incremental_authorization_supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether this [PaymentIntent](/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).", - "undocumented": false, - "html": "Whether this \u003Ca href=\"/docs/api/payment_intents\"\u003EPaymentIntent\u003C/a\u003E is eligible for incremental authorizations. Request support using \u003Ca href=\"/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support\"\u003Erequest_incremental_authorization_support\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "incremental_authorization_supported" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "network": { - "name": "network", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Identifies which network this charge was processed on. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ecartes_bancaires\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "network" - }, - "overcapture_supported": { - "name": "overcapture_supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Defines whether the authorized amount can be over-captured or not", - "undocumented": false, - "html": "Defines whether the authorized amount can be over-captured or not" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "overcapture_supported" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - }, - "receipt": { - "name": "receipt", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", - "undocumented": false, - "html": "A collection of fields required to be displayed on receipts. Only required for EMV transactions." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_type": { - "name": "account_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of account being debited or credited", - "undocumented": false, - "html": "The type of account being debited or credited" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "credit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A credit account, as when using a credit card", - "undocumented": false, - "html": "A credit account, as when using a credit card" - } - }, - "checking": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A checking account, as when using a debit card", - "undocumented": false, - "html": "A checking account, as when using a debit card" - } - }, - "prepaid": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A prepaid account, as when using a debit gift card", - "undocumented": false, - "html": "A prepaid account, as when using a debit gift card" - } - }, - "unknown": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An unknown account", - "undocumented": false, - "html": "An unknown account" - } - } - }, - "object_type": "account_type" - }, - "application_cryptogram": { - "name": "application_cryptogram", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 9F26, cryptogram generated by the integrated circuit chip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_cryptogram" - }, - "application_preferred_name": { - "name": "application_preferred_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Mnenomic of the Application Identifier.", - "undocumented": false, - "html": "Mnenomic of the Application Identifier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_preferred_name" - }, - "authorization_code": { - "name": "authorization_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Identifier for this transaction.", - "undocumented": false, - "html": "Identifier for this transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "authorization_code" - }, - "authorization_response_code": { - "name": "authorization_response_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 8A. A code returned by the card issuer.", - "undocumented": false, - "html": "EMV tag 8A. A code returned by the card issuer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "authorization_response_code" - }, - "cardholder_verification_method": { - "name": "cardholder_verification_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How the cardholder verified ownership of the card.", - "undocumented": false, - "html": "How the cardholder verified ownership of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_verification_method" - }, - "dedicated_file_name": { - "name": "dedicated_file_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "dedicated_file_name" - }, - "terminal_verification_results": { - "name": "terminal_verification_results", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The outcome of a series of EMV functions performed by the card reader.", - "undocumented": false, - "html": "The outcome of a series of EMV functions performed by the card reader." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "terminal_verification_results" - }, - "transaction_status_information": { - "name": "transaction_status_information", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An indication of various EMV functions performed during the transaction.", - "undocumented": false, - "html": "An indication of various EMV functions performed during the transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "transaction_status_information" - } - }, - "object_type": "receipt" - } - }, - "object_type": "card_present" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.", - "undocumented": false, - "html": "The type of payment method transaction-specific details from the transaction that generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method. Always \u003Ccode\u003Ecard_present\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "payment_method_details" - }, - "setup_attempt": { - "name": "setup_attempt", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the SetupAttempt that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["setup_attempt"], - "object_type": "setup_attempt" - } - }, - "object_type": "generated_from" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "three_d_secure_usage": { - "name": "three_d_secure_usage", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains details on how this Card may be used for 3D Secure authentication.", - "undocumented": false, - "html": "Contains details on how this Card may be used for 3D Secure authentication." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "supported": { - "name": "supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether 3D Secure is supported on this card.", - "undocumented": false, - "html": "Whether 3D Secure is supported on this card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported" - } - }, - "object_type": "three_d_secure_usage" - }, - "wallet": { - "name": "wallet", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this Card is part of a card wallet, this contains the details of the card wallet.", - "undocumented": false, - "html": "If this Card is part of a card wallet, this contains the details of the card wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amex_express_checkout": { - "name": "amex_express_checkout", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `amex_express_checkout` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "amex_express_checkout" - }, - "apple_pay": { - "name": "apple_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `apple_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eapple_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "apple_pay" - }, - "dynamic_last4": { - "name": "dynamic_last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "(For tokenized numbers only.) The last four digits of the device account number.", - "undocumented": false, - "html": "(For tokenized numbers only.) The last four digits of the device account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "dynamic_last4" - }, - "google_pay": { - "name": "google_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `google_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egoogle_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "google_pay" - }, - "masterpass": { - "name": "masterpass", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `masterpass` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Emasterpass\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "billing_address": { - "name": "billing_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "billing_address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "shipping_address": { - "name": "shipping_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "shipping_address" - } - }, - "object_type": "masterpass" - }, - "samsung_pay": { - "name": "samsung_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `samsung_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esamsung_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "samsung_pay" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "The type of the card wallet, one of \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E, \u003Ccode\u003Eapple_pay\u003C/code\u003E, \u003Ccode\u003Egoogle_pay\u003C/code\u003E, \u003Ccode\u003Emasterpass\u003C/code\u003E, \u003Ccode\u003Esamsung_pay\u003C/code\u003E, or \u003Ccode\u003Evisa_checkout\u003C/code\u003E. 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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - }, - "visa_checkout": { - "name": "visa_checkout", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `visa_checkout` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Evisa_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "billing_address": { - "name": "billing_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "billing_address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "shipping_address": { - "name": "shipping_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "shipping_address" - } - }, - "object_type": "visa_checkout" - } - }, - "object_type": "wallet" - } - }, - "object_type": "card", - "less_common": true - }, - "card_present": { - "name": "card_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `card_present` PaymentMethod, this hash contains details about the Card Present payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecard_present\u003C/code\u003E PaymentMethod, this hash contains details about the Card Present payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - } - }, - "object_type": "card_present", - "less_common": true - }, - "created": { - "name": "created", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Time at which the object was created. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "created", - "less_common": true - }, - "customer": { - "name": "customer", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["customer"], - "object_type": "customer" - }, - "customer_balance": { - "name": "customer_balance", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecustomer_balance\u003C/code\u003E PaymentMethod, this hash contains details about the CustomerBalance payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "customer_balance", - "less_common": true - }, - "eps": { - "name": "eps", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eeps\u003C/code\u003E PaymentMethod, this hash contains details about the EPS payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`, `deutsche_bank_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`.", - "undocumented": false, - "html": "The customer’s bank. Should be one of \u003Ccode\u003Earzte_und_apotheker_bank\u003C/code\u003E, \u003Ccode\u003Eaustrian_anadi_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebank_austria\u003C/code\u003E, \u003Ccode\u003Ebankhaus_carl_spangler\u003C/code\u003E, \u003Ccode\u003Ebankhaus_schelhammer_und_schattera_ag\u003C/code\u003E, \u003Ccode\u003Ebawag_psk_ag\u003C/code\u003E, \u003Ccode\u003Ebks_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebrull_kallmus_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebtv_vier_lander_bank\u003C/code\u003E, \u003Ccode\u003Ecapital_bank_grawe_gruppe_ag\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank_ag\u003C/code\u003E, \u003Ccode\u003Edolomitenbank\u003C/code\u003E, \u003Ccode\u003Eeasybank_ag\u003C/code\u003E, \u003Ccode\u003Eerste_bank_und_sparkassen\u003C/code\u003E, \u003Ccode\u003Ehypo_alpeadriabank_international_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_noe_lb_fur_niederosterreich_u_wien\u003C/code\u003E, \u003Ccode\u003Ehypo_oberosterreich_salzburg_steiermark\u003C/code\u003E, \u003Ccode\u003Ehypo_tirol_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_vorarlberg_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_bank_burgenland_aktiengesellschaft\u003C/code\u003E, \u003Ccode\u003Emarchfelder_bank\u003C/code\u003E, \u003Ccode\u003Eoberbank_ag\u003C/code\u003E, \u003Ccode\u003Eraiffeisen_bankengruppe_osterreich\u003C/code\u003E, \u003Ccode\u003Eschoellerbank_ag\u003C/code\u003E, \u003Ccode\u003Esparda_bank_wien\u003C/code\u003E, \u003Ccode\u003Evolksbank_gruppe\u003C/code\u003E, \u003Ccode\u003Evolkskreditbank_ag\u003C/code\u003E, or \u003Ccode\u003Evr_bank_braunau\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - } - }, - "object_type": "eps", - "less_common": true - }, - "fpx": { - "name": "fpx", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Efpx\u003C/code\u003E PaymentMethod, this hash contains details about the FPX payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `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`, `pb_enterprise`, or `bank_of_china`.", - "undocumented": false, - "html": "The customer’s bank, if provided. Can be one of \u003Ccode\u003Eaffin_bank\u003C/code\u003E, \u003Ccode\u003Eagrobank\u003C/code\u003E, \u003Ccode\u003Ealliance_bank\u003C/code\u003E, \u003Ccode\u003Eambank\u003C/code\u003E, \u003Ccode\u003Ebank_islam\u003C/code\u003E, \u003Ccode\u003Ebank_muamalat\u003C/code\u003E, \u003Ccode\u003Ebank_rakyat\u003C/code\u003E, \u003Ccode\u003Ebsn\u003C/code\u003E, \u003Ccode\u003Ecimb\u003C/code\u003E, \u003Ccode\u003Ehong_leong_bank\u003C/code\u003E, \u003Ccode\u003Ehsbc\u003C/code\u003E, \u003Ccode\u003Ekfh\u003C/code\u003E, \u003Ccode\u003Emaybank2u\u003C/code\u003E, \u003Ccode\u003Eocbc\u003C/code\u003E, \u003Ccode\u003Epublic_bank\u003C/code\u003E, \u003Ccode\u003Erhb\u003C/code\u003E, \u003Ccode\u003Estandard_chartered\u003C/code\u003E, \u003Ccode\u003Euob\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank\u003C/code\u003E, \u003Ccode\u003Emaybank2e\u003C/code\u003E, \u003Ccode\u003Epb_enterprise\u003C/code\u003E, or \u003Ccode\u003Ebank_of_china\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - } - }, - "object_type": "fpx", - "less_common": true - }, - "giropay": { - "name": "giropay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egiropay\u003C/code\u003E PaymentMethod, this hash contains details about the Giropay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "giropay", - "less_common": true - }, - "grabpay": { - "name": "grabpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egrabpay\u003C/code\u003E PaymentMethod, this hash contains details about the GrabPay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "grabpay", - "less_common": true - }, - "ideal": { - "name": "ideal", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eideal\u003C/code\u003E PaymentMethod, this hash contains details about the iDEAL payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`.", - "undocumented": false, - "html": "The customer’s bank, if provided. Can be one of \u003Ccode\u003Eabn_amro\u003C/code\u003E, \u003Ccode\u003Easn_bank\u003C/code\u003E, \u003Ccode\u003Ebunq\u003C/code\u003E, \u003Ccode\u003Ehandelsbanken\u003C/code\u003E, \u003Ccode\u003Eing\u003C/code\u003E, \u003Ccode\u003Eknab\u003C/code\u003E, \u003Ccode\u003Emoneyou\u003C/code\u003E, \u003Ccode\u003Erabobank\u003C/code\u003E, \u003Ccode\u003Eregiobank\u003C/code\u003E, \u003Ccode\u003Erevolut\u003C/code\u003E, \u003Ccode\u003Esns_bank\u003C/code\u003E, \u003Ccode\u003Etriodos_bank\u003C/code\u003E, or \u003Ccode\u003Evan_lanschot\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - }, - "bic": { - "name": "bic", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Bank Identifier Code of the customer's bank, if the bank was provided.", - "undocumented": false, - "html": "The Bank Identifier Code of the customer’s bank, if the bank was provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bic" - } - }, - "object_type": "ideal", - "less_common": true - }, - "interac_present": { - "name": "interac_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Einterac_present\u003C/code\u003E PaymentMethod, this hash contains details about the Interac Present payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `interac`, `mastercard` or `visa`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E or \u003Ccode\u003Evisa\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "preferred_locales": { - "name": "preferred_locales", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred_locales" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - } - }, - "object_type": "interac_present", - "less_common": true - }, - "klarna": { - "name": "klarna", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eklarna\u003C/code\u003E PaymentMethod, this hash contains details about the Klarna payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "dob": { - "name": "dob", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's date of birth, if provided.", - "undocumented": false, - "html": "The customer’s date of birth, if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "day": { - "name": "day", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The day of birth, between 1 and 31.", - "undocumented": false, - "html": "The day of birth, between 1 and 31." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "day" - }, - "month": { - "name": "month", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The month of birth, between 1 and 12.", - "undocumented": false, - "html": "The month of birth, between 1 and 12." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "month" - }, - "year": { - "name": "year", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The four-digit year of birth.", - "undocumented": false, - "html": "The four-digit year of birth." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "year" - } - }, - "object_type": "dob" - } - }, - "object_type": "klarna", - "less_common": true - }, - "konbini": { - "name": "konbini", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ekonbini\u003C/code\u003E PaymentMethod, this hash contains details about the Konbini payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "konbini", - "less_common": true - }, - "link": { - "name": "link", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003ELink\u003C/code\u003E PaymentMethod, this hash contains details about the Link payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account owner's email address.", - "undocumented": false, - "html": "Account owner’s email address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "persistent_token": { - "name": "persistent_token", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Token used for persistent Link logins.", - "undocumented": false, - "html": "Token used for persistent Link logins." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "persistent_token" - } - }, - "object_type": "link", - "less_common": true - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "oxxo": { - "name": "oxxo", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eoxxo\u003C/code\u003E PaymentMethod, this hash contains details about the OXXO payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "oxxo", - "less_common": true - }, - "p24": { - "name": "p24", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ep24\u003C/code\u003E PaymentMethod, this hash contains details about the P24 payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's bank, if provided.", - "undocumented": false, - "html": "The customer’s bank, if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "ing": { "documentation": null }, - "citi_handlowy": { "documentation": null }, - "tmobile_usbugi_bankowe": { "documentation": null }, - "plus_bank": { "documentation": null }, - "etransfer_pocztowy24": { "documentation": null }, - "banki_spbdzielcze": { "documentation": null }, - "bank_nowy_bfg_sa": { "documentation": null }, - "getin_bank": { "documentation": null }, - "blik": { "documentation": null }, - "noble_pay": { "documentation": null }, - "ideabank": { "documentation": null }, - "envelobank": { "documentation": null }, - "santander_przelew24": { "documentation": null }, - "nest_przelew": { "documentation": null }, - "mbank_mtransfer": { "documentation": null }, - "inteligo": { "documentation": null }, - "pbac_z_ipko": { "documentation": null }, - "bnp_paribas": { "documentation": null }, - "credit_agricole": { "documentation": null }, - "toyota_bank": { "documentation": null }, - "bank_pekao_sa": { "documentation": null }, - "volkswagen_bank": { "documentation": null }, - "bank_millennium": { "documentation": null }, - "alior_bank": { "documentation": null }, - "boz": { "documentation": null } - }, - "object_type": "bank" - } - }, - "object_type": "p24", - "less_common": true - }, - "paynow": { - "name": "paynow", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epaynow\u003C/code\u003E PaymentMethod, this hash contains details about the PayNow payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "paynow", - "less_common": true - }, - "pix": { - "name": "pix", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epix\u003C/code\u003E PaymentMethod, this hash contains details about the Pix payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "pix", - "less_common": true - }, - "promptpay": { - "name": "promptpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epromptpay\u003C/code\u003E PaymentMethod, this hash contains details about the PromptPay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "promptpay", - "less_common": true - }, - "radar_options": { - "name": "radar_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Options to configure Radar. See [Radar Session](/docs/radar/radar-session) for more information.", - "undocumented": false, - "html": "Options to configure Radar. See \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E for more information." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "session": { - "name": "session", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A [Radar Session](/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", - "undocumented": false, - "html": "A \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "session" - } - }, - "object_type": "radar_options", - "less_common": true - }, - "sepa_debit": { - "name": "sepa_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esepa_debit\u003C/code\u003E PaymentMethod, this hash contains details about the SEPA debit bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_code": { - "name": "bank_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank code of bank associated with the bank account.", - "undocumented": false, - "html": "Bank code of bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_code" - }, - "branch_code": { - "name": "branch_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Branch code of bank associated with the bank account.", - "undocumented": false, - "html": "Branch code of bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "branch_code" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter ISO code representing the country the bank account is located in.", - "undocumented": false, - "html": "Two-letter ISO code representing the country the bank account is located in." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "generated_from": { - "name": "generated_from", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Information about the object that generated this PaymentMethod.", - "undocumented": false, - "html": "Information about the object that generated this PaymentMethod." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Charge that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the Charge that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["charge"], - "object_type": "charge" - }, - "setup_attempt": { - "name": "setup_attempt", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the SetupAttempt that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["setup_attempt"], - "object_type": "setup_attempt" - } - }, - "object_type": "generated_from" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four characters of the IBAN.", - "undocumented": false, - "html": "Last four characters of the IBAN." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - } - }, - "object_type": "sepa_debit", - "less_common": true - }, - "sofort": { - "name": "sofort", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esofort\u003C/code\u003E PaymentMethod, this hash contains details about the SOFORT payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter ISO code representing the country the bank account is located in.", - "undocumented": false, - "html": "Two-letter ISO code representing the country the bank account is located in." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - } - }, - "object_type": "sofort", - "less_common": true - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "acss_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Pre-authorized debit payments](/docs/payments/acss-debit) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/acss-debit\"\u003EPre-authorized debit payments\u003C/a\u003E are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS)." - } - }, - "affirm": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Affirm](/docs/payments/affirm) is a buy now, pay later payment method in the US.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/affirm\"\u003EAffirm\u003C/a\u003E is a buy now, pay later payment method in the US." - } - }, - "afterpay_clearpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Afterpay / Clearpay](/docs/payments/afterpay-clearpay) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/afterpay-clearpay\"\u003EAfterpay / Clearpay\u003C/a\u003E is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US." - } - }, - "alipay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Alipay](/docs/payments/alipay) is a digital wallet payment method used in China.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/alipay\"\u003EAlipay\u003C/a\u003E is a digital wallet payment method used in China." - } - }, - "au_becs_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[BECS Direct Debit](/docs/payments/au-becs-debit) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/au-becs-debit\"\u003EBECS Direct Debit\u003C/a\u003E is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS)." - } - }, - "bacs_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Bacs Direct Debit](/docs/payments/payment-methods/bacs-debit) is used to debit UK bank accounts.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/payment-methods/bacs-debit\"\u003EBacs Direct Debit\u003C/a\u003E is used to debit UK bank accounts." - } - }, - "bancontact": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Bancontact](/docs/payments/bancontact) is a bank redirect payment method used in Belgium.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/bancontact\"\u003EBancontact\u003C/a\u003E is a bank redirect payment method used in Belgium." - } - }, - "blik": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[BLIK](/docs/payments/blik) is a single-use payment method common in Poland.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/blik\"\u003EBLIK\u003C/a\u003E is a single-use payment method common in Poland." - } - }, - "boleto": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Boleto](/docs/payments/boleto) is a voucher-based payment method used in Brazil.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/boleto\"\u003EBoleto\u003C/a\u003E is a voucher-based payment method used in Brazil." - } - }, - "card": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Card payments](/docs/payments/payment-methods/overview#cards) are supported through many networks and card brands.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/payment-methods/overview#cards\"\u003ECard payments\u003C/a\u003E are supported through many networks and card brands." - } - }, - "card_present": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Stripe Terminal](/docs/terminal/payments/collect-payment) is used to collect in-person card payments.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E is used to collect in-person card payments." - } - }, - "customer_balance": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uses a customer’s [cash balance](/docs/payments/customer-balance) for the payment.", - "undocumented": false, - "html": "Uses a customer’s \u003Ca href=\"/docs/payments/customer-balance\"\u003Ecash balance\u003C/a\u003E for the payment." - } - }, - "eps": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[EPS](/docs/payments/eps) is an Austria-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/eps\"\u003EEPS\u003C/a\u003E is an Austria-based bank redirect payment method." - } - }, - "fpx": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[FPX](/docs/payments/fpx) is a Malaysia-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/fpx\"\u003EFPX\u003C/a\u003E is a Malaysia-based bank redirect payment method." - } - }, - "giropay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[giropay](/docs/payments/giropay) is a German bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/giropay\"\u003Egiropay\u003C/a\u003E is a German bank redirect payment method." - } - }, - "grabpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[GrabPay](/docs/payments/grabpay) is a digital wallet payment method used in Southeast Asia.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/grabpay\"\u003EGrabPay\u003C/a\u003E is a digital wallet payment method used in Southeast Asia." - } - }, - "ideal": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[iDEAL](/docs/payments/ideal) is a Netherlands-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/ideal\"\u003EiDEAL\u003C/a\u003E is a Netherlands-based bank redirect payment method." - } - }, - "interac_present": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Stripe Terminal](/docs/terminal/payments/collect-payment) accepts [Interac](/docs/terminal/payments/regional?integration-country=CA#interac-payments) debit cards for in-person payments in Canada.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E accepts \u003Ca href=\"/docs/terminal/payments/regional?integration-country=CA#interac-payments\"\u003EInterac\u003C/a\u003E debit cards for in-person payments in Canada." - } - }, - "klarna": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Klarna](/docs/payments/klarna) is a global buy now, pay later payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/klarna\"\u003EKlarna\u003C/a\u003E is a global buy now, pay later payment method." - } - }, - "konbini": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Konbini](/docs/payments/konbini) is a cash-based voucher payment method used in Japan.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/konbini\"\u003EKonbini\u003C/a\u003E is a cash-based voucher payment method used in Japan." - } - }, - "link": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Link](/docs/payments/link) allows customers to pay with their saved payment details.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/link\"\u003ELink\u003C/a\u003E allows customers to pay with their saved payment details." - } - }, - "oxxo": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[OXXO](/docs/payments/oxxo) is a cash-based voucher payment method used in Mexico.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/oxxo\"\u003EOXXO\u003C/a\u003E is a cash-based voucher payment method used in Mexico." - } - }, - "p24": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Przelewy24](/docs/payments/p24) is a bank redirect payment method used in Poland.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/p24\"\u003EPrzelewy24\u003C/a\u003E is a bank redirect payment method used in Poland." - } - }, - "paynow": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[PayNow](/docs/payments/paynow) is a QR code payment method used in Singapore.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/paynow\"\u003EPayNow\u003C/a\u003E is a QR code payment method used in Singapore." - } - }, - "pix": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Pix](/docs/payments/pix) is an instant bank transfer payment method in Brazil.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/pix\"\u003EPix\u003C/a\u003E is an instant bank transfer payment method in Brazil." - } - }, - "promptpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[PromptPay](/docs/payments/promptpay) is an instant funds transfer service popular in Thailand.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/promptpay\"\u003EPromptPay\u003C/a\u003E is an instant funds transfer service popular in Thailand." - } - }, - "sepa_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[SEPA Direct Debit](/docs/payments/sepa-debit) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/sepa-debit\"\u003ESEPA Direct Debit\u003C/a\u003E is used to debit bank accounts within the Single Euro Payments Area (SEPA) region." - } - }, - "sofort": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Sofort](/docs/payments/sofort) is a bank redirect payment method used in Europe.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/sofort\"\u003ESofort\u003C/a\u003E is a bank redirect payment method used in Europe." - } - }, - "us_bank_account": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[ACH Direct Debit](/docs/payments/ach-debit) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/ach-debit\"\u003EACH Direct Debit\u003C/a\u003E is used to debit US bank accounts through the Automated Clearing House (ACH) payments system." - } - }, - "wechat_pay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[WeChat Pay](/docs/payments/wechat-pay) is a digital wallet payment method based in China.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/wechat-pay\"\u003EWeChat Pay\u003C/a\u003E is a digital wallet payment method based in China." - } - } - }, - "object_type": "type" - }, - "us_bank_account": { - "name": "us_bank_account", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eus_bank_account\u003C/code\u003E PaymentMethod, this hash contains details about the US bank account payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_holder_type": { - "name": "account_holder_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account holder type: individual or company.", - "undocumented": false, - "html": "Account holder type: individual or company." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "individual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account belongs to an individual", - "undocumented": false, - "html": "Account belongs to an individual" - } - }, - "company": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account belongs to a company", - "undocumented": false, - "html": "Account belongs to a company" - } - } - }, - "object_type": "account_holder_type" - }, - "account_type": { - "name": "account_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account type: checkings or savings. Defaults to checking if omitted.", - "undocumented": false, - "html": "Account type: checkings or savings. Defaults to checking if omitted." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "checking": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account type is checking", - "undocumented": false, - "html": "Bank account type is checking" - } - }, - "savings": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account type is savings", - "undocumented": false, - "html": "Bank account type is savings" - } - } - }, - "object_type": "account_type" - }, - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The name of the bank.", - "undocumented": false, - "html": "The name of the bank." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "financial_connections_account": { - "name": "financial_connections_account", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Financial Connections Account used to create the payment method.", - "undocumented": false, - "html": "The ID of the Financial Connections Account used to create the payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "financial_connections_account" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about US bank account networks that can be used.", - "undocumented": false, - "html": "Contains information about US bank account networks that can be used." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network.", - "undocumented": false, - "html": "The preferred network." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - }, - "supported": { - "name": "supported", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All supported networks.", - "undocumented": false, - "html": "All supported networks." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported" - } - }, - "object_type": "networks" - }, - "routing_number": { - "name": "routing_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Routing number of the bank account.", - "undocumented": false, - "html": "Routing number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "routing_number" - } - }, - "object_type": "us_bank_account", - "less_common": true - }, - "wechat_pay": { - "name": "wechat_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Ewechat_pay\u003C/code\u003E PaymentMethod, this hash contains details about the wechat_pay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "wechat_pay", - "less_common": true - } - }, - "object_type": "payment_method", - "less_common": true - }, - "payment_method_type": { - "name": "payment_method_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_method_type", - "less_common": true - }, - "request_log_url": { - "name": "request_log_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A URL to the request log entry in your dashboard.", - "undocumented": false, - "html": "A URL to the request log entry in your dashboard." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "request_log_url", - "less_common": true - }, - "setup_intent": { - "name": "setup_intent", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The SetupIntent object for errors returned on a request involving a SetupIntent.", - "undocumented": false, - "html": "The SetupIntent object for errors returned on a request involving a SetupIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "setup_intent", - "less_common": true, - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "application": { - "name": "application", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the Connect application that created the SetupIntent.", - "undocumented": false, - "html": "ID of the Connect application that created the SetupIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["application"], - "object_type": "application", - "less_common": true - }, - "attach_to_self": { - "name": "attach_to_self", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.\n", - "undocumented": false, - "html": "If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.\u003C/p\u003E\n\n\u003Cp\u003EIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "attach_to_self", - "less_common": true - }, - "cancellation_reason": { - "name": "cancellation_reason", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.", - "undocumented": false, - "html": "Reason for cancellation of this SetupIntent, one of \u003Ccode\u003Eabandoned\u003C/code\u003E, \u003Ccode\u003Erequested_by_customer\u003C/code\u003E, or \u003Ccode\u003Eduplicate\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cancellation_reason", - "less_common": true - }, - "client_secret": { - "name": "client_secret", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.", - "undocumented": false, - "html": "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\u003C/p\u003E\n\n\u003Cp\u003EThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "client_secret" - }, - "created": { - "name": "created", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Time at which the object was created. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "created", - "less_common": true - }, - "customer": { - "name": "customer", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.\n", - "undocumented": false, - "html": "ID of the Customer this SetupIntent belongs to, if one exists.\u003C/p\u003E\n\n\u003Cp\u003EIf 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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["customer"], - "object_type": "customer" - }, - "description": { - "name": "description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An arbitrary string attached to the object. Often useful for displaying to users.", - "undocumented": false, - "html": "An arbitrary string attached to the object. Often useful for displaying to users." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "description" - }, - "flow_directions": { - "name": "flow_directions", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.\n", - "undocumented": false, - "html": "Indicates the directions of money movement for which this payment method is intended to be used.\u003C/p\u003E\n\n\u003Cp\u003EInclude \u003Ccode\u003Einbound\u003C/code\u003E if you intend to use the payment method as the origin to pull funds from. Include \u003Ccode\u003Eoutbound\u003C/code\u003E if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "flow_directions", - "less_common": true - }, - "last_setup_error": { - "name": "last_setup_error", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The error encountered in the previous SetupIntent confirmation.", - "undocumented": false, - "html": "The error encountered in the previous SetupIntent confirmation." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "code": { - "name": "code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For some errors that could be handled programmatically, a short string indicating the [error code](/docs/error-codes) reported.", - "undocumented": false, - "html": "For some errors that could be handled programmatically, a short string indicating the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "code" - }, - "decline_code": { - "name": "decline_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](/docs/declines#issuer-declines) if they provide one.", - "undocumented": false, - "html": "For card errors resulting from a card issuer decline, a short string indicating the \u003Ca href=\"/docs/declines#issuer-declines\"\u003Ecard issuer’s reason for the decline\u003C/a\u003E if they provide one." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "decline_code" - }, - "doc_url": { - "name": "doc_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A URL to more information about the [error code](/docs/error-codes) reported.", - "undocumented": false, - "html": "A URL to more information about the \u003Ca href=\"/docs/error-codes\"\u003Eerror code\u003C/a\u003E reported." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "doc_url", - "less_common": true - }, - "message": { - "name": "message", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.", - "undocumented": false, - "html": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "message" - }, - "param": { - "name": "param", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "param" - }, - "payment_method": { - "name": "payment_method", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The PaymentMethod object for errors returned on a request involving a PaymentMethod.", - "undocumented": false, - "html": "The PaymentMethod object for errors returned on a request involving a PaymentMethod." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "acss_debit": { - "name": "acss_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eacss_debit\u003C/code\u003E PaymentMethod, this hash contains details about the ACSS Debit payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Name of the bank associated with the bank account.", - "undocumented": false, - "html": "Name of the bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "institution_number": { - "name": "institution_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Institution number of the bank account.", - "undocumented": false, - "html": "Institution number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "institution_number" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "transit_number": { - "name": "transit_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transit number of the bank account.", - "undocumented": false, - "html": "Transit number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "transit_number" - } - }, - "object_type": "acss_debit", - "less_common": true - }, - "affirm": { - "name": "affirm", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eaffirm\u003C/code\u003E PaymentMethod, this hash contains details about the Affirm payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "affirm", - "less_common": true - }, - "afterpay_clearpay": { - "name": "afterpay_clearpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003EAfterpayClearpay\u003C/code\u003E PaymentMethod, this hash contains details about the AfterpayClearpay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "afterpay_clearpay", - "less_common": true - }, - "alipay": { - "name": "alipay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003EAlipay\u003C/code\u003E PaymentMethod, this hash contains details about the Alipay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "alipay", - "less_common": true - }, - "au_becs_debit": { - "name": "au_becs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eau_becs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bsb_number": { - "name": "bsb_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Six-digit number identifying bank and branch associated with this bank account.", - "undocumented": false, - "html": "Six-digit number identifying bank and branch associated with this bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bsb_number" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - } - }, - "object_type": "au_becs_debit", - "less_common": true - }, - "bacs_debit": { - "name": "bacs_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ebacs_debit\u003C/code\u003E PaymentMethod, this hash contains details about the Bacs Direct Debit bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "sort_code": { - "name": "sort_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Sort code of the bank account. (e.g., `10-20-30`)", - "undocumented": false, - "html": "Sort code of the bank account. (e.g., \u003Ccode\u003E10-20-30\u003C/code\u003E)" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "sort_code" - } - }, - "object_type": "bacs_debit", - "less_common": true - }, - "bancontact": { - "name": "bancontact", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ebancontact\u003C/code\u003E PaymentMethod, this hash contains details about the Bancontact payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "bancontact", - "less_common": true - }, - "billing_details": { - "name": "billing_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", - "undocumented": false, - "html": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "address": { - "name": "address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing address.", - "undocumented": false, - "html": "Billing address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Email address.", - "undocumented": false, - "html": "Email address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Full name.", - "undocumented": false, - "html": "Full name." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "phone": { - "name": "phone", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Billing phone number (including extension).", - "undocumented": false, - "html": "Billing phone number (including extension)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "phone" - } - }, - "object_type": "billing_details" - }, - "blik": { - "name": "blik", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eblik\u003C/code\u003E PaymentMethod, this hash contains details about the BLIK payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "blik", - "less_common": true - }, - "boleto": { - "name": "boleto", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eboleto\u003C/code\u003E PaymentMethod, this hash contains details about the Boleto payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": null, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "tax_id": { - "name": "tax_id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies the customer tax id (CNPJ or CPF)", - "undocumented": false, - "html": "Uniquely identifies the customer tax id (CNPJ or CPF)" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tax_id" - } - }, - "object_type": "boleto", - "less_common": true - }, - "card": { - "name": "card", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `card` PaymentMethod, this hash contains the user's card details.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecard\u003C/code\u003E PaymentMethod, this hash contains the user’s card details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "checks": { - "name": "checks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checks on Card address and CVC if provided.", - "undocumented": false, - "html": "Checks on Card address and CVC if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "address_line1_check": { - "name": "address_line1_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a address line1 was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "address_line1_check" - }, - "address_postal_code_check": { - "name": "address_postal_code_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a address postal code was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "address_postal_code_check" - }, - "cvc_check": { - "name": "cvc_check", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "undocumented": false, - "html": "If a CVC was provided, results of the check, one of \u003Ccode\u003Epass\u003C/code\u003E, \u003Ccode\u003Efail\u003C/code\u003E, \u003Ccode\u003Eunavailable\u003C/code\u003E, or \u003Ccode\u003Eunchecked\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cvc_check" - } - }, - "object_type": "checks" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": "card_fingerprint_read", - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "generated_from": { - "name": "generated_from", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": { - "sdk_client_public": { - "gate_specific": {}, - "localize_terms": [], - "undocumented": true, - "html": null - } - }, - "localize_terms": [], - "markdown": "Details of the original PaymentMethod that created this object.", - "undocumented": false, - "html": "Details of the original PaymentMethod that created this object." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The charge that created this object.", - "undocumented": false, - "html": "The charge that created this object." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "charge" - }, - "payment_method_details": { - "name": "payment_method_details", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transaction-specific details of the payment method used in the payment.", - "undocumented": false, - "html": "Transaction-specific details of the payment method used in the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "card_present": { - "name": "card_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "This hash contains the snapshot of the `card_present` transaction-specific details which generated this `card` payment method.", - "undocumented": false, - "html": "This hash contains the snapshot of the \u003Ccode\u003Ecard_present\u003C/code\u003E transaction-specific details which generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount_authorized": { - "name": "amount_authorized", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The authorized amount", - "undocumented": false, - "html": "The authorized amount" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_authorized" - }, - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "capture_before": { - "name": "capture_before", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.", - "undocumented": false, - "html": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "capture_before" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "emv_auth_data": { - "name": "emv_auth_data", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Authorization response cryptogram.", - "undocumented": false, - "html": "Authorization response cryptogram." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "emv_auth_data" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "generated_card": { - "name": "generated_card", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "generated_card" - }, - "incremental_authorization_supported": { - "name": "incremental_authorization_supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether this [PaymentIntent](/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).", - "undocumented": false, - "html": "Whether this \u003Ca href=\"/docs/api/payment_intents\"\u003EPaymentIntent\u003C/a\u003E is eligible for incremental authorizations. Request support using \u003Ca href=\"/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support\"\u003Erequest_incremental_authorization_support\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "incremental_authorization_supported" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "network": { - "name": "network", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Identifies which network this charge was processed on. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ecartes_bancaires\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "network" - }, - "overcapture_supported": { - "name": "overcapture_supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Defines whether the authorized amount can be over-captured or not", - "undocumented": false, - "html": "Defines whether the authorized amount can be over-captured or not" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "overcapture_supported" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - }, - "receipt": { - "name": "receipt", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", - "undocumented": false, - "html": "A collection of fields required to be displayed on receipts. Only required for EMV transactions." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_type": { - "name": "account_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of account being debited or credited", - "undocumented": false, - "html": "The type of account being debited or credited" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "credit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A credit account, as when using a credit card", - "undocumented": false, - "html": "A credit account, as when using a credit card" - } - }, - "checking": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A checking account, as when using a debit card", - "undocumented": false, - "html": "A checking account, as when using a debit card" - } - }, - "prepaid": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A prepaid account, as when using a debit gift card", - "undocumented": false, - "html": "A prepaid account, as when using a debit gift card" - } - }, - "unknown": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An unknown account", - "undocumented": false, - "html": "An unknown account" - } - } - }, - "object_type": "account_type" - }, - "application_cryptogram": { - "name": "application_cryptogram", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 9F26, cryptogram generated by the integrated circuit chip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_cryptogram" - }, - "application_preferred_name": { - "name": "application_preferred_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Mnenomic of the Application Identifier.", - "undocumented": false, - "html": "Mnenomic of the Application Identifier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_preferred_name" - }, - "authorization_code": { - "name": "authorization_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Identifier for this transaction.", - "undocumented": false, - "html": "Identifier for this transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "authorization_code" - }, - "authorization_response_code": { - "name": "authorization_response_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 8A. A code returned by the card issuer.", - "undocumented": false, - "html": "EMV tag 8A. A code returned by the card issuer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "authorization_response_code" - }, - "cardholder_verification_method": { - "name": "cardholder_verification_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How the cardholder verified ownership of the card.", - "undocumented": false, - "html": "How the cardholder verified ownership of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_verification_method" - }, - "dedicated_file_name": { - "name": "dedicated_file_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "dedicated_file_name" - }, - "terminal_verification_results": { - "name": "terminal_verification_results", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The outcome of a series of EMV functions performed by the card reader.", - "undocumented": false, - "html": "The outcome of a series of EMV functions performed by the card reader." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "terminal_verification_results" - }, - "transaction_status_information": { - "name": "transaction_status_information", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An indication of various EMV functions performed during the transaction.", - "undocumented": false, - "html": "An indication of various EMV functions performed during the transaction." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "transaction_status_information" - } - }, - "object_type": "receipt" - } - }, - "object_type": "card_present" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.", - "undocumented": false, - "html": "The type of payment method transaction-specific details from the transaction that generated this \u003Ccode\u003Ecard\u003C/code\u003E payment method. Always \u003Ccode\u003Ecard_present\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "payment_method_details" - }, - "setup_attempt": { - "name": "setup_attempt", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the SetupAttempt that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["setup_attempt"], - "object_type": "setup_attempt" - } - }, - "object_type": "generated_from" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "three_d_secure_usage": { - "name": "three_d_secure_usage", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains details on how this Card may be used for 3D Secure authentication.", - "undocumented": false, - "html": "Contains details on how this Card may be used for 3D Secure authentication." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "supported": { - "name": "supported", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether 3D Secure is supported on this card.", - "undocumented": false, - "html": "Whether 3D Secure is supported on this card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported" - } - }, - "object_type": "three_d_secure_usage" - }, - "wallet": { - "name": "wallet", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this Card is part of a card wallet, this contains the details of the card wallet.", - "undocumented": false, - "html": "If this Card is part of a card wallet, this contains the details of the card wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amex_express_checkout": { - "name": "amex_express_checkout", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `amex_express_checkout` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "amex_express_checkout" - }, - "apple_pay": { - "name": "apple_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `apple_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eapple_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "apple_pay" - }, - "dynamic_last4": { - "name": "dynamic_last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "(For tokenized numbers only.) The last four digits of the device account number.", - "undocumented": false, - "html": "(For tokenized numbers only.) The last four digits of the device account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "dynamic_last4" - }, - "google_pay": { - "name": "google_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `google_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egoogle_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "google_pay" - }, - "masterpass": { - "name": "masterpass", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `masterpass` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Emasterpass\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "billing_address": { - "name": "billing_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "billing_address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "shipping_address": { - "name": "shipping_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "shipping_address" - } - }, - "object_type": "masterpass" - }, - "samsung_pay": { - "name": "samsung_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `samsung_pay` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esamsung_pay\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "samsung_pay" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "The type of the card wallet, one of \u003Ccode\u003Eamex_express_checkout\u003C/code\u003E, \u003Ccode\u003Eapple_pay\u003C/code\u003E, \u003Ccode\u003Egoogle_pay\u003C/code\u003E, \u003Ccode\u003Emasterpass\u003C/code\u003E, \u003Ccode\u003Esamsung_pay\u003C/code\u003E, or \u003Ccode\u003Evisa_checkout\u003C/code\u003E. 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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - }, - "visa_checkout": { - "name": "visa_checkout", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `visa_checkout` card wallet, this hash contains details about the wallet.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Evisa_checkout\u003C/code\u003E card wallet, this hash contains details about the wallet." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "billing_address": { - "name": "billing_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "billing_address" - }, - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "name": { - "name": "name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "name" - }, - "shipping_address": { - "name": "shipping_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "city": { - "name": "city", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "City, district, suburb, town, or village.", - "undocumented": false, - "html": "City, district, suburb, town, or village." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "city" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "line1": { - "name": "line1", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 1 (e.g., street, PO Box, or company name).", - "undocumented": false, - "html": "Address line 1 (e.g., street, PO Box, or company name)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line1" - }, - "line2": { - "name": "line2", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Address line 2 (e.g., apartment, suite, unit, or building).", - "undocumented": false, - "html": "Address line 2 (e.g., apartment, suite, unit, or building)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "line2" - }, - "postal_code": { - "name": "postal_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ZIP or postal code.", - "undocumented": false, - "html": "ZIP or postal code." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "postal_code" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "State, county, province, or region.", - "undocumented": false, - "html": "State, county, province, or region." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - } - }, - "object_type": "shipping_address" - } - }, - "object_type": "visa_checkout" - } - }, - "object_type": "wallet" - } - }, - "object_type": "card", - "less_common": true - }, - "card_present": { - "name": "card_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `card_present` PaymentMethod, this hash contains details about the Card Present payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecard_present\u003C/code\u003E PaymentMethod, this hash contains details about the Card Present payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Eamex\u003C/code\u003E, \u003Ccode\u003Ediners\u003C/code\u003E, \u003Ccode\u003Ediscover\u003C/code\u003E, \u003Ccode\u003Ejcb\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E, \u003Ccode\u003Eunionpay\u003C/code\u003E, \u003Ccode\u003Evisa\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - } - }, - "object_type": "card_present", - "less_common": true - }, - "created": { - "name": "created", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Time at which the object was created. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "created", - "less_common": true - }, - "customer": { - "name": "customer", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["customer"], - "object_type": "customer" - }, - "customer_balance": { - "name": "customer_balance", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ecustomer_balance\u003C/code\u003E PaymentMethod, this hash contains details about the CustomerBalance payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "customer_balance", - "less_common": true - }, - "eps": { - "name": "eps", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eeps\u003C/code\u003E PaymentMethod, this hash contains details about the EPS payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`, `deutsche_bank_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`.", - "undocumented": false, - "html": "The customer’s bank. Should be one of \u003Ccode\u003Earzte_und_apotheker_bank\u003C/code\u003E, \u003Ccode\u003Eaustrian_anadi_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebank_austria\u003C/code\u003E, \u003Ccode\u003Ebankhaus_carl_spangler\u003C/code\u003E, \u003Ccode\u003Ebankhaus_schelhammer_und_schattera_ag\u003C/code\u003E, \u003Ccode\u003Ebawag_psk_ag\u003C/code\u003E, \u003Ccode\u003Ebks_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebrull_kallmus_bank_ag\u003C/code\u003E, \u003Ccode\u003Ebtv_vier_lander_bank\u003C/code\u003E, \u003Ccode\u003Ecapital_bank_grawe_gruppe_ag\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank_ag\u003C/code\u003E, \u003Ccode\u003Edolomitenbank\u003C/code\u003E, \u003Ccode\u003Eeasybank_ag\u003C/code\u003E, \u003Ccode\u003Eerste_bank_und_sparkassen\u003C/code\u003E, \u003Ccode\u003Ehypo_alpeadriabank_international_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_noe_lb_fur_niederosterreich_u_wien\u003C/code\u003E, \u003Ccode\u003Ehypo_oberosterreich_salzburg_steiermark\u003C/code\u003E, \u003Ccode\u003Ehypo_tirol_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_vorarlberg_bank_ag\u003C/code\u003E, \u003Ccode\u003Ehypo_bank_burgenland_aktiengesellschaft\u003C/code\u003E, \u003Ccode\u003Emarchfelder_bank\u003C/code\u003E, \u003Ccode\u003Eoberbank_ag\u003C/code\u003E, \u003Ccode\u003Eraiffeisen_bankengruppe_osterreich\u003C/code\u003E, \u003Ccode\u003Eschoellerbank_ag\u003C/code\u003E, \u003Ccode\u003Esparda_bank_wien\u003C/code\u003E, \u003Ccode\u003Evolksbank_gruppe\u003C/code\u003E, \u003Ccode\u003Evolkskreditbank_ag\u003C/code\u003E, or \u003Ccode\u003Evr_bank_braunau\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - } - }, - "object_type": "eps", - "less_common": true - }, - "fpx": { - "name": "fpx", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Efpx\u003C/code\u003E PaymentMethod, this hash contains details about the FPX payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `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`, `pb_enterprise`, or `bank_of_china`.", - "undocumented": false, - "html": "The customer’s bank, if provided. Can be one of \u003Ccode\u003Eaffin_bank\u003C/code\u003E, \u003Ccode\u003Eagrobank\u003C/code\u003E, \u003Ccode\u003Ealliance_bank\u003C/code\u003E, \u003Ccode\u003Eambank\u003C/code\u003E, \u003Ccode\u003Ebank_islam\u003C/code\u003E, \u003Ccode\u003Ebank_muamalat\u003C/code\u003E, \u003Ccode\u003Ebank_rakyat\u003C/code\u003E, \u003Ccode\u003Ebsn\u003C/code\u003E, \u003Ccode\u003Ecimb\u003C/code\u003E, \u003Ccode\u003Ehong_leong_bank\u003C/code\u003E, \u003Ccode\u003Ehsbc\u003C/code\u003E, \u003Ccode\u003Ekfh\u003C/code\u003E, \u003Ccode\u003Emaybank2u\u003C/code\u003E, \u003Ccode\u003Eocbc\u003C/code\u003E, \u003Ccode\u003Epublic_bank\u003C/code\u003E, \u003Ccode\u003Erhb\u003C/code\u003E, \u003Ccode\u003Estandard_chartered\u003C/code\u003E, \u003Ccode\u003Euob\u003C/code\u003E, \u003Ccode\u003Edeutsche_bank\u003C/code\u003E, \u003Ccode\u003Emaybank2e\u003C/code\u003E, \u003Ccode\u003Epb_enterprise\u003C/code\u003E, or \u003Ccode\u003Ebank_of_china\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - } - }, - "object_type": "fpx", - "less_common": true - }, - "giropay": { - "name": "giropay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egiropay\u003C/code\u003E PaymentMethod, this hash contains details about the Giropay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "giropay", - "less_common": true - }, - "grabpay": { - "name": "grabpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Egrabpay\u003C/code\u003E PaymentMethod, this hash contains details about the GrabPay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "grabpay", - "less_common": true - }, - "ideal": { - "name": "ideal", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eideal\u003C/code\u003E PaymentMethod, this hash contains details about the iDEAL payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`.", - "undocumented": false, - "html": "The customer’s bank, if provided. Can be one of \u003Ccode\u003Eabn_amro\u003C/code\u003E, \u003Ccode\u003Easn_bank\u003C/code\u003E, \u003Ccode\u003Ebunq\u003C/code\u003E, \u003Ccode\u003Ehandelsbanken\u003C/code\u003E, \u003Ccode\u003Eing\u003C/code\u003E, \u003Ccode\u003Eknab\u003C/code\u003E, \u003Ccode\u003Emoneyou\u003C/code\u003E, \u003Ccode\u003Erabobank\u003C/code\u003E, \u003Ccode\u003Eregiobank\u003C/code\u003E, \u003Ccode\u003Erevolut\u003C/code\u003E, \u003Ccode\u003Esns_bank\u003C/code\u003E, \u003Ccode\u003Etriodos_bank\u003C/code\u003E, or \u003Ccode\u003Evan_lanschot\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank" - }, - "bic": { - "name": "bic", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Bank Identifier Code of the customer's bank, if the bank was provided.", - "undocumented": false, - "html": "The Bank Identifier Code of the customer’s bank, if the bank was provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bic" - } - }, - "object_type": "ideal", - "less_common": true - }, - "interac_present": { - "name": "interac_present", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Einterac_present\u003C/code\u003E PaymentMethod, this hash contains details about the Interac Present payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "brand": { - "name": "brand", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card brand. Can be `interac`, `mastercard` or `visa`.", - "undocumented": false, - "html": "Card brand. Can be \u003Ccode\u003Einterac\u003C/code\u003E, \u003Ccode\u003Emastercard\u003C/code\u003E or \u003Ccode\u003Evisa\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "brand" - }, - "cardholder_name": { - "name": "cardholder_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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 (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", - "undocumented": false, - "html": "The cardholder name as read from the card, in \u003Ca href=\"https://en.wikipedia.org/wiki/ISO/IEC_7813\"\u003EISO 7813\u003C/a\u003E format. May include alphanumeric characters, special characters and first/last name separator (\u003Ccode\u003E/\u003C/code\u003E). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "cardholder_name" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "exp_month": { - "name": "exp_month", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-digit number representing the card's expiration month.", - "undocumented": false, - "html": "Two-digit number representing the card’s expiration month." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_month" - }, - "exp_year": { - "name": "exp_year", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Four-digit number representing the card's expiration year.", - "undocumented": false, - "html": "Four-digit number representing the card’s expiration year." - }, - "gate": true, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "exp_year" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.*\n", - "undocumented": false, - "html": "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.\u003C/p\u003E\n\n\u003Cp\u003E\u003Cem\u003EStarting 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.\u003C/em\u003E" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "funding": { - "name": "funding", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", - "undocumented": false, - "html": "Card funding type. Can be \u003Ccode\u003Ecredit\u003C/code\u003E, \u003Ccode\u003Edebit\u003C/code\u003E, \u003Ccode\u003Eprepaid\u003C/code\u003E, or \u003Ccode\u003Eunknown\u003C/code\u003E." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "funding" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The last four digits of the card.", - "undocumented": false, - "html": "The last four digits of the card." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about card networks that can be used to process the payment.", - "undocumented": false, - "html": "Contains information about card networks that can be used to process the payment." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "available": { - "name": "available", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All available networks for the card.", - "undocumented": false, - "html": "All available networks for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "available" - }, - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network for the card.", - "undocumented": false, - "html": "The preferred network for the card." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - } - }, - "object_type": "networks" - }, - "preferred_locales": { - "name": "preferred_locales", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", - "undocumented": false, - "html": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred_locales" - }, - "read_method": { - "name": "read_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "How card details were read in this transaction.", - "undocumented": false, - "html": "How card details were read in this transaction." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "contact_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Inserting a chip card into the card reader.", - "undocumented": false, - "html": "Inserting a chip card into the card reader." - } - }, - "contactless_emv": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Tapping a contactless-enabled chip card or mobile wallet.", - "undocumented": false, - "html": "Tapping a contactless-enabled chip card or mobile wallet." - } - }, - "magnetic_stripe_track2": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Swiping a card using the magnetic stripe reader.", - "undocumented": false, - "html": "Swiping a card using the magnetic stripe reader." - } - }, - "magnetic_stripe_fallback": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.", - "undocumented": false, - "html": "When inserting a chip card fails three times in a row, fallback to a magnetic stripe read." - } - }, - "contactless_magstripe_mode": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Older standard for contactless payments that emulated a magnetic stripe read.", - "undocumented": false, - "html": "Older standard for contactless payments that emulated a magnetic stripe read." - } - } - }, - "object_type": "read_method" - } - }, - "object_type": "interac_present", - "less_common": true - }, - "klarna": { - "name": "klarna", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Eklarna\u003C/code\u003E PaymentMethod, this hash contains details about the Klarna payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "dob": { - "name": "dob", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's date of birth, if provided.", - "undocumented": false, - "html": "The customer’s date of birth, if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "day": { - "name": "day", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The day of birth, between 1 and 31.", - "undocumented": false, - "html": "The day of birth, between 1 and 31." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "day" - }, - "month": { - "name": "month", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The month of birth, between 1 and 12.", - "undocumented": false, - "html": "The month of birth, between 1 and 12." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "month" - }, - "year": { - "name": "year", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The four-digit year of birth.", - "undocumented": false, - "html": "The four-digit year of birth." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "year" - } - }, - "object_type": "dob" - } - }, - "object_type": "klarna", - "less_common": true - }, - "konbini": { - "name": "konbini", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ekonbini\u003C/code\u003E PaymentMethod, this hash contains details about the Konbini payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "konbini", - "less_common": true - }, - "link": { - "name": "link", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003ELink\u003C/code\u003E PaymentMethod, this hash contains details about the Link payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "email": { - "name": "email", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account owner's email address.", - "undocumented": false, - "html": "Account owner’s email address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "email" - }, - "persistent_token": { - "name": "persistent_token", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Token used for persistent Link logins.", - "undocumented": false, - "html": "Token used for persistent Link logins." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "persistent_token" - } - }, - "object_type": "link", - "less_common": true - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "oxxo": { - "name": "oxxo", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eoxxo\u003C/code\u003E PaymentMethod, this hash contains details about the OXXO payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "oxxo", - "less_common": true - }, - "p24": { - "name": "p24", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Ep24\u003C/code\u003E PaymentMethod, this hash contains details about the P24 payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank": { - "name": "bank", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The customer's bank, if provided.", - "undocumented": false, - "html": "The customer’s bank, if provided." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "ing": { "documentation": null }, - "citi_handlowy": { "documentation": null }, - "tmobile_usbugi_bankowe": { "documentation": null }, - "plus_bank": { "documentation": null }, - "etransfer_pocztowy24": { "documentation": null }, - "banki_spbdzielcze": { "documentation": null }, - "bank_nowy_bfg_sa": { "documentation": null }, - "getin_bank": { "documentation": null }, - "blik": { "documentation": null }, - "noble_pay": { "documentation": null }, - "ideabank": { "documentation": null }, - "envelobank": { "documentation": null }, - "santander_przelew24": { "documentation": null }, - "nest_przelew": { "documentation": null }, - "mbank_mtransfer": { "documentation": null }, - "inteligo": { "documentation": null }, - "pbac_z_ipko": { "documentation": null }, - "bnp_paribas": { "documentation": null }, - "credit_agricole": { "documentation": null }, - "toyota_bank": { "documentation": null }, - "bank_pekao_sa": { "documentation": null }, - "volkswagen_bank": { "documentation": null }, - "bank_millennium": { "documentation": null }, - "alior_bank": { "documentation": null }, - "boz": { "documentation": null } - }, - "object_type": "bank" - } - }, - "object_type": "p24", - "less_common": true - }, - "paynow": { - "name": "paynow", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epaynow\u003C/code\u003E PaymentMethod, this hash contains details about the PayNow payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "paynow", - "less_common": true - }, - "pix": { - "name": "pix", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epix\u003C/code\u003E PaymentMethod, this hash contains details about the Pix payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "pix", - "less_common": true - }, - "promptpay": { - "name": "promptpay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Epromptpay\u003C/code\u003E PaymentMethod, this hash contains details about the PromptPay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "promptpay", - "less_common": true - }, - "radar_options": { - "name": "radar_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Options to configure Radar. See [Radar Session](/docs/radar/radar-session) for more information.", - "undocumented": false, - "html": "Options to configure Radar. See \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E for more information." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "session": { - "name": "session", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A [Radar Session](/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", - "undocumented": false, - "html": "A \u003Ca href=\"/docs/radar/radar-session\"\u003ERadar Session\u003C/a\u003E is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "session" - } - }, - "object_type": "radar_options", - "less_common": true - }, - "sepa_debit": { - "name": "sepa_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esepa_debit\u003C/code\u003E PaymentMethod, this hash contains details about the SEPA debit bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "bank_code": { - "name": "bank_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank code of bank associated with the bank account.", - "undocumented": false, - "html": "Bank code of bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_code" - }, - "branch_code": { - "name": "branch_code", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Branch code of bank associated with the bank account.", - "undocumented": false, - "html": "Branch code of bank associated with the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "branch_code" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter ISO code representing the country the bank account is located in.", - "undocumented": false, - "html": "Two-letter ISO code representing the country the bank account is located in." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "generated_from": { - "name": "generated_from", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Information about the object that generated this PaymentMethod.", - "undocumented": false, - "html": "Information about the object that generated this PaymentMethod." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "charge": { - "name": "charge", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Charge that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the Charge that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["charge"], - "object_type": "charge" - }, - "setup_attempt": { - "name": "setup_attempt", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", - "undocumented": false, - "html": "The ID of the SetupAttempt that generated this PaymentMethod, if any." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["setup_attempt"], - "object_type": "setup_attempt" - } - }, - "object_type": "generated_from" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four characters of the IBAN.", - "undocumented": false, - "html": "Last four characters of the IBAN." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - } - }, - "object_type": "sepa_debit", - "less_common": true - }, - "sofort": { - "name": "sofort", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", - "undocumented": false, - "html": "If this is a \u003Ccode\u003Esofort\u003C/code\u003E PaymentMethod, this hash contains details about the SOFORT payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter ISO code representing the country the bank account is located in.", - "undocumented": false, - "html": "Two-letter ISO code representing the country the bank account is located in." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - } - }, - "object_type": "sofort", - "less_common": true - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "acss_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Pre-authorized debit payments](/docs/payments/acss-debit) are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/acss-debit\"\u003EPre-authorized debit payments\u003C/a\u003E are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS)." - } - }, - "affirm": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Affirm](/docs/payments/affirm) is a buy now, pay later payment method in the US.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/affirm\"\u003EAffirm\u003C/a\u003E is a buy now, pay later payment method in the US." - } - }, - "afterpay_clearpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Afterpay / Clearpay](/docs/payments/afterpay-clearpay) is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/afterpay-clearpay\"\u003EAfterpay / Clearpay\u003C/a\u003E is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US." - } - }, - "alipay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Alipay](/docs/payments/alipay) is a digital wallet payment method used in China.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/alipay\"\u003EAlipay\u003C/a\u003E is a digital wallet payment method used in China." - } - }, - "au_becs_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[BECS Direct Debit](/docs/payments/au-becs-debit) is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/au-becs-debit\"\u003EBECS Direct Debit\u003C/a\u003E is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS)." - } - }, - "bacs_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Bacs Direct Debit](/docs/payments/payment-methods/bacs-debit) is used to debit UK bank accounts.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/payment-methods/bacs-debit\"\u003EBacs Direct Debit\u003C/a\u003E is used to debit UK bank accounts." - } - }, - "bancontact": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Bancontact](/docs/payments/bancontact) is a bank redirect payment method used in Belgium.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/bancontact\"\u003EBancontact\u003C/a\u003E is a bank redirect payment method used in Belgium." - } - }, - "blik": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[BLIK](/docs/payments/blik) is a single-use payment method common in Poland.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/blik\"\u003EBLIK\u003C/a\u003E is a single-use payment method common in Poland." - } - }, - "boleto": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Boleto](/docs/payments/boleto) is a voucher-based payment method used in Brazil.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/boleto\"\u003EBoleto\u003C/a\u003E is a voucher-based payment method used in Brazil." - } - }, - "card": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Card payments](/docs/payments/payment-methods/overview#cards) are supported through many networks and card brands.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/payment-methods/overview#cards\"\u003ECard payments\u003C/a\u003E are supported through many networks and card brands." - } - }, - "card_present": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Stripe Terminal](/docs/terminal/payments/collect-payment) is used to collect in-person card payments.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E is used to collect in-person card payments." - } - }, - "customer_balance": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uses a customer’s [cash balance](/docs/payments/customer-balance) for the payment.", - "undocumented": false, - "html": "Uses a customer’s \u003Ca href=\"/docs/payments/customer-balance\"\u003Ecash balance\u003C/a\u003E for the payment." - } - }, - "eps": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[EPS](/docs/payments/eps) is an Austria-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/eps\"\u003EEPS\u003C/a\u003E is an Austria-based bank redirect payment method." - } - }, - "fpx": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[FPX](/docs/payments/fpx) is a Malaysia-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/fpx\"\u003EFPX\u003C/a\u003E is a Malaysia-based bank redirect payment method." - } - }, - "giropay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[giropay](/docs/payments/giropay) is a German bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/giropay\"\u003Egiropay\u003C/a\u003E is a German bank redirect payment method." - } - }, - "grabpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[GrabPay](/docs/payments/grabpay) is a digital wallet payment method used in Southeast Asia.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/grabpay\"\u003EGrabPay\u003C/a\u003E is a digital wallet payment method used in Southeast Asia." - } - }, - "ideal": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[iDEAL](/docs/payments/ideal) is a Netherlands-based bank redirect payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/ideal\"\u003EiDEAL\u003C/a\u003E is a Netherlands-based bank redirect payment method." - } - }, - "interac_present": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Stripe Terminal](/docs/terminal/payments/collect-payment) accepts [Interac](/docs/terminal/payments/regional?integration-country=CA#interac-payments) debit cards for in-person payments in Canada.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/terminal/payments/collect-payment\"\u003EStripe Terminal\u003C/a\u003E accepts \u003Ca href=\"/docs/terminal/payments/regional?integration-country=CA#interac-payments\"\u003EInterac\u003C/a\u003E debit cards for in-person payments in Canada." - } - }, - "klarna": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Klarna](/docs/payments/klarna) is a global buy now, pay later payment method.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/klarna\"\u003EKlarna\u003C/a\u003E is a global buy now, pay later payment method." - } - }, - "konbini": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Konbini](/docs/payments/konbini) is a cash-based voucher payment method used in Japan.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/konbini\"\u003EKonbini\u003C/a\u003E is a cash-based voucher payment method used in Japan." - } - }, - "link": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Link](/docs/payments/link) allows customers to pay with their saved payment details.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/link\"\u003ELink\u003C/a\u003E allows customers to pay with their saved payment details." - } - }, - "oxxo": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[OXXO](/docs/payments/oxxo) is a cash-based voucher payment method used in Mexico.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/oxxo\"\u003EOXXO\u003C/a\u003E is a cash-based voucher payment method used in Mexico." - } - }, - "p24": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Przelewy24](/docs/payments/p24) is a bank redirect payment method used in Poland.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/p24\"\u003EPrzelewy24\u003C/a\u003E is a bank redirect payment method used in Poland." - } - }, - "paynow": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[PayNow](/docs/payments/paynow) is a QR code payment method used in Singapore.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/paynow\"\u003EPayNow\u003C/a\u003E is a QR code payment method used in Singapore." - } - }, - "pix": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Pix](/docs/payments/pix) is an instant bank transfer payment method in Brazil.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/pix\"\u003EPix\u003C/a\u003E is an instant bank transfer payment method in Brazil." - } - }, - "promptpay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[PromptPay](/docs/payments/promptpay) is an instant funds transfer service popular in Thailand.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/promptpay\"\u003EPromptPay\u003C/a\u003E is an instant funds transfer service popular in Thailand." - } - }, - "sepa_debit": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[SEPA Direct Debit](/docs/payments/sepa-debit) is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/sepa-debit\"\u003ESEPA Direct Debit\u003C/a\u003E is used to debit bank accounts within the Single Euro Payments Area (SEPA) region." - } - }, - "sofort": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Sofort](/docs/payments/sofort) is a bank redirect payment method used in Europe.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/sofort\"\u003ESofort\u003C/a\u003E is a bank redirect payment method used in Europe." - } - }, - "us_bank_account": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[ACH Direct Debit](/docs/payments/ach-debit) is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/ach-debit\"\u003EACH Direct Debit\u003C/a\u003E is used to debit US bank accounts through the Automated Clearing House (ACH) payments system." - } - }, - "wechat_pay": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[WeChat Pay](/docs/payments/wechat-pay) is a digital wallet payment method based in China.", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/wechat-pay\"\u003EWeChat Pay\u003C/a\u003E is a digital wallet payment method based in China." - } - } - }, - "object_type": "type" - }, - "us_bank_account": { - "name": "us_bank_account", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Eus_bank_account\u003C/code\u003E PaymentMethod, this hash contains details about the US bank account payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "account_holder_type": { - "name": "account_holder_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account holder type: individual or company.", - "undocumented": false, - "html": "Account holder type: individual or company." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "individual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account belongs to an individual", - "undocumented": false, - "html": "Account belongs to an individual" - } - }, - "company": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account belongs to a company", - "undocumented": false, - "html": "Account belongs to a company" - } - } - }, - "object_type": "account_holder_type" - }, - "account_type": { - "name": "account_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Account type: checkings or savings. Defaults to checking if omitted.", - "undocumented": false, - "html": "Account type: checkings or savings. Defaults to checking if omitted." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "checking": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account type is checking", - "undocumented": false, - "html": "Bank account type is checking" - } - }, - "savings": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account type is savings", - "undocumented": false, - "html": "Bank account type is savings" - } - } - }, - "object_type": "account_type" - }, - "bank_name": { - "name": "bank_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The name of the bank.", - "undocumented": false, - "html": "The name of the bank." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "bank_name" - }, - "financial_connections_account": { - "name": "financial_connections_account", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Financial Connections Account used to create the payment method.", - "undocumented": false, - "html": "The ID of the Financial Connections Account used to create the payment method." - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "financial_connections_account" - }, - "fingerprint": { - "name": "fingerprint", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", - "undocumented": false, - "html": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "fingerprint" - }, - "last4": { - "name": "last4", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Last four digits of the bank account number.", - "undocumented": false, - "html": "Last four digits of the bank account number." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "last4" - }, - "networks": { - "name": "networks", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains information about US bank account networks that can be used.", - "undocumented": false, - "html": "Contains information about US bank account networks that can be used." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "preferred": { - "name": "preferred", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The preferred network.", - "undocumented": false, - "html": "The preferred network." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preferred" - }, - "supported": { - "name": "supported", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "All supported networks.", - "undocumented": false, - "html": "All supported networks." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported" - } - }, - "object_type": "networks" - }, - "routing_number": { - "name": "routing_number", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Routing number of the bank account.", - "undocumented": false, - "html": "Routing number of the bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "routing_number" - } - }, - "object_type": "us_bank_account", - "less_common": true - }, - "wechat_pay": { - "name": "wechat_pay", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", - "undocumented": false, - "html": "If this is an \u003Ccode\u003Ewechat_pay\u003C/code\u003E PaymentMethod, this hash contains details about the wechat_pay payment method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "wechat_pay", - "less_common": true - } - }, - "object_type": "payment_method", - "less_common": true - }, - "payment_method_type": { - "name": "payment_method_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "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." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_method_type", - "less_common": true - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`", - "undocumented": false, - "html": "The type of error returned. One of \u003Ccode\u003Eapi_error\u003C/code\u003E, \u003Ccode\u003Ecard_error\u003C/code\u003E, \u003Ccode\u003Eidempotency_error\u003C/code\u003E, or \u003Ccode\u003Einvalid_request_error\u003C/code\u003E" - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - } - }, - "object_type": "last_setup_error" - }, - "latest_attempt": { - "name": "latest_attempt", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The most recent SetupAttempt for this SetupIntent.", - "undocumented": false, - "html": "The most recent SetupAttempt for this SetupIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["setup_attempt"], - "object_type": "latest_attempt", - "less_common": true - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "mandate": { - "name": "mandate", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the multi use Mandate generated by the SetupIntent.", - "undocumented": false, - "html": "ID of the multi use Mandate generated by the SetupIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["mandate"], - "object_type": "mandate", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "next_action": { - "name": "next_action", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup.", - "undocumented": false, - "html": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "redirect_to_url": { - "name": "redirect_to_url", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains instructions for authenticating a payment by redirecting your customer to another page or application.", - "undocumented": false, - "html": "Contains instructions for authenticating a payment by redirecting your customer to another page or application." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "return_url": { - "name": "return_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", - "undocumented": false, - "html": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "return_url" - }, - "url": { - "name": "url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL you must redirect your customer to in order to authenticate.", - "undocumented": false, - "html": "The URL you must redirect your customer to in order to authenticate." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "url" - } - }, - "object_type": "redirect_to_url" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.", - "undocumented": false, - "html": "Type of the next action to perform, one of \u003Ccode\u003Eredirect_to_url\u003C/code\u003E, \u003Ccode\u003Euse_stripe_sdk\u003C/code\u003E, \u003Ccode\u003Ealipay_handle_redirect\u003C/code\u003E, \u003Ccode\u003Eoxxo_display_details\u003C/code\u003E, or \u003Ccode\u003Everify_with_microdeposits\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - }, - "use_stripe_sdk": { - "name": "use_stripe_sdk", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.", - "undocumented": false, - "html": "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this \u003Ctranslate\u003Edictionary\u003C/translate\u003E to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "use_stripe_sdk" - }, - "verify_with_microdeposits": { - "name": "verify_with_microdeposits", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Contains details describing microdeposits verification flow.", - "undocumented": false, - "html": "Contains details describing microdeposits verification flow." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "arrival_date": { - "name": "arrival_date", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The timestamp when the microdeposits are expected to land.", - "undocumented": false, - "html": "The timestamp when the microdeposits are expected to land." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "arrival_date" - }, - "hosted_verification_url": { - "name": "hosted_verification_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL for the hosted verification page, which allows customers to verify their bank account.", - "undocumented": false, - "html": "The URL for the hosted verification page, which allows customers to verify their bank account." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "hosted_verification_url" - }, - "microdeposit_type": { - "name": "microdeposit_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.", - "undocumented": false, - "html": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "descriptor_code": { "documentation": null }, - "amounts": { "documentation": null } - }, - "object_type": "microdeposit_type" - } - }, - "object_type": "verify_with_microdeposits" - } - }, - "object_type": "next_action" - }, - "on_behalf_of": { - "name": "on_behalf_of", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account (if any) for which the setup is intended.", - "undocumented": false, - "html": "The account (if any) for which the setup is intended." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["account"], - "object_type": "on_behalf_of", - "less_common": true - }, - "payment_method": { - "name": "payment_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the payment method used with this SetupIntent.", - "undocumented": false, - "html": "ID of the payment method used with this SetupIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["payment_method"], - "object_type": "payment_method" - }, - "payment_method_options": { - "name": "payment_method_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payment-method-specific configuration for this SetupIntent.", - "undocumented": false, - "html": "Payment-method-specific configuration for this SetupIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "acss_debit": { - "name": "acss_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the SetupIntent's payment_method_types includes `acss_debit`, this hash contains the configurations that will be applied to each setup attempt of that type.\n", - "undocumented": false, - "html": "If the SetupIntent’s payment_method_types includes \u003Ccode\u003Eacss_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "currency": { - "name": "currency", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Currency supported by the bank account", - "undocumented": false, - "html": "Currency supported by the bank account" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "cad": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Canadian dollars", - "undocumented": false, - "html": "Canadian dollars" - } - }, - "usd": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "US dollars", - "undocumented": false, - "html": "US dollars" - } - } - }, - "object_type": "currency" - }, - "mandate_options": { - "name": "mandate_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Additional fields for Mandate creation", - "undocumented": false, - "html": "Additional fields for Mandate creation" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "custom_mandate_url": { - "name": "custom_mandate_url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A URL for custom mandate text", - "undocumented": false, - "html": "A URL for custom mandate text" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "custom_mandate_url" - }, - "default_for": { - "name": "default_for", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "List of Stripe products where this mandate can be selected automatically.", - "undocumented": false, - "html": "List of Stripe products where this mandate can be selected automatically." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "invoice": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Enables payments for Stripe Invoices. 'subscription' must also be provided.", - "undocumented": false, - "html": "Enables payments for Stripe Invoices. ‘subscription’ must also be provided." - } - }, - "subscription": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Enables payments for Stripe Subscriptions. 'invoice' must also be provided.", - "undocumented": false, - "html": "Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided." - } - } - }, - "object_type": "default_for" - }, - "interval_description": { - "name": "interval_description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", - "undocumented": false, - "html": "Description of the interval. Only required if the ‘payment_schedule’ parameter is ‘interval’ or ‘combined’." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval_description" - }, - "payment_schedule": { - "name": "payment_schedule", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payment schedule for the mandate.", - "undocumented": false, - "html": "Payment schedule for the mandate." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "interval": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments are initiated at a regular pre-defined interval", - "undocumented": false, - "html": "Payments are initiated at a regular pre-defined interval" - } - }, - "sporadic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments are initiated sporadically", - "undocumented": false, - "html": "Payments are initiated sporadically" - } - }, - "combined": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments can be initiated at a pre-defined interval or sporadically", - "undocumented": false, - "html": "Payments can be initiated at a pre-defined interval or sporadically" - } - } - }, - "object_type": "payment_schedule" - }, - "transaction_type": { - "name": "transaction_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transaction type of the mandate.", - "undocumented": false, - "html": "Transaction type of the mandate." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "personal": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transactions are made for personal reasons", - "undocumented": false, - "html": "Transactions are made for personal reasons" - } - }, - "business": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Transactions are made for business reasons", - "undocumented": false, - "html": "Transactions are made for business reasons" - } - } - }, - "object_type": "transaction_type" - } - }, - "object_type": "mandate_options" - }, - "verification_method": { - "name": "verification_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account verification method.", - "undocumented": false, - "html": "Bank account verification method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification with fallback to microdeposits.", - "undocumented": false, - "html": "Instant verification with fallback to microdeposits." - } - }, - "instant": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification.", - "undocumented": false, - "html": "Instant verification." - } - }, - "microdeposits": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Verification using microdeposits.", - "undocumented": false, - "html": "Verification using microdeposits." - } - } - }, - "object_type": "verification_method" - } - }, - "object_type": "acss_debit" - }, - "blik": { - "name": "blik", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the SetupIntent's payment_method_types includes `blik`, this hash contains the configurations that will be applied to each setup attempt of that type.\n", - "undocumented": false, - "html": "If the SetupIntent’s payment_method_types includes \u003Ccode\u003Eblik\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "mandate_options": { - "name": "mandate_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Details of the reusable mandate.", - "undocumented": false, - "html": "Details of the reusable mandate." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "expires_after": { - "name": "expires_after", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Date at which the mandate expires.", - "undocumented": false, - "html": "Date at which the mandate expires." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "expires_after" - }, - "off_session": { - "name": "off_session", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Details for off-session mandates.", - "undocumented": false, - "html": "Details for off-session mandates." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount": { - "name": "amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount of each recurring payment.", - "undocumented": false, - "html": "Amount of each recurring payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "currency": { - "name": "currency", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Currency of each recurring payment.", - "undocumented": false, - "html": "Currency of each recurring payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "currency" - }, - "interval": { - "name": "interval", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Frequency interval of each recurring payment.", - "undocumented": false, - "html": "Frequency interval of each recurring payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "day": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments recur every day.", - "undocumented": false, - "html": "Payments recur every day." - } - }, - "week": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments recur every week.", - "undocumented": false, - "html": "Payments recur every week." - } - }, - "month": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments recur every month.", - "undocumented": false, - "html": "Payments recur every month." - } - }, - "year": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Payments recur every year.", - "undocumented": false, - "html": "Payments recur every year." - } - } - }, - "object_type": "interval" - }, - "interval_count": { - "name": "interval_count", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Frequency indicator of each recurring payment.", - "undocumented": false, - "html": "Frequency indicator of each recurring payment." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval_count" - } - }, - "object_type": "off_session" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Type of the mandate.", - "undocumented": false, - "html": "Type of the mandate." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Mandate for on-session payments.", - "undocumented": false, - "html": "Mandate for on-session payments." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Mandate for off-session payments.", - "undocumented": false, - "html": "Mandate for off-session payments." - } - } - }, - "object_type": "type" - } - }, - "object_type": "mandate_options" - } - }, - "object_type": "blik" - }, - "card": { - "name": "card", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the SetupIntent's payment_method_types includes `card`, this hash contains the configurations that will be applied to each setup attempt of that type.\n", - "undocumented": false, - "html": "If the SetupIntent’s payment_method_types includes \u003Ccode\u003Ecard\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "mandate_options": { - "name": "mandate_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration options for setting up an eMandate for cards issued in India.", - "undocumented": false, - "html": "Configuration options for setting up an eMandate for cards issued in India." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount": { - "name": "amount", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount to be charged for future payments.", - "undocumented": false, - "html": "Amount to be charged for future payments." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "amount_type": { - "name": "amount_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.\n", - "undocumented": false, - "html": "One of \u003Ccode\u003Efixed\u003C/code\u003E or \u003Ccode\u003Emaximum\u003C/code\u003E. If \u003Ccode\u003Efixed\u003C/code\u003E, the \u003Ccode\u003Eamount\u003C/code\u003E param refers to the exact amount to be charged in future payments. If \u003Ccode\u003Emaximum\u003C/code\u003E, the amount charged can be up to the value passed for the \u003Ccode\u003Eamount\u003C/code\u003E param." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_type" - }, - "currency": { - "name": "currency", - "check": "currency", - "validation": "currency", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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).", - "undocumented": false, - "html": "Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "currency" - }, - "description": { - "name": "description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A description of the mandate or subscription that is meant to be displayed to the customer.", - "undocumented": false, - "html": "A description of the mandate or subscription that is meant to be displayed to the customer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "description" - }, - "end_date": { - "name": "end_date", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.\n", - "undocumented": false, - "html": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "end_date" - }, - "interval": { - "name": "interval", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.\n", - "undocumented": false, - "html": "Specifies payment frequency. One of \u003Ccode\u003Eday\u003C/code\u003E, \u003Ccode\u003Eweek\u003C/code\u003E, \u003Ccode\u003Emonth\u003C/code\u003E, \u003Ccode\u003Eyear\u003C/code\u003E, or \u003Ccode\u003Esporadic\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval" - }, - "interval_count": { - "name": "interval_count", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.\n", - "undocumented": false, - "html": "The number of intervals between payments. For example, \u003Ccode\u003Einterval=month\u003C/code\u003E and \u003Ccode\u003Einterval_count=3\u003C/code\u003E indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when \u003Ccode\u003Einterval=sporadic\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval_count" - }, - "reference": { - "name": "reference", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the mandate or subscription.", - "undocumented": false, - "html": "Unique identifier for the mandate or subscription." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "reference" - }, - "start_date": { - "name": "start_date", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.\n", - "undocumented": false, - "html": "Start date of the mandate or subscription. Start date should not be lesser than yesterday." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "start_date" - }, - "supported_types": { - "name": "supported_types", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Specifies the type of mandates supported. Possible values are `india`.\n", - "undocumented": false, - "html": "Specifies the type of mandates supported. Possible values are \u003Ccode\u003Eindia\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "supported_types" - } - }, - "object_type": "mandate_options" - }, - "network": { - "name": "network", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.", - "undocumented": false, - "html": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "network" - }, - "request_three_d_secure": { - "name": "request_three_d_secure", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](/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](/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", - "undocumented": false, - "html": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and \u003Ca href=\"/docs/strong-customer-authentication\"\u003Eother requirements\u003C/a\u003E. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: \u003Ccode\u003Eautomatic\u003C/code\u003E or \u003Ccode\u003Eany\u003C/code\u003E. If not provided, defaults to \u003Ccode\u003Eautomatic\u003C/code\u003E. Read our guide on \u003Ca href=\"/docs/payments/3d-secure#manual-three-ds\"\u003Emanually requesting 3D Secure\u003C/a\u003E for more information on how this configuration interacts with Radar and our SCA Engine." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "advanced", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "request_three_d_secure" - } - }, - "object_type": "card" - }, - "link": { - "name": "link", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the SetupIntent's payment_method_types includes `link`, this hash contains the configurations that will be applied to each setup attempt of that type.\n", - "undocumented": false, - "html": "If the SetupIntent’s payment_method_types includes \u003Ccode\u003Elink\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "persistent_token": { - "name": "persistent_token", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Token used for persistent Link logins.", - "undocumented": false, - "html": "Token used for persistent Link logins." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "persistent_token" - } - }, - "object_type": "link" - }, - "sepa_debit": { - "name": "sepa_debit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the SetupIntent's payment_method_types includes `sepa_debit`, this hash contains the configurations that will be applied to each setup attempt of that type.\n", - "undocumented": false, - "html": "If the SetupIntent’s payment_method_types includes \u003Ccode\u003Esepa_debit\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "mandate_options": { - "name": "mandate_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Additional fields for Mandate creation", - "undocumented": false, - "html": "Additional fields for Mandate creation" - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": {}, - "object_type": "mandate_options" - } - }, - "object_type": "sepa_debit" - }, - "us_bank_account": { - "name": "us_bank_account", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If the SetupIntent's payment_method_types includes `us_bank_account`, this hash contains the configurations that will be applied to each setup attempt of that type.\n", - "undocumented": false, - "html": "If the SetupIntent’s payment_method_types includes \u003Ccode\u003Eus_bank_account\u003C/code\u003E, this hash contains the configurations that will be applied to each setup attempt of that type." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "financial_connections": { - "name": "financial_connections", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Additional fields for Financial Connections Session creation", - "undocumented": false, - "html": "Additional fields for Financial Connections Session creation" - }, - "gate": true, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "permissions": { - "name": "permissions", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The list of permissions to request. The `payment_method` permission must be included.", - "undocumented": false, - "html": "The list of permissions to request. The \u003Ccode\u003Epayment_method\u003C/code\u003E permission must be included." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "payment_method": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows the creation of a payment method from the account.", - "undocumented": false, - "html": "Allows the creation of a payment method from the account." - } - }, - "balances": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows accessing balance data from the account.", - "undocumented": false, - "html": "Allows accessing balance data from the account." - } - }, - "transactions": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows accessing transactions data from the account.", - "undocumented": false, - "html": "Allows accessing transactions data from the account." - } - }, - "ownership": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Allows accessing ownership data from the account.", - "undocumented": false, - "html": "Allows accessing ownership data from the account." - } - } - }, - "object_type": "permissions" - } - }, - "object_type": "financial_connections" - }, - "verification_method": { - "name": "verification_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Bank account verification method.", - "undocumented": false, - "html": "Bank account verification method." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification with fallback to microdeposits.", - "undocumented": false, - "html": "Instant verification with fallback to microdeposits." - } - }, - "instant": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Instant verification only.", - "undocumented": false, - "html": "Instant verification only." - } - }, - "microdeposits": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices.", - "undocumented": false, - "html": "Verification using microdeposits. Cannot be used with Stripe Checkout or Hosted Invoices." - } - } - }, - "object_type": "verification_method" - } - }, - "object_type": "us_bank_account" - } - }, - "object_type": "payment_method_options", - "less_common": true - }, - "payment_method_types": { - "name": "payment_method_types", - "check": "string_array", - "validation": "array containing strings", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.", - "undocumented": false, - "html": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "payment_method_types" - }, - "single_use_mandate": { - "name": "single_use_mandate", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "ID of the single_use Mandate generated by the SetupIntent.", - "undocumented": false, - "html": "ID of the single_use Mandate generated by the SetupIntent." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["mandate"], - "object_type": "single_use_mandate", - "less_common": true - }, - "status": { - "name": "status", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[Status](/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. ", - "undocumented": false, - "html": "\u003Ca href=\"/docs/payments/intents#intent-statuses\"\u003EStatus\u003C/a\u003E of this SetupIntent, one of \u003Ccode\u003Erequires_payment_method\u003C/code\u003E, \u003Ccode\u003Erequires_confirmation\u003C/code\u003E, \u003Ccode\u003Erequires_action\u003C/code\u003E, \u003Ccode\u003Eprocessing\u003C/code\u003E, \u003Ccode\u003Ecanceled\u003C/code\u003E, or \u003Ccode\u003Esucceeded\u003C/code\u003E. " - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "status" - }, - "usage": { - "name": "usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`.\n", - "undocumented": false, - "html": "Indicates how the payment method is intended to be used in the future.\u003C/p\u003E\n\n\u003Cp\u003EUse \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when the customer is in your checkout flow. Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be in your checkout flow. If not provided, this value defaults to \u003Ccode\u003Eoff_session\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": "retrievable with publishable key", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "usage" - } - } - }, - "source": { - "name": "source", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The source object for errors returned on a request involving a source.", - "undocumented": false, - "html": "The source object for errors returned on a request involving a source." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "source", - "less_common": true - } - }, - "status_codes": { - "200 - OK": "Everything worked as expected.", - "400 - Bad Request": "The request was unacceptable, often due to missing a required\n parameter.", - "401 - Unauthorized": "No valid API key provided.", - "402 - Request Failed": "The parameters were valid but the request failed.", - "403 - Forbidden": "The API key doesn't have permissions to perform the request.", - "404 - Not Found": "The requested resource doesn't exist.", - "409 - Conflict": "The request conflicts with another request (perhaps due to\n using the same idempotent key).", - "429 - Too Many Requests": "Too many requests hit the API too quickly. We recommend an\n exponential backoff of your requests.", - "500, 502, 503, 504 - Server Errors": "Something went wrong on Stripe's end. (These are rare.)" - }, - "error_types": { - "api_error": "API errors cover any other type of problem (e.g., a temporary\n problem with Stripe's servers), and are extremely\n uncommon.", - "card_error": "Card errors are the most common type of error you should\n expect to handle. They result when the user enters a card that\n can't be charged for some reason.", - "idempotency_error": "Idempotency errors occur when an `Idempotency-Key`\n is re-used on a request that does not match the first request's\n API endpoint and parameters.", - "invalid_request_error": "Invalid request errors arise when your request has invalid\n parameters." - }, - "section_type": "override", - "section_tag": "errors", - "version": null - } - }, - "error_handling": { - "title": "Handling errors", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "error_handling", - "section_anchor": "errors", - "subsection_anchors": null, - "path": "/errors/handling", - "gate": false, - "display_on_load": true, - "data": { - "catching_errors": "# Select a client library to see examples of handling different kinds of errors.", - "section_type": "override", - "section_tag": "error_handling", - "version": null - } - }, - "expanding_objects": { - "title": "Expanding Responses", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "expanding_objects", - "section_anchor": "expanding_objects", - "subsection_anchors": [], - "path": "/expanding_objects", - "gate": false, - "display_on_load": true, - "data": { - "request": "curl https://api.stripe.com/v1/charges/ch_3MWb7X2eZvKYlo2C1KB2kTo6 \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -d \"expand[]\"=customer \\\n -d \"expand[]\"=\"invoice.subscription\" \\\n -G \n", - "response": "{\n \"id\": \"ch_3MWb7X2eZvKYlo2C1KB2kTo6\",\n \"object\": \"charge\",\n \"customer\": {\n \"id\": \"cu_14HOtK2eZvKYlo2CPM0hlYU6\",\n \"object\": \"customer\",\n ...\n },\n \"invoice\": {\n \"id\": \"in_1MWb7X2eZvKYlo2CyCNOr7gc\",\n \"object\": \"invoice\",\n \"subscription\": {\n \"id\": \"su_1MWTmm2eZvKYlo2CljDPJAXI\",\n \"object\": \"subscription\",\n ...\n },\n ...\n },\n ...\n}\n", - "section_type": "override", - "section_tag": "expanding_objects", - "version": null - } - }, - "idempotent_requests": { - "title": "Idempotent Requests", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "idempotent_requests", - "section_anchor": "idempotent_requests", - "subsection_anchors": [], - "path": "/idempotent_requests", - "gate": false, - "display_on_load": true, - "data": { - "request": "curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -H \"Idempotency-Key: CT8tudz1NP1rlrBL\" \\\n -d amount=2000 \\\n -d currency=usd \\\n -d description=\"My First Test Charge (created for API docs at https://www.stripe.com/docs/api)\" \\\n -d source=tok_amex\n", - "section_type": "override", - "section_tag": "idempotent_requests", - "version": null - } - }, - "metadata": { - "title": "Metadata", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "metadata", - "section_anchor": "metadata", - "subsection_anchors": [], - "path": "/metadata", - "gate": false, - "display_on_load": true, - "data": { - "max_metadata_hash_length": 50, - "max_metadata_key_length": 40, - "max_metadata_val_length": 500, - "request": "curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -d amount=2000 \\\n -d currency=usd \\\n -d source=tok_mastercard \\\n -d \"metadata[order_id]\"=6735\n", - "response": "{\n \"id\": \"ch_3MWb7X2eZvKYlo2C1KB2kTo6\",\n \"object\": \"charge\",\n \"amount\": 100,\n \"amount_captured\": 0,\n \"amount_refunded\": 0,\n \"application\": null,\n \"application_fee\": null,\n \"application_fee_amount\": null,\n \"balance_transaction\": \"txn_1032HU2eZvKYlo2CEPtcnUvl\",\n \"billing_details\": {\n \"address\": {\n \"city\": null,\n \"country\": null,\n \"line1\": null,\n \"line2\": null,\n \"postal_code\": null,\n \"state\": null\n },\n \"email\": null,\n \"name\": \"Jenny Rosen\",\n \"phone\": null\n },\n \"calculated_statement_descriptor\": null,\n \"captured\": false,\n \"created\": 1675237963,\n \"currency\": \"usd\",\n \"customer\": null,\n \"description\": \"My First Test Charge (created for API docs)\",\n \"disputed\": false,\n \"failure_balance_transaction\": null,\n \"failure_code\": null,\n \"failure_message\": null,\n \"fraud_details\": {\n },\n \"invoice\": null,\n \"livemode\": false,\n \"metadata\": {\n \"order_id\": \"6735\"\n },\n \"on_behalf_of\": null,\n \"outcome\": null,\n \"paid\": true,\n \"payment_intent\": null,\n \"payment_method\": \"card_19yUNL2eZvKYlo2CNGsN6EWH\",\n \"payment_method_details\": {\n \"card\": {\n \"brand\": \"visa\",\n \"checks\": {\n \"address_line1_check\": null,\n \"address_postal_code_check\": null,\n \"cvc_check\": \"unchecked\"\n },\n \"country\": \"US\",\n \"exp_month\": 12,\n \"exp_year\": 2020,\n \"fingerprint\": \"Xt5EWLLDS7FJjR1c\",\n \"funding\": \"credit\",\n \"installments\": null,\n \"last4\": \"4242\",\n \"mandate\": null,\n \"moto\": null,\n \"network\": \"visa\",\n \"three_d_secure\": null,\n \"wallet\": null\n },\n \"type\": \"card\"\n },\n \"receipt_email\": null,\n \"receipt_number\": null,\n \"receipt_url\": \"https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKMu06J4GMgZ4ImztWGw6LBYRWL0yYgVbwr5-BuvCWt-87N58fiDJrNN9KIJ_pXcMXf3ZCnM4EgEKjLVd\",\n \"redaction\": null,\n \"refunded\": false,\n \"refunds\": {\n \"object\": \"list\",\n \"data\": [\n\n ],\n \"has_more\": false,\n \"url\": \"/v1/charges/ch_3MWb7X2eZvKYlo2C1KB2kTo6/refunds\"\n },\n \"review\": null,\n \"shipping\": null,\n \"source_transfer\": null,\n \"statement_descriptor\": null,\n \"statement_descriptor_suffix\": null,\n \"status\": \"succeeded\",\n \"transfer_data\": null,\n \"transfer_group\": null\n}", - "section_type": "override", - "section_tag": "metadata", - "version": null - } - }, - "pagination": { - "title": "Pagination", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "pagination", - "section_anchor": "pagination", - "subsection_anchors": ["search_pagination", "auto_pagination"], - "path": "/pagination", - "gate": false, - "display_on_load": true, - "data": { - "example_auto_pagination": "# The auto-pagination feature is specific to Stripe's\n # libraries and cannot be used directly with curl.\n", - "request_data": { - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "action_type": "list", - "action_name": null, - "action_path": null, - "resource_name": "customer", - "parent_resource_name": null, - "namespace": null, - "test_helper": false, - "request_params": { "limit": 3 }, - "url_params": {}, - "overridden_languages": [], - "preamble_comment": null - }, - "response": "{\n \"object\": \"list\",\n \"url\": \"/v1/customers\",\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"cus_4QFOF3xrvBT2nU\",\n \"object\": \"customer\",\n \"address\": null,\n \"balance\": 0,\n \"created\": 1405641986,\n \"currency\": \"usd\",\n \"default_source\": \"card_14HOtJ2eZvKYlo2CD2lt4r4W\",\n \"delinquent\": true,\n \"description\": \"someone@example.com for Coderwall\",\n \"discount\": null,\n \"email\": \"namedaa4a2aa-1ff9-4235-a8a8-3896844a1c54@test.com\",\n \"invoice_prefix\": \"93EC0E1\",\n \"invoice_settings\": {\n \"custom_fields\": null,\n \"default_payment_method\": null,\n \"footer\": null,\n \"rendering_options\": null\n },\n \"livemode\": false,\n \"metadata\": {\n \"CustomerReferenceId\": \"16527612\",\n \"CustomerReferenceType\": \"reedonline\",\n \"tag-key\": \"tag-value\",\n \"meta-key\": \"meta-value\",\n \"order_id\": \"6735\",\n \"order_id_1\": \"6735\"\n },\n \"name\": \"priyal26\",\n \"next_invoice_sequence\": 572508,\n \"phone\": null,\n \"preferred_locales\": [\n \n ],\n \"shipping\": null,\n \"tax_exempt\": \"none\",\n \"test_clock\": null\n },\n {...},\n {...}\n ]\n}\n", - "section_type": "override", - "section_tag": "pagination", - "version": null - } - }, - "search_pagination": { - "title": "Search", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "search_pagination", - "section_anchor": "pagination", - "subsection_anchors": null, - "path": "/pagination/search", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "override", - "title": "Search customers", - "description": "Search for customers you’ve previously created using Stripe’s \u003Ca href=\"/docs/search#search-query-language\"\u003ESearch Query Language\u003C/a\u003E.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.", - "top_level_changes": [], - "changes": {}, - "version": null, - "returns": "A dictionary with a \u003Ccode\u003Edata\u003C/code\u003E property that contains an array of up to \u003Ccode\u003Elimit\u003C/code\u003E customers. If no objects match the\nquery, the resulting array will be empty. See the related guide on \u003Ca href=\"/docs/expand#lists\"\u003Eexpanding properties in lists\u003C/a\u003E.", - "section_tag": "search_pagination", - "specs": { - "query": { - "name": "query", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The search query string. See [search query language](/docs/search#search-query-language) and the list of supported [query fields for customers](/docs/search#query-fields-for-customers).", - "undocumented": false, - "html": "The search query string. See \u003Ca href=\"/docs/search#search-query-language\"\u003Esearch query language\u003C/a\u003E and the list of supported \u003Ca href=\"/docs/search#query-fields-for-customers\"\u003Equery fields for customers\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "query" - }, - "limit": { - "name": "limit", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "undocumented": false, - "html": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "limit" - }, - "page": { - "name": "page", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", - "undocumented": false, - "html": "A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "page" - } - }, - "supported_languages": null, - "action": "method", - "curl_definition": "GET /v1/customers/search", - "request": "curl https://api.stripe.com/v1/customers/search \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n --data-urlencode query=\"name:'fakename' AND metadata['foo']:'bar'\" \\\n -G\n", - "request_data": { - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "action_type": "custom", - "action_name": "search", - "action_path": "search", - "resource_name": "customer", - "parent_resource_name": null, - "namespace": null, - "test_helper": false, - "request_params": { "query": "name:'fakename' AND metadata['foo']:'bar'" }, - "url_params": {}, - "overridden_languages": ["curl", "java", "go"], - "preamble_comment": null - }, - "response": "{\n \"object\": \"search_result\",\n \"url\": \"/v1/customers/search\",\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"cus_4QFOF3xrvBT2nU\",\n \"object\": \"customer\",\n \"address\": null,\n \"balance\": 0,\n \"created\": 1405641986,\n \"currency\": \"usd\",\n \"default_source\": \"card_14HOtJ2eZvKYlo2CD2lt4r4W\",\n \"delinquent\": true,\n \"description\": \"someone@example.com for Coderwall\",\n \"discount\": null,\n \"email\": \"namedaa4a2aa-1ff9-4235-a8a8-3896844a1c54@test.com\",\n \"invoice_prefix\": \"93EC0E1\",\n \"invoice_settings\": {\n \"custom_fields\": null,\n \"default_payment_method\": null,\n \"footer\": null,\n \"rendering_options\": null\n },\n \"livemode\": false,\n \"metadata\": {\n \"foo\": \"bar\"\n },\n \"name\": \"fakename\",\n \"next_invoice_sequence\": 572508,\n \"phone\": null,\n \"preferred_locales\": [\n \n ],\n \"shipping\": null,\n \"tax_exempt\": \"none\",\n \"test_clock\": null\n },\n {...},\n {...}\n ]\n}\n" - } - }, - "auto_pagination": { - "title": "Auto-pagination", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "auto_pagination", - "section_anchor": "pagination", - "subsection_anchors": null, - "path": "/pagination/auto", - "gate": false, - "display_on_load": true, - "data": { - "request": "# The auto-pagination feature is specific to Stripe's\n # libraries and cannot be used directly with curl.\n", - "section_type": "override", - "section_tag": "auto_pagination", - "version": null - } - }, - "request_ids": { - "title": "Request IDs", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "request_ids", - "section_anchor": "request_ids", - "subsection_anchors": [], - "path": "/request_ids", - "gate": false, - "display_on_load": true, - "data": { - "request": "curl https://api.stripe.com/v1/customers \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -D \"-\" \\\n -X POST\n", - "section_type": "override", - "section_tag": "request_ids", - "version": null - } - }, - "versioning": { - "title": "Versioning", - "group_title": "Topics", - "group_anchor": "topics", - "anchor": "versioning", - "section_anchor": "versioning", - "subsection_anchors": [], - "path": "/versioning", - "gate": false, - "display_on_load": true, - "data": { - "current_version": "2022-11-15", - "example_version_on_request": "", - "merchant": false, - "request": "curl https://api.stripe.com/v1/charges \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \\\n -H \"Stripe-Version: 2022-11-15\"\n", - "section_type": "override", - "section_tag": "versioning", - "version": null - } - }, - "balance": { - "title": "Balance", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "balance", - "section_anchor": "balance", - "subsection_anchors": ["balance_object", "retrieve_balance"], - "path": "/balance", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Balance", - "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect Account Balances](/docs/connect/account-balances).\n", - "section_tag": "balance", - "subsection_summaries": [ - { "anchor": "balance_object", "curl_definition": null }, - { "anchor": "retrieve_balance", "curl_definition": "GET /v1/balance" } - ] - } - }, - "balance_object": { - "title": "The balance object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "balance_object", - "section_anchor": "balance", - "subsection_anchors": null, - "path": "/balance/balance_object", - "gate": false, - "display_on_load": false - }, - "retrieve_balance": { - "title": "Retrieve balance", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_balance", - "section_anchor": "balance", - "subsection_anchors": null, - "path": "/balance/balance_retrieve", - "gate": false, - "display_on_load": false - }, - "balance_transactions": { - "title": "Balance Transactions", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "balance_transactions", - "section_anchor": "balance_transactions", - "subsection_anchors": [ - "balance_transaction_object", - "balance_transaction_retrieve", - "balance_transaction_list" - ], - "path": "/balance_transactions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Balance Transactions", - "description": "Balance transactions represent funds moving through your Stripe account.\nThey're created for every type of transaction that comes into or flows out of your Stripe account balance.\n\nRelated guide: [Balance Transaction Types](/docs/reports/balance-transaction-types).\n", - "section_tag": "balance_transactions", - "subsection_summaries": [ - { "anchor": "balance_transaction_object", "curl_definition": null }, - { - "anchor": "balance_transaction_retrieve", - "curl_definition": "GET /v1/balance_transactions/:id" - }, - { "anchor": "balance_transaction_list", "curl_definition": "GET /v1/balance_transactions" } - ] - } - }, - "balance_transaction_object": { - "title": "The balance transaction object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "balance_transaction_object", - "section_anchor": "balance_transactions", - "subsection_anchors": null, - "path": "/balance_transactions/object", - "gate": false, - "display_on_load": false - }, - "balance_transaction_retrieve": { - "title": "Retrieve a balance transaction", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "balance_transaction_retrieve", - "section_anchor": "balance_transactions", - "subsection_anchors": null, - "path": "/balance_transactions/retrieve", - "gate": false, - "display_on_load": false - }, - "balance_transaction_list": { - "title": "List all balance transactions", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "balance_transaction_list", - "section_anchor": "balance_transactions", - "subsection_anchors": null, - "path": "/balance_transactions/list", - "gate": false, - "display_on_load": false - }, - "charges": { - "title": "Charges", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "charges", - "section_anchor": "charges", - "subsection_anchors": [ - "charge_object", - "create_charge", - "retrieve_charge", - "update_charge", - "capture_charge", - "list_charges", - "search_charges" - ], - "path": "/charges", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Charges", - "description": "To charge a credit or a debit card, you create a `Charge` object. You can\nretrieve and refund individual charges as well as list all charges. Charges\nare identified by a unique, random ID.\n\nRelated guide: [Accept a payment with the Charges API](/docs/payments/accept-a-payment-charges).\n", - "section_tag": "charges", - "subsection_summaries": [ - { "anchor": "charge_object", "curl_definition": null }, - { "anchor": "create_charge", "curl_definition": "POST /v1/charges" }, - { "anchor": "retrieve_charge", "curl_definition": "GET /v1/charges/:id" }, - { "anchor": "update_charge", "curl_definition": "POST /v1/charges/:id" }, - { "anchor": "capture_charge", "curl_definition": "POST /v1/charges/:id/capture" }, - { "anchor": "list_charges", "curl_definition": "GET /v1/charges" }, - { "anchor": "search_charges", "curl_definition": "GET /v1/charges/search" } - ] - } - }, - "charge_object": { - "title": "The charge object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "charge_object", - "section_anchor": "charges", - "subsection_anchors": null, - "path": "/charges/object", - "gate": false, - "display_on_load": false - }, - "create_charge": { - "title": "Create a charge", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_charge", - "section_anchor": "charges", - "subsection_anchors": null, - "path": "/charges/create", - "gate": false, - "display_on_load": false - }, - "retrieve_charge": { - "title": "Retrieve a charge", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_charge", - "section_anchor": "charges", - "subsection_anchors": null, - "path": "/charges/retrieve", - "gate": false, - "display_on_load": false - }, - "update_charge": { - "title": "Update a charge", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_charge", - "section_anchor": "charges", - "subsection_anchors": null, - "path": "/charges/update", - "gate": false, - "display_on_load": false - }, - "capture_charge": { - "title": "Capture a charge", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "capture_charge", - "section_anchor": "charges", - "subsection_anchors": null, - "path": "/charges/capture", - "gate": false, - "display_on_load": false - }, - "list_charges": { - "title": "List all charges", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_charges", - "section_anchor": "charges", - "subsection_anchors": null, - "path": "/charges/list", - "gate": false, - "display_on_load": false - }, - "search_charges": { - "title": "Search charges", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "search_charges", - "section_anchor": "charges", - "subsection_anchors": null, - "path": "/charges/search", - "gate": false, - "display_on_load": false - }, - "customers": { - "title": "Customers", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "customers", - "section_anchor": "customers", - "subsection_anchors": [ - "customer_object", - "create_customer", - "retrieve_customer", - "update_customer", - "delete_customer", - "list_customers", - "search_customers" - ], - "path": "/customers", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Customers", - "description": "This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](/docs/payments/save-during-payment).\n", - "section_tag": "customers", - "subsection_summaries": [ - { "anchor": "customer_object", "curl_definition": null }, - { "anchor": "create_customer", "curl_definition": "POST /v1/customers" }, - { "anchor": "retrieve_customer", "curl_definition": "GET /v1/customers/:id" }, - { "anchor": "update_customer", "curl_definition": "POST /v1/customers/:id" }, - { "anchor": "delete_customer", "curl_definition": "DELETE /v1/customers/:id" }, - { "anchor": "list_customers", "curl_definition": "GET /v1/customers" }, - { "anchor": "search_customers", "curl_definition": "GET /v1/customers/search" } - ] - } - }, - "customer_object": { - "title": "The customer object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "customer_object", - "section_anchor": "customers", - "subsection_anchors": null, - "path": "/customers/object", - "gate": false, - "display_on_load": false - }, - "create_customer": { - "title": "Create a customer", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_customer", - "section_anchor": "customers", - "subsection_anchors": null, - "path": "/customers/create", - "gate": false, - "display_on_load": false - }, - "retrieve_customer": { - "title": "Retrieve a customer", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_customer", - "section_anchor": "customers", - "subsection_anchors": null, - "path": "/customers/retrieve", - "gate": false, - "display_on_load": false - }, - "update_customer": { - "title": "Update a customer", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_customer", - "section_anchor": "customers", - "subsection_anchors": null, - "path": "/customers/update", - "gate": false, - "display_on_load": false - }, - "delete_customer": { - "title": "Delete a customer", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "delete_customer", - "section_anchor": "customers", - "subsection_anchors": null, - "path": "/customers/delete", - "gate": false, - "display_on_load": false - }, - "list_customers": { - "title": "List all customers", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_customers", - "section_anchor": "customers", - "subsection_anchors": null, - "path": "/customers/list", - "gate": false, - "display_on_load": false - }, - "search_customers": { - "title": "Search customers", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "search_customers", - "section_anchor": "customers", - "subsection_anchors": null, - "path": "/customers/search", - "gate": false, - "display_on_load": false - }, - "disputes": { - "title": "Disputes", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "disputes", - "section_anchor": "disputes", - "subsection_anchors": [ - "dispute_object", - "dispute_evidence_object", - "retrieve_dispute", - "update_dispute", - "close_dispute", - "list_disputes" - ], - "path": "/disputes", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Disputes", - "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you're given the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate. You can find more\ninformation about the dispute process in our [Disputes and\nFraud](/docs/disputes) documentation.\n\nRelated guide: [Disputes and Fraud](/docs/disputes).\n", - "section_tag": "disputes", - "subsection_summaries": [ - { "anchor": "dispute_object", "curl_definition": null }, - { "anchor": "dispute_evidence_object", "curl_definition": null }, - { "anchor": "retrieve_dispute", "curl_definition": "GET /v1/disputes/:id" }, - { "anchor": "update_dispute", "curl_definition": "POST /v1/disputes/:id" }, - { "anchor": "close_dispute", "curl_definition": "POST /v1/disputes/:id/close" }, - { "anchor": "list_disputes", "curl_definition": "GET /v1/disputes" } - ] - } - }, - "dispute_object": { - "title": "The dispute object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "dispute_object", - "section_anchor": "disputes", - "subsection_anchors": null, - "path": "/disputes/object", - "gate": false, - "display_on_load": false - }, - "dispute_evidence_object": { - "title": "The dispute evidence object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "dispute_evidence_object", - "section_anchor": "disputes", - "subsection_anchors": null, - "path": "/disputes/evidence_object", - "gate": false, - "display_on_load": false - }, - "retrieve_dispute": { - "title": "Retrieve a dispute", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_dispute", - "section_anchor": "disputes", - "subsection_anchors": null, - "path": "/disputes/retrieve", - "gate": false, - "display_on_load": false - }, - "update_dispute": { - "title": "Update a dispute", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_dispute", - "section_anchor": "disputes", - "subsection_anchors": null, - "path": "/disputes/update", - "gate": false, - "display_on_load": false - }, - "close_dispute": { - "title": "Close a dispute", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "close_dispute", - "section_anchor": "disputes", - "subsection_anchors": null, - "path": "/disputes/close", - "gate": false, - "display_on_load": false - }, - "list_disputes": { - "title": "List all disputes", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_disputes", - "section_anchor": "disputes", - "subsection_anchors": null, - "path": "/disputes/list", - "gate": false, - "display_on_load": false - }, - "events": { - "title": "Events", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "events", - "section_anchor": "events", - "subsection_anchors": ["event_object", "retrieve_event", "list_events", "event_types"], - "path": "/events", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Events", - "description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent; and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Note that many API requests may cause multiple\nevents to be created. For example, if you create a new subscription for a\ncustomer, you will receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The state of that\nresource at the time of the change is embedded in the event's data field. For\nexample, a `charge.succeeded` event will contain a charge, and an\n`invoice.payment_failed` event will contain an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](#retrieve_event) or a [list of events](#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. Webhooks are managed\nin your\n[account settings](https://dashboard.stripe.com/account/webhooks),\nand our [Using Webhooks](/docs/webhooks) guide will help you get set up.\n\nWhen using [Connect](/docs/connect), you can also receive notifications of\nevents that occur in connected accounts. For these events, there will be an\nadditional `account` attribute in the received `Event` object.\n\n**NOTE:** Right now, access to events through the [Retrieve Event API](#retrieve_event) is\nguaranteed only for 30 days.\n", - "section_tag": "events", - "subsection_summaries": [ - { "anchor": "event_object", "curl_definition": null }, - { "anchor": "retrieve_event", "curl_definition": "GET /v1/events/:id" }, - { "anchor": "list_events", "curl_definition": "GET /v1/events" }, - { "anchor": "event_types", "curl_definition": null } - ] - } - }, - "event_object": { - "title": "The event object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "event_object", - "section_anchor": "events", - "subsection_anchors": null, - "path": "/events/object", - "gate": false, - "display_on_load": false - }, - "retrieve_event": { - "title": "Retrieve an event", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_event", - "section_anchor": "events", - "subsection_anchors": null, - "path": "/events/retrieve", - "gate": false, - "display_on_load": false - }, - "list_events": { - "title": "List all events", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_events", - "section_anchor": "events", - "subsection_anchors": null, - "path": "/events/list", - "gate": false, - "display_on_load": false - }, - "event_types": { - "title": "Types of events", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "event_types", - "section_anchor": "events", - "subsection_anchors": null, - "path": "/events/types", - "gate": false, - "display_on_load": false - }, - "files": { - "title": "Files", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "files", - "section_anchor": "files", - "subsection_anchors": ["file_object", "create_file", "retrieve_file", "list_files"], - "path": "/files", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Files", - "description": "This is an object representing a file hosted on Stripe's servers. The\nfile may have been uploaded by yourself using the [create file](#create_file)\nrequest (for example, when uploading dispute evidence) or it may have\nbeen created by Stripe (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File Upload Guide](/docs/file-upload).\n", - "section_tag": "files", - "subsection_summaries": [ - { "anchor": "file_object", "curl_definition": null }, - { "anchor": "create_file", "curl_definition": "POST https://files.stripe.com/v1/files" }, - { "anchor": "retrieve_file", "curl_definition": "GET /v1/files/:id" }, - { "anchor": "list_files", "curl_definition": "GET /v1/files" } - ] - } - }, - "file_object": { - "title": "The file object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "file_object", - "section_anchor": "files", - "subsection_anchors": null, - "path": "/files/object", - "gate": false, - "display_on_load": false - }, - "create_file": { - "title": "Create a file", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_file", - "section_anchor": "files", - "subsection_anchors": null, - "path": "/files/create", - "gate": false, - "display_on_load": false - }, - "retrieve_file": { - "title": "Retrieve a file", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_file", - "section_anchor": "files", - "subsection_anchors": null, - "path": "/files/retrieve", - "gate": false, - "display_on_load": false - }, - "list_files": { - "title": "List all files", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_files", - "section_anchor": "files", - "subsection_anchors": null, - "path": "/files/list", - "gate": false, - "display_on_load": false - }, - "file_links": { - "title": "File Links", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "file_links", - "section_anchor": "file_links", - "subsection_anchors": [ - "file_link_object", - "create_file_link", - "retrieve_file_link", - "update_file_link", - "list_file_links" - ], - "path": "/file_links", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "File Links", - "description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that can be used to\nretrieve the contents of the file without authentication.\n", - "section_tag": "file_links", - "subsection_summaries": [ - { "anchor": "file_link_object", "curl_definition": null }, - { "anchor": "create_file_link", "curl_definition": "POST /v1/file_links" }, - { "anchor": "retrieve_file_link", "curl_definition": "GET /v1/file_links/:id" }, - { "anchor": "update_file_link", "curl_definition": "POST /v1/file_links/:id" }, - { "anchor": "list_file_links", "curl_definition": "GET /v1/file_links" } - ] - } - }, - "file_link_object": { - "title": "The file link object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "file_link_object", - "section_anchor": "file_links", - "subsection_anchors": null, - "path": "/file_links/object", - "gate": false, - "display_on_load": false - }, - "create_file_link": { - "title": "Create a file link", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_file_link", - "section_anchor": "file_links", - "subsection_anchors": null, - "path": "/file_links/create", - "gate": false, - "display_on_load": false - }, - "retrieve_file_link": { - "title": "Retrieve a file link", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_file_link", - "section_anchor": "file_links", - "subsection_anchors": null, - "path": "/file_links/retrieve", - "gate": false, - "display_on_load": false - }, - "update_file_link": { - "title": "Update a file link", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_file_link", - "section_anchor": "file_links", - "subsection_anchors": null, - "path": "/file_links/update", - "gate": false, - "display_on_load": false - }, - "list_file_links": { - "title": "List all file links", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_file_links", - "section_anchor": "file_links", - "subsection_anchors": null, - "path": "/file_links/list", - "gate": false, - "display_on_load": false - }, - "mandates": { - "title": "Mandates", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "mandates", - "section_anchor": "mandates", - "subsection_anchors": ["mandate_object", "retrieve_mandate"], - "path": "/mandates", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Mandates", - "description": "A Mandate is a record of the permission a customer has given you to debit their payment method.\n", - "section_tag": "mandates", - "subsection_summaries": [ - { "anchor": "mandate_object", "curl_definition": null }, - { "anchor": "retrieve_mandate", "curl_definition": "GET /v1/mandates/:id" } - ] - } - }, - "mandate_object": { - "title": "The Mandates object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "mandate_object", - "section_anchor": "mandates", - "subsection_anchors": null, - "path": "/mandates/object", - "gate": false, - "display_on_load": false - }, - "retrieve_mandate": { - "title": "Retrieve a Mandate", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_mandate", - "section_anchor": "mandates", - "subsection_anchors": null, - "path": "/mandates/retrieve", - "gate": false, - "display_on_load": false - }, - "payment_intents": { - "title": "PaymentIntents", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "payment_intents", - "section_anchor": "payment_intents", - "subsection_anchors": [ - "payment_intent_object", - "create_payment_intent", - "retrieve_payment_intent", - "update_payment_intent", - "confirm_payment_intent", - "capture_payment_intent", - "cancel_payment_intent", - "list_payment_intents", - "increment_authorization", - "search_payment_intents", - "verify_microdeposits_payment_intent", - "apply_customer_balance" - ], - "path": "/payment_intents", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "PaymentIntents", - "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](/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](/docs/payments/payment-intents).\n", - "section_tag": "payment_intents", - "subsection_summaries": [ - { "anchor": "payment_intent_object", "curl_definition": null }, - { "anchor": "create_payment_intent", "curl_definition": "POST /v1/payment_intents" }, - { "anchor": "retrieve_payment_intent", "curl_definition": "GET /v1/payment_intents/:id" }, - { "anchor": "update_payment_intent", "curl_definition": "POST /v1/payment_intents/:id" }, - { - "anchor": "confirm_payment_intent", - "curl_definition": "POST /v1/payment_intents/:id/confirm" - }, - { - "anchor": "capture_payment_intent", - "curl_definition": "POST /v1/payment_intents/:id/capture" - }, - { - "anchor": "cancel_payment_intent", - "curl_definition": "POST /v1/payment_intents/:id/cancel" - }, - { "anchor": "list_payment_intents", "curl_definition": "GET /v1/payment_intents" }, - { - "anchor": "increment_authorization", - "curl_definition": "POST /v1/payment_intents/:id/increment_authorization" - }, - { "anchor": "search_payment_intents", "curl_definition": "GET /v1/payment_intents/search" }, - { - "anchor": "verify_microdeposits_payment_intent", - "curl_definition": "POST /v1/payment_intents/:id/verify_microdeposits" - }, - { - "anchor": "apply_customer_balance", - "curl_definition": "POST /v1/payment_intents/:id/apply_customer_balance" - } - ] - } - }, - "payment_intent_object": { - "title": "The PaymentIntent object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "payment_intent_object", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/object", - "gate": false, - "display_on_load": false - }, - "create_payment_intent": { - "title": "Create a PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_payment_intent", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/create", - "gate": false, - "display_on_load": false - }, - "retrieve_payment_intent": { - "title": "Retrieve a PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_payment_intent", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/retrieve", - "gate": false, - "display_on_load": false - }, - "update_payment_intent": { - "title": "Update a PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_payment_intent", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/update", - "gate": false, - "display_on_load": false - }, - "confirm_payment_intent": { - "title": "Confirm a PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "confirm_payment_intent", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/confirm", - "gate": false, - "display_on_load": false - }, - "capture_payment_intent": { - "title": "Capture a PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "capture_payment_intent", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/capture", - "gate": false, - "display_on_load": false - }, - "cancel_payment_intent": { - "title": "Cancel a PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "cancel_payment_intent", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/cancel", - "gate": false, - "display_on_load": false - }, - "list_payment_intents": { - "title": "List all PaymentIntents", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_payment_intents", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/list", - "gate": false, - "display_on_load": false - }, - "increment_authorization": { - "title": "Increment an authorization", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "increment_authorization", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/increment_authorization", - "gate": false, - "display_on_load": false - }, - "search_payment_intents": { - "title": "Search PaymentIntents", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "search_payment_intents", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/search", - "gate": false, - "display_on_load": false - }, - "verify_microdeposits_payment_intent": { - "title": "Verify microdeposits on a PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "verify_microdeposits_payment_intent", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/verify_microdeposits", - "gate": false, - "display_on_load": false - }, - "apply_customer_balance": { - "title": "Reconcile a customer_balance PaymentIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "apply_customer_balance", - "section_anchor": "payment_intents", - "subsection_anchors": null, - "path": "/payment_intents/apply_customer_balance", - "gate": false, - "display_on_load": false - }, - "setup_intents": { - "title": "SetupIntents", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "setup_intents", - "section_anchor": "setup_intents", - "subsection_anchors": [ - "setup_intent_object", - "create_setup_intent", - "retrieve_setup_intent", - "update_setup_intent", - "confirm_setup_intent", - "cancel_setup_intent", - "list_setup_intents", - "verify_microdeposits_setup_intent" - ], - "path": "/setup_intents", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "SetupIntents", - "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](#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](/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](/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](#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](#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](/docs/payments/setup-intents).\n", - "section_tag": "setup_intents", - "subsection_summaries": [ - { "anchor": "setup_intent_object", "curl_definition": null }, - { "anchor": "create_setup_intent", "curl_definition": "POST /v1/setup_intents" }, - { "anchor": "retrieve_setup_intent", "curl_definition": "GET /v1/setup_intents/:id" }, - { "anchor": "update_setup_intent", "curl_definition": "POST /v1/setup_intents/:id" }, - { - "anchor": "confirm_setup_intent", - "curl_definition": "POST /v1/setup_intents/:id/confirm" - }, - { "anchor": "cancel_setup_intent", "curl_definition": "POST /v1/setup_intents/:id/cancel" }, - { "anchor": "list_setup_intents", "curl_definition": "GET /v1/setup_intents" }, - { - "anchor": "verify_microdeposits_setup_intent", - "curl_definition": "POST /v1/setup_intents/:id/verify_microdeposits" - } - ] - } - }, - "setup_intent_object": { - "title": "The SetupIntent object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "setup_intent_object", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/object", - "gate": false, - "display_on_load": false - }, - "create_setup_intent": { - "title": "Create a SetupIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_setup_intent", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/create", - "gate": false, - "display_on_load": false - }, - "retrieve_setup_intent": { - "title": "Retrieve a SetupIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_setup_intent", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/retrieve", - "gate": false, - "display_on_load": false - }, - "update_setup_intent": { - "title": "Update a SetupIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_setup_intent", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/update", - "gate": false, - "display_on_load": false - }, - "confirm_setup_intent": { - "title": "Confirm a SetupIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "confirm_setup_intent", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/confirm", - "gate": false, - "display_on_load": false - }, - "cancel_setup_intent": { - "title": "Cancel a SetupIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "cancel_setup_intent", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/cancel", - "gate": false, - "display_on_load": false - }, - "list_setup_intents": { - "title": "List all SetupIntents", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_setup_intents", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/list", - "gate": false, - "display_on_load": false - }, - "verify_microdeposits_setup_intent": { - "title": "Verify microdeposits on a SetupIntent", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "verify_microdeposits_setup_intent", - "section_anchor": "setup_intents", - "subsection_anchors": null, - "path": "/setup_intents/verify_microdeposits", - "gate": false, - "display_on_load": false - }, - "setup_attempts": { - "title": "SetupAttempts", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "setup_attempts", - "section_anchor": "setup_attempts", - "subsection_anchors": ["setup_attempt_object", "list_setup_attempts"], - "path": "/setup_attempts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "SetupAttempts", - "description": "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation was successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.\n", - "section_tag": "setup_attempts", - "subsection_summaries": [ - { "anchor": "setup_attempt_object", "curl_definition": null }, - { "anchor": "list_setup_attempts", "curl_definition": "GET /v1/setup_attempts" } - ] - } - }, - "setup_attempt_object": { - "title": "The SetupAttempt object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "setup_attempt_object", - "section_anchor": "setup_attempts", - "subsection_anchors": null, - "path": "/setup_attempts/object", - "gate": false, - "display_on_load": false - }, - "list_setup_attempts": { - "title": "List all SetupAttempts", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_setup_attempts", - "section_anchor": "setup_attempts", - "subsection_anchors": null, - "path": "/setup_attempts/list", - "gate": false, - "display_on_load": false - }, - "payouts": { - "title": "Payouts", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "payouts", - "section_anchor": "payouts", - "subsection_anchors": [ - "payout_object", - "create_payout", - "retrieve_payout", - "update_payout", - "list_payouts", - "cancel_payout", - "reverse_payout", - "payout_failures" - ], - "path": "/payouts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Payouts", - "description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nas well as list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving Payouts](/docs/payouts).\n", - "section_tag": "payouts", - "subsection_summaries": [ - { "anchor": "payout_object", "curl_definition": null }, - { "anchor": "create_payout", "curl_definition": "POST /v1/payouts" }, - { "anchor": "retrieve_payout", "curl_definition": "GET /v1/payouts/:id" }, - { "anchor": "update_payout", "curl_definition": "POST /v1/payouts/:id" }, - { "anchor": "list_payouts", "curl_definition": "GET /v1/payouts" }, - { "anchor": "cancel_payout", "curl_definition": "POST /v1/payouts/:id/cancel" }, - { "anchor": "reverse_payout", "curl_definition": "POST /v1/payouts/:id/reverse" }, - { "anchor": "payout_failures", "curl_definition": null } - ] - } - }, - "payout_object": { - "title": "The payout object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "payout_object", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/object", - "gate": false, - "display_on_load": false - }, - "create_payout": { - "title": "Create a payout", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_payout", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/create", - "gate": false, - "display_on_load": false - }, - "retrieve_payout": { - "title": "Retrieve a payout", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_payout", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/retrieve", - "gate": false, - "display_on_load": false - }, - "update_payout": { - "title": "Update a payout", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_payout", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/update", - "gate": false, - "display_on_load": false - }, - "list_payouts": { - "title": "List all payouts", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_payouts", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/list", - "gate": false, - "display_on_load": false - }, - "cancel_payout": { - "title": "Cancel a payout", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "cancel_payout", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/cancel", - "gate": false, - "display_on_load": false - }, - "reverse_payout": { - "title": "Reverse a payout", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "reverse_payout", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/reverse", - "gate": false, - "display_on_load": false - }, - "payout_failures": { - "title": "Types of payout failures", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "payout_failures", - "section_anchor": "payouts", - "subsection_anchors": null, - "path": "/payouts/failures", - "gate": false, - "display_on_load": false - }, - "refunds": { - "title": "Refunds", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "refunds", - "section_anchor": "refunds", - "subsection_anchors": [ - "refund_object", - "create_refund", - "retrieve_refund", - "update_refund", - "cancel_refund", - "list_refunds" - ], - "path": "/refunds", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Refunds", - "description": "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](/docs/refunds).\n", - "section_tag": "refunds", - "subsection_summaries": [ - { "anchor": "refund_object", "curl_definition": null }, - { "anchor": "create_refund", "curl_definition": "POST /v1/refunds" }, - { "anchor": "retrieve_refund", "curl_definition": "GET /v1/refunds/:id" }, - { "anchor": "update_refund", "curl_definition": "POST /v1/refunds/:id" }, - { "anchor": "cancel_refund", "curl_definition": "POST /v1/refunds/:id/cancel" }, - { "anchor": "list_refunds", "curl_definition": "GET /v1/refunds" } - ] - } - }, - "refund_object": { - "title": "The refund object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "refund_object", - "section_anchor": "refunds", - "subsection_anchors": null, - "path": "/refunds/object", - "gate": false, - "display_on_load": false - }, - "create_refund": { - "title": "Create a refund", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_refund", - "section_anchor": "refunds", - "subsection_anchors": null, - "path": "/refunds/create", - "gate": false, - "display_on_load": false - }, - "retrieve_refund": { - "title": "Retrieve a refund", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_refund", - "section_anchor": "refunds", - "subsection_anchors": null, - "path": "/refunds/retrieve", - "gate": false, - "display_on_load": false - }, - "update_refund": { - "title": "Update a refund", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "update_refund", - "section_anchor": "refunds", - "subsection_anchors": null, - "path": "/refunds/update", - "gate": false, - "display_on_load": false - }, - "cancel_refund": { - "title": "Cancel a refund", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "cancel_refund", - "section_anchor": "refunds", - "subsection_anchors": null, - "path": "/refunds/cancel", - "gate": false, - "display_on_load": false - }, - "list_refunds": { - "title": "List all refunds", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "list_refunds", - "section_anchor": "refunds", - "subsection_anchors": null, - "path": "/refunds/list", - "gate": false, - "display_on_load": false - }, - "tokens": { - "title": "Tokens", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "tokens", - "section_anchor": "tokens", - "subsection_anchors": [ - "token_object", - "create_card_token", - "create_bank_account_token", - "create_pii_token", - "create_account_token", - "create_person_token", - "create_cvc_update_token", - "retrieve_token" - ], - "path": "/tokens", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Tokens", - "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. You should use our\n[recommended payments integrations](/docs/payments) to perform this process\nclient-side. This ensures that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you cannot use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. Keep in mind that if\nyour integration uses this method, you are responsible for any PCI compliance\nthat may be required, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information is not sent directly to\nStripe, so we cannot determine how it is handled or stored.\n\nTokens cannot be stored or used more than once. To store card or bank account\ninformation for later use, you can create [Customer](/docs/api#customers)\nobjects or [Custom accounts](/docs/api#external_accounts). Note that\n[Radar](/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.\n\nRelated guide: [Accept a payment](/docs/payments/accept-a-payment-charges#web-create-token)\n", - "section_tag": "tokens", - "subsection_summaries": [ - { "anchor": "token_object", "curl_definition": null }, - { "anchor": "create_card_token", "curl_definition": "POST /v1/tokens" }, - { "anchor": "create_bank_account_token", "curl_definition": "POST /v1/tokens" }, - { "anchor": "create_pii_token", "curl_definition": "POST /v1/tokens" }, - { "anchor": "create_account_token", "curl_definition": "POST /v1/tokens" }, - { "anchor": "create_person_token", "curl_definition": "POST /v1/tokens" }, - { "anchor": "create_cvc_update_token", "curl_definition": "POST /v1/tokens" }, - { "anchor": "retrieve_token", "curl_definition": "GET /v1/tokens/:id" } - ] - } - }, - "token_object": { - "title": "The token object", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "token_object", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/object", - "gate": false, - "display_on_load": false - }, - "create_card_token": { - "title": "Create a card token", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_card_token", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/create_card", - "gate": false, - "display_on_load": false - }, - "create_bank_account_token": { - "title": "Create a bank account token", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_bank_account_token", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/create_bank_account", - "gate": false, - "display_on_load": false - }, - "create_pii_token": { - "title": "Create a PII token", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_pii_token", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/create_pii", - "gate": false, - "display_on_load": false - }, - "create_account_token": { - "title": "Create an account token", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_account_token", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/create_account", - "gate": false, - "display_on_load": false - }, - "create_person_token": { - "title": "Create a person token", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_person_token", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/create_person", - "gate": false, - "display_on_load": false - }, - "create_cvc_update_token": { - "title": "Create a CVC update token", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "create_cvc_update_token", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/create_cvc_update", - "gate": false, - "display_on_load": false - }, - "retrieve_token": { - "title": "Retrieve a token", - "group_title": "Core Resources", - "group_anchor": "core_resources", - "anchor": "retrieve_token", - "section_anchor": "tokens", - "subsection_anchors": null, - "path": "/tokens/retrieve", - "gate": false, - "display_on_load": false - }, - "payment_methods": { - "title": "PaymentMethods", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "payment_methods", - "section_anchor": "payment_methods", - "subsection_anchors": [ - "payment_method_object", - "create_payment_method", - "retrieve_payment_method", - "retrieve_customer_payment_method", - "update_payment_method", - "list_payment_methods", - "list_customer_payment_methods", - "customer_attach_payment_method", - "customer_detach_payment_method" - ], - "path": "/payment_methods", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "PaymentMethods", - "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](/docs/payments/payment-methods) and [More Payment Scenarios](/docs/payments/more-payment-scenarios).\n", - "section_tag": "payment_methods", - "subsection_summaries": [ - { "anchor": "payment_method_object", "curl_definition": null }, - { "anchor": "create_payment_method", "curl_definition": "POST /v1/payment_methods" }, - { "anchor": "retrieve_payment_method", "curl_definition": "GET /v1/payment_methods/:id" }, - { - "anchor": "retrieve_customer_payment_method", - "curl_definition": "GET /v1/customers/:customer/payment_methods/:payment_method" - }, - { "anchor": "update_payment_method", "curl_definition": "POST /v1/payment_methods/:id" }, - { "anchor": "list_payment_methods", "curl_definition": "GET /v1/payment_methods" }, - { - "anchor": "list_customer_payment_methods", - "curl_definition": "GET /v1/customers/:customer/payment_methods" - }, - { - "anchor": "customer_attach_payment_method", - "curl_definition": "POST /v1/payment_methods/:id/attach" - }, - { - "anchor": "customer_detach_payment_method", - "curl_definition": "POST /v1/payment_methods/:id/detach" - } - ] - } - }, - "payment_method_object": { - "title": "The PaymentMethod object", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "payment_method_object", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/object", - "gate": false, - "display_on_load": false - }, - "create_payment_method": { - "title": "Create a PaymentMethod", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "create_payment_method", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/create", - "gate": false, - "display_on_load": false - }, - "retrieve_payment_method": { - "title": "Retrieve a PaymentMethod", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "retrieve_payment_method", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/retrieve", - "gate": false, - "display_on_load": false - }, - "retrieve_customer_payment_method": { - "title": "Retrieve a Customer's PaymentMethod", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "retrieve_customer_payment_method", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/customer", - "gate": false, - "display_on_load": false - }, - "update_payment_method": { - "title": "Update a PaymentMethod", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "update_payment_method", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/update", - "gate": false, - "display_on_load": false - }, - "list_payment_methods": { - "title": "List PaymentMethods", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "list_payment_methods", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/list", - "gate": false, - "display_on_load": false - }, - "list_customer_payment_methods": { - "title": "List a Customer's PaymentMethods", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "list_customer_payment_methods", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/customer_list", - "gate": false, - "display_on_load": false - }, - "customer_attach_payment_method": { - "title": "Attach a PaymentMethod to a Customer", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_attach_payment_method", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/attach", - "gate": false, - "display_on_load": false - }, - "customer_detach_payment_method": { - "title": "Detach a PaymentMethod from a Customer", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_detach_payment_method", - "section_anchor": "payment_methods", - "subsection_anchors": null, - "path": "/payment_methods/detach", - "gate": false, - "display_on_load": false - }, - "bank_accounts": { - "title": "Bank Accounts", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "bank_accounts", - "section_anchor": "bank_accounts", - "subsection_anchors": [ - "customer_bank_account_object", - "customer_create_bank_account", - "customer_retrieve_bank_account", - "customer_update_bank_account", - "customer_verify_bank_account", - "customer_delete_bank_account", - "customer_list_bank_accounts" - ], - "path": "/customer_bank_accounts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Bank Accounts", - "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/docs/api#external_accounts) are transfer\ndestinations on `Account` objects for [Custom accounts](/docs/connect/custom-accounts).\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank Debits and Transfers](/docs/payments/bank-debits-transfers).\n", - "section_tag": "bank_accounts", - "subsection_summaries": [ - { "anchor": "customer_bank_account_object", "curl_definition": null }, - { - "anchor": "customer_create_bank_account", - "curl_definition": "POST /v1/customers/:id/sources" - }, - { - "anchor": "customer_retrieve_bank_account", - "curl_definition": "GET /v1/customers/:id/sources/:id" - }, - { - "anchor": "customer_update_bank_account", - "curl_definition": "POST /v1/customers/:id/sources/:id" - }, - { - "anchor": "customer_verify_bank_account", - "curl_definition": "POST /v1/customers/:id/sources/:id/verify" - }, - { - "anchor": "customer_delete_bank_account", - "curl_definition": "DELETE /v1/customers/:id/sources/:id" - }, - { - "anchor": "customer_list_bank_accounts", - "curl_definition": "GET /v1/customers/:id/sources?object=bank_account" - } - ] - } - }, - "customer_bank_account_object": { - "title": "The bank account object", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_bank_account_object", - "section_anchor": "bank_accounts", - "subsection_anchors": null, - "path": "/customer_bank_accounts/object", - "gate": false, - "display_on_load": false - }, - "customer_create_bank_account": { - "title": "Create a bank account", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_create_bank_account", - "section_anchor": "bank_accounts", - "subsection_anchors": null, - "path": "/customer_bank_accounts/create", - "gate": false, - "display_on_load": false - }, - "customer_retrieve_bank_account": { - "title": "Retrieve a bank account", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_retrieve_bank_account", - "section_anchor": "bank_accounts", - "subsection_anchors": null, - "path": "/customer_bank_accounts/retrieve", - "gate": false, - "display_on_load": false - }, - "customer_update_bank_account": { - "title": "Update a bank account", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_update_bank_account", - "section_anchor": "bank_accounts", - "subsection_anchors": null, - "path": "/customer_bank_accounts/update", - "gate": false, - "display_on_load": false - }, - "customer_verify_bank_account": { - "title": "Verify a bank account", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_verify_bank_account", - "section_anchor": "bank_accounts", - "subsection_anchors": null, - "path": "/customer_bank_accounts/verify", - "gate": false, - "display_on_load": false - }, - "customer_delete_bank_account": { - "title": "Delete a bank account", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_delete_bank_account", - "section_anchor": "bank_accounts", - "subsection_anchors": null, - "path": "/customer_bank_accounts/delete", - "gate": false, - "display_on_load": false - }, - "customer_list_bank_accounts": { - "title": "List all bank accounts", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_list_bank_accounts", - "section_anchor": "bank_accounts", - "subsection_anchors": null, - "path": "/customer_bank_accounts/list", - "gate": false, - "display_on_load": false - }, - "cash_balance": { - "title": "Cash Balance", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "cash_balance", - "section_anchor": "cash_balance", - "subsection_anchors": [ - "cash_balance_object", - "retrieve_cash_balance", - "update_cash_balance", - "customer_cash_balance_transaction_object", - "retrieve_cash_balance_transaction", - "list_cash_balance_transactions", - "fund_cash_balance" - ], - "path": "/cash_balance", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Cash balance", - "description": "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.\n", - "section_tag": "cash_balance", - "subsection_summaries": [ - { "anchor": "cash_balance_object", "curl_definition": null }, - { - "anchor": "retrieve_cash_balance", - "curl_definition": "GET /v1/customers/:id/cash_balance" - }, - { - "anchor": "update_cash_balance", - "curl_definition": "POST /v1/customers/:id/cash_balance" - }, - { "anchor": "customer_cash_balance_transaction_object", "curl_definition": null }, - { - "anchor": "retrieve_cash_balance_transaction", - "curl_definition": "GET /v1/customers/:id/cash_balance_transactions/:id" - }, - { - "anchor": "list_cash_balance_transactions", - "curl_definition": "GET /v1/customers/:id/cash_balance_transactions" - }, - { - "anchor": "fund_cash_balance", - "curl_definition": "POST /v1/test_helpers/customers/{:customer}/fund_cash_balance" - } - ] - } - }, - "cash_balance_object": { - "title": "The cash balance object", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "cash_balance_object", - "section_anchor": "cash_balance", - "subsection_anchors": null, - "path": "/cash_balance/object", - "gate": false, - "display_on_load": false - }, - "retrieve_cash_balance": { - "title": "Retrieve a cash balance", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "retrieve_cash_balance", - "section_anchor": "cash_balance", - "subsection_anchors": null, - "path": "/cash_balance/retrieve", - "gate": true, - "display_on_load": false - }, - "update_cash_balance": { - "title": "Update a cash balance's settings", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "update_cash_balance", - "section_anchor": "cash_balance", - "subsection_anchors": null, - "path": "/cash_balance/update", - "gate": true, - "display_on_load": false - }, - "customer_cash_balance_transaction_object": { - "title": "The cash balance transaction object", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "customer_cash_balance_transaction_object", - "section_anchor": "cash_balance", - "subsection_anchors": null, - "path": "/cash_balance_transactions/object", - "gate": false, - "display_on_load": false - }, - "retrieve_cash_balance_transaction": { - "title": "Retrieve a cash balance transaction", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "retrieve_cash_balance_transaction", - "section_anchor": "cash_balance", - "subsection_anchors": null, - "path": "/cash_balance_transactions/retrieve", - "gate": false, - "display_on_load": false - }, - "list_cash_balance_transactions": { - "title": "List cash balance transactions", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "list_cash_balance_transactions", - "section_anchor": "cash_balance", - "subsection_anchors": null, - "path": "/cash_balance_transactions/list", - "gate": false, - "display_on_load": false - }, - "fund_cash_balance": { - "title": "Fund a test mode cash balance", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "fund_cash_balance", - "section_anchor": "cash_balance", - "subsection_anchors": null, - "path": "/cash_balance_transactions/fund_cash_balance", - "gate": false, - "display_on_load": false - }, - "cards": { - "title": "Cards", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "cards", - "section_anchor": "cards", - "subsection_anchors": [ - "card_object", - "create_card", - "retrieve_card", - "update_card", - "delete_card", - "list_cards" - ], - "path": "/cards", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Cards", - "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card Payments with Sources](/docs/sources/cards).\n", - "section_tag": "cards", - "subsection_summaries": [ - { "anchor": "card_object", "curl_definition": null }, - { "anchor": "create_card", "curl_definition": "POST /v1/customers/:id/sources" }, - { "anchor": "retrieve_card", "curl_definition": "GET /v1/customers/:id/sources/:id" }, - { "anchor": "update_card", "curl_definition": "POST /v1/customers/:id/sources/:id" }, - { "anchor": "delete_card", "curl_definition": "DELETE /v1/customers/:id/sources/:id" }, - { "anchor": "list_cards", "curl_definition": "GET /v1/customers/:id/sources?object=card" } - ] - } - }, - "card_object": { - "title": "The card object", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "card_object", - "section_anchor": "cards", - "subsection_anchors": null, - "path": "/cards/object", - "gate": false, - "display_on_load": false - }, - "create_card": { - "title": "Create a card", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "create_card", - "section_anchor": "cards", - "subsection_anchors": null, - "path": "/cards/create", - "gate": false, - "display_on_load": false - }, - "retrieve_card": { - "title": "Retrieve a card", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "retrieve_card", - "section_anchor": "cards", - "subsection_anchors": null, - "path": "/cards/retrieve", - "gate": false, - "display_on_load": false - }, - "update_card": { - "title": "Update a card", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "update_card", - "section_anchor": "cards", - "subsection_anchors": null, - "path": "/cards/update", - "gate": false, - "display_on_load": false - }, - "delete_card": { - "title": "Delete a card", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "delete_card", - "section_anchor": "cards", - "subsection_anchors": null, - "path": "/cards/delete", - "gate": false, - "display_on_load": false - }, - "list_cards": { - "title": "List all cards", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "list_cards", - "section_anchor": "cards", - "subsection_anchors": null, - "path": "/cards/list", - "gate": false, - "display_on_load": false - }, - "sources": { - "title": "Sources", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "sources", - "section_anchor": "sources", - "subsection_anchors": [ - "source_object", - "create_source", - "retrieve_source", - "update_source", - "attach_source", - "detach_source" - ], - "path": "/sources", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Sources", - "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\nStripe doesn't recommend using the deprecated [Sources API](/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](/docs/sources) and [Sources \u0026 Customers](/docs/sources/customers).\n", - "section_tag": "sources", - "subsection_summaries": [ - { "anchor": "source_object", "curl_definition": null }, - { "anchor": "create_source", "curl_definition": "POST /v1/sources" }, - { "anchor": "retrieve_source", "curl_definition": "GET /v1/sources/:id" }, - { "anchor": "update_source", "curl_definition": "POST /v1/sources/:id" }, - { "anchor": "attach_source", "curl_definition": "POST /v1/customers/:id/sources" }, - { "anchor": "detach_source", "curl_definition": "DELETE /v1/customers/:id/sources/:id" } - ] - } - }, - "source_object": { - "title": "The source object", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "source_object", - "section_anchor": "sources", - "subsection_anchors": null, - "path": "/sources/object", - "gate": false, - "display_on_load": false - }, - "create_source": { - "title": "Create a source", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "create_source", - "section_anchor": "sources", - "subsection_anchors": null, - "path": "/sources/create", - "gate": false, - "display_on_load": false - }, - "retrieve_source": { - "title": "Retrieve a source", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "retrieve_source", - "section_anchor": "sources", - "subsection_anchors": null, - "path": "/sources/retrieve", - "gate": false, - "display_on_load": false - }, - "update_source": { - "title": "Update a source", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "update_source", - "section_anchor": "sources", - "subsection_anchors": null, - "path": "/sources/update", - "gate": false, - "display_on_load": false - }, - "attach_source": { - "title": "Attach a source", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "attach_source", - "section_anchor": "sources", - "subsection_anchors": null, - "path": "/sources/attach", - "gate": false, - "display_on_load": false - }, - "detach_source": { - "title": "Detach a source", - "group_title": "Payment Methods", - "group_anchor": "payment_methods_heading", - "anchor": "detach_source", - "section_anchor": "sources", - "subsection_anchors": null, - "path": "/sources/detach", - "gate": false, - "display_on_load": false - }, - "products": { - "title": "Products", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "products", - "section_anchor": "products", - "subsection_anchors": [ - "product_object", - "create_product", - "retrieve_product", - "update_product", - "list_products", - "delete_product", - "search_products" - ], - "path": "/products", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Products", - "description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](/docs/payments/payment-links/overview),\n[accept payments with Checkout](/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](/docs/products-prices/overview)\n", - "section_tag": "products", - "subsection_summaries": [ - { "anchor": "product_object", "curl_definition": null }, - { "anchor": "create_product", "curl_definition": "POST /v1/products" }, - { "anchor": "retrieve_product", "curl_definition": "GET /v1/products/:id" }, - { "anchor": "update_product", "curl_definition": "POST /v1/products/:id" }, - { "anchor": "list_products", "curl_definition": "GET /v1/products" }, - { "anchor": "delete_product", "curl_definition": "DELETE /v1/products/:id" }, - { "anchor": "search_products", "curl_definition": "GET /v1/products/search" } - ] - } - }, - "product_object": { - "title": "The product object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "product_object", - "section_anchor": "products", - "subsection_anchors": null, - "path": "/products/object", - "gate": false, - "display_on_load": false - }, - "create_product": { - "title": "Create a product", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "create_product", - "section_anchor": "products", - "subsection_anchors": null, - "path": "/products/create", - "gate": false, - "display_on_load": false - }, - "retrieve_product": { - "title": "Retrieve a product", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "retrieve_product", - "section_anchor": "products", - "subsection_anchors": null, - "path": "/products/retrieve", - "gate": false, - "display_on_load": false - }, - "update_product": { - "title": "Update a product", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "update_product", - "section_anchor": "products", - "subsection_anchors": null, - "path": "/products/update", - "gate": false, - "display_on_load": false - }, - "list_products": { - "title": "List all products", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "list_products", - "section_anchor": "products", - "subsection_anchors": null, - "path": "/products/list", - "gate": false, - "display_on_load": false - }, - "delete_product": { - "title": "Delete a product", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "delete_product", - "section_anchor": "products", - "subsection_anchors": null, - "path": "/products/delete", - "gate": false, - "display_on_load": false - }, - "search_products": { - "title": "Search products", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "search_products", - "section_anchor": "products", - "subsection_anchors": null, - "path": "/products/search", - "gate": false, - "display_on_load": false - }, - "prices": { - "title": "Prices", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "prices", - "section_anchor": "prices", - "subsection_anchors": [ - "price_object", - "create_price", - "retrieve_price", - "update_price", - "list_prices", - "search_prices" - ], - "path": "/prices", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Prices", - "description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](#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](/docs/billing/subscriptions/set-up-subscription), [create an invoice](/docs/billing/invoices/create), and more about [products and prices](/docs/products-prices/overview).\n", - "section_tag": "prices", - "subsection_summaries": [ - { "anchor": "price_object", "curl_definition": null }, - { "anchor": "create_price", "curl_definition": "POST /v1/prices" }, - { "anchor": "retrieve_price", "curl_definition": "GET /v1/prices/:id" }, - { "anchor": "update_price", "curl_definition": "POST /v1/prices/:id" }, - { "anchor": "list_prices", "curl_definition": "GET /v1/prices" }, - { "anchor": "search_prices", "curl_definition": "GET /v1/prices/search" } - ] - } - }, - "price_object": { - "title": "The price object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "price_object", - "section_anchor": "prices", - "subsection_anchors": null, - "path": "/prices/object", - "gate": false, - "display_on_load": false - }, - "create_price": { - "title": "Create a price", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "create_price", - "section_anchor": "prices", - "subsection_anchors": null, - "path": "/prices/create", - "gate": false, - "display_on_load": false - }, - "retrieve_price": { - "title": "Retrieve a price", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "retrieve_price", - "section_anchor": "prices", - "subsection_anchors": null, - "path": "/prices/retrieve", - "gate": false, - "display_on_load": false - }, - "update_price": { - "title": "Update a price", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "update_price", - "section_anchor": "prices", - "subsection_anchors": null, - "path": "/prices/update", - "gate": false, - "display_on_load": false - }, - "list_prices": { - "title": "List all prices", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "list_prices", - "section_anchor": "prices", - "subsection_anchors": null, - "path": "/prices/list", - "gate": false, - "display_on_load": false - }, - "search_prices": { - "title": "Search prices", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "search_prices", - "section_anchor": "prices", - "subsection_anchors": null, - "path": "/prices/search", - "gate": false, - "display_on_load": false - }, - "coupons": { - "title": "Coupons", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "coupons", - "section_anchor": "coupons", - "subsection_anchors": [ - "coupon_object", - "create_coupon", - "retrieve_coupon", - "update_coupon", - "delete_coupon", - "list_coupons" - ], - "path": "/coupons", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Coupons", - "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 [subscriptions](#subscriptions), [invoices](#invoices),\n[checkout sessions](/docs/api/checkout/sessions), [quotes](#quotes), and more. Coupons do not work with conventional one-off [charges](#create_charge) or [payment intents](/docs/api/payment_intents).\n", - "section_tag": "coupons", - "subsection_summaries": [ - { "anchor": "coupon_object", "curl_definition": null }, - { "anchor": "create_coupon", "curl_definition": "POST /v1/coupons" }, - { "anchor": "retrieve_coupon", "curl_definition": "GET /v1/coupons/:id" }, - { "anchor": "update_coupon", "curl_definition": "POST /v1/coupons/:id" }, - { "anchor": "delete_coupon", "curl_definition": "DELETE /v1/coupons/:id" }, - { "anchor": "list_coupons", "curl_definition": "GET /v1/coupons" } - ] - } - }, - "coupon_object": { - "title": "The coupon object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "coupon_object", - "section_anchor": "coupons", - "subsection_anchors": null, - "path": "/coupons/object", - "gate": false, - "display_on_load": false - }, - "create_coupon": { - "title": "Create a coupon", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "create_coupon", - "section_anchor": "coupons", - "subsection_anchors": null, - "path": "/coupons/create", - "gate": false, - "display_on_load": false - }, - "retrieve_coupon": { - "title": "Retrieve a coupon", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "retrieve_coupon", - "section_anchor": "coupons", - "subsection_anchors": null, - "path": "/coupons/retrieve", - "gate": false, - "display_on_load": false - }, - "update_coupon": { - "title": "Update a coupon", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "update_coupon", - "section_anchor": "coupons", - "subsection_anchors": null, - "path": "/coupons/update", - "gate": false, - "display_on_load": false - }, - "delete_coupon": { - "title": "Delete a coupon", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "delete_coupon", - "section_anchor": "coupons", - "subsection_anchors": null, - "path": "/coupons/delete", - "gate": false, - "display_on_load": false - }, - "list_coupons": { - "title": "List all coupons", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "list_coupons", - "section_anchor": "coupons", - "subsection_anchors": null, - "path": "/coupons/list", - "gate": false, - "display_on_load": false - }, - "promotion_codes": { - "title": "Promotion Codes", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "promotion_codes", - "section_anchor": "promotion_codes", - "subsection_anchors": [ - "promotion_code_object", - "create_promotion_code", - "update_promotion_code", - "retrieve_promotion_code", - "list_promotion_code" - ], - "path": "/promotion_codes", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Promotion Code", - "description": "A Promotion Code represents a customer-redeemable code for a [coupon](#coupons). It can be used to\ncreate multiple codes for a single coupon.\n", - "section_tag": "promotion_codes", - "subsection_summaries": [ - { "anchor": "promotion_code_object", "curl_definition": null }, - { "anchor": "create_promotion_code", "curl_definition": "POST /v1/promotion_codes" }, - { "anchor": "update_promotion_code", "curl_definition": "POST /v1/promotion_codes/:id" }, - { "anchor": "retrieve_promotion_code", "curl_definition": "GET /v1/promotion_codes/:id" }, - { "anchor": "list_promotion_code", "curl_definition": "GET /v1/promotion_codes" } - ] - } - }, - "promotion_code_object": { - "title": "The promotion code object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "promotion_code_object", - "section_anchor": "promotion_codes", - "subsection_anchors": null, - "path": "/promotion_codes/object", - "gate": false, - "display_on_load": false - }, - "create_promotion_code": { - "title": "Create a promotion code", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "create_promotion_code", - "section_anchor": "promotion_codes", - "subsection_anchors": null, - "path": "/promotion_codes/create", - "gate": false, - "display_on_load": false - }, - "update_promotion_code": { - "title": "Update a promotion code", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "update_promotion_code", - "section_anchor": "promotion_codes", - "subsection_anchors": null, - "path": "/promotion_codes/update", - "gate": false, - "display_on_load": false - }, - "retrieve_promotion_code": { - "title": "Retrieve a promotion code", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "retrieve_promotion_code", - "section_anchor": "promotion_codes", - "subsection_anchors": null, - "path": "/promotion_codes/retrieve", - "gate": false, - "display_on_load": false - }, - "list_promotion_code": { - "title": "List all promotion codes", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "list_promotion_code", - "section_anchor": "promotion_codes", - "subsection_anchors": null, - "path": "/promotion_codes/list", - "gate": false, - "display_on_load": false - }, - "discounts": { - "title": "Discounts", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "discounts", - "section_anchor": "discounts", - "subsection_anchors": ["discount_object", "delete_discount", "delete_subscription_discount"], - "path": "/discounts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Discounts", - "description": "A discount represents the actual application of a [coupon](#coupons) or [promotion code](#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying Discounts to Subscriptions](/docs/billing/subscriptions/discounts).\n", - "section_tag": "discounts", - "subsection_summaries": [ - { "anchor": "discount_object", "curl_definition": null }, - { "anchor": "delete_discount", "curl_definition": "DELETE /v1/customers/:id/discount" }, - { - "anchor": "delete_subscription_discount", - "curl_definition": "DELETE /v1/subscriptions/:id/discount" - } - ] - } - }, - "discount_object": { - "title": "The discount object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "discount_object", - "section_anchor": "discounts", - "subsection_anchors": null, - "path": "/discounts/object", - "gate": false, - "display_on_load": false - }, - "delete_discount": { - "title": "Delete a customer discount", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "delete_discount", - "section_anchor": "discounts", - "subsection_anchors": null, - "path": "/discounts/delete", - "gate": false, - "display_on_load": false - }, - "delete_subscription_discount": { - "title": "Delete a subscription discount", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "delete_subscription_discount", - "section_anchor": "discounts", - "subsection_anchors": null, - "path": "/discounts/subscription_delete", - "gate": false, - "display_on_load": false - }, - "tax_codes": { - "title": "Tax Codes", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "tax_codes", - "section_anchor": "tax_codes", - "subsection_anchors": ["tax_code_object", "list_tax_codes", "retrieve_taxcode"], - "path": "/tax_codes", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Tax Code", - "description": "[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.\n", - "section_tag": "tax_codes", - "subsection_summaries": [ - { "anchor": "tax_code_object", "curl_definition": null }, - { "anchor": "list_tax_codes", "curl_definition": "GET /v1/tax_codes" }, - { "anchor": "retrieve_taxcode", "curl_definition": "GET /v1/tax_codes/:id" } - ] - } - }, - "tax_code_object": { - "title": "The tax code object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "tax_code_object", - "section_anchor": "tax_codes", - "subsection_anchors": null, - "path": "/tax_codes/object", - "gate": false, - "display_on_load": false - }, - "list_tax_codes": { - "title": "List all tax codes", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "list_tax_codes", - "section_anchor": "tax_codes", - "subsection_anchors": null, - "path": "/tax_codes/list", - "gate": false, - "display_on_load": false - }, - "retrieve_taxcode": { - "title": "Retrieve a tax code", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "retrieve_taxcode", - "section_anchor": "tax_codes", - "subsection_anchors": null, - "path": "/tax_codes/retrieve", - "gate": false, - "display_on_load": false - }, - "tax_rates": { - "title": "Tax Rates", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "tax_rates", - "section_anchor": "tax_rates", - "subsection_anchors": [ - "tax_rate_object", - "create_tax_rate", - "retrieve_tax_rate", - "update_tax_rate", - "list_tax_rates" - ], - "path": "/tax_rates", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Tax Rate", - "description": "Tax rates can be applied to [invoices](/docs/billing/invoices/tax-rates), [subscriptions](/docs/billing/subscriptions/taxes) and [Checkout Sessions](/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](/docs/billing/taxes/tax-rates).\n", - "section_tag": "tax_rates", - "subsection_summaries": [ - { "anchor": "tax_rate_object", "curl_definition": null }, - { "anchor": "create_tax_rate", "curl_definition": "POST /v1/tax_rates" }, - { "anchor": "retrieve_tax_rate", "curl_definition": "GET /v1/tax_rates/:id" }, - { "anchor": "update_tax_rate", "curl_definition": "POST /v1/tax_rates/:id" }, - { "anchor": "list_tax_rates", "curl_definition": "GET /v1/tax_rates" } - ] - } - }, - "tax_rate_object": { - "title": "The tax rate object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "tax_rate_object", - "section_anchor": "tax_rates", - "subsection_anchors": null, - "path": "/tax_rates/object", - "gate": false, - "display_on_load": false - }, - "create_tax_rate": { - "title": "Create a tax rate", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "create_tax_rate", - "section_anchor": "tax_rates", - "subsection_anchors": null, - "path": "/tax_rates/create", - "gate": false, - "display_on_load": false - }, - "retrieve_tax_rate": { - "title": "Retrieves a tax rate", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "retrieve_tax_rate", - "section_anchor": "tax_rates", - "subsection_anchors": null, - "path": "/tax_rates/retrieve", - "gate": false, - "display_on_load": false - }, - "update_tax_rate": { - "title": "Update a tax rate", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "update_tax_rate", - "section_anchor": "tax_rates", - "subsection_anchors": null, - "path": "/tax_rates/update", - "gate": false, - "display_on_load": false - }, - "list_tax_rates": { - "title": "List all tax rates", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "list_tax_rates", - "section_anchor": "tax_rates", - "subsection_anchors": null, - "path": "/tax_rates/list", - "gate": false, - "display_on_load": false - }, - "shipping_rates": { - "title": "Shipping Rates", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "shipping_rates", - "section_anchor": "shipping_rates", - "subsection_anchors": [ - "shipping_rate_object", - "create_shipping_rate", - "retrieve_shipping_rate", - "update_shipping_rate", - "list_shipping_rates" - ], - "path": "/shipping_rates", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Shipping Rates", - "description": "Shipping rates describe the price of shipping presented to your customers and can be\napplied to [Checkout Sessions](/docs/payments/checkout/shipping)\nand [Orders](/docs/orders/shipping) to collect shipping costs.\n", - "section_tag": "shipping_rates", - "subsection_summaries": [ - { "anchor": "shipping_rate_object", "curl_definition": null }, - { "anchor": "create_shipping_rate", "curl_definition": "POST /v1/shipping_rates" }, - { "anchor": "retrieve_shipping_rate", "curl_definition": "GET /v1/shipping_rates/:id" }, - { "anchor": "update_shipping_rate", "curl_definition": "POST /v1/shipping_rates/:id" }, - { "anchor": "list_shipping_rates", "curl_definition": "GET /v1/shipping_rates" } - ] - } - }, - "shipping_rate_object": { - "title": "The shipping rate object", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "shipping_rate_object", - "section_anchor": "shipping_rates", - "subsection_anchors": null, - "path": "/shipping_rates/object", - "gate": false, - "display_on_load": false - }, - "create_shipping_rate": { - "title": "Create a shipping rate", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "create_shipping_rate", - "section_anchor": "shipping_rates", - "subsection_anchors": null, - "path": "/shipping_rates/create", - "gate": false, - "display_on_load": false - }, - "retrieve_shipping_rate": { - "title": "Retrieve a shipping rate", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "retrieve_shipping_rate", - "section_anchor": "shipping_rates", - "subsection_anchors": null, - "path": "/shipping_rates/retrieve", - "gate": false, - "display_on_load": false - }, - "update_shipping_rate": { - "title": "Update a shipping rate", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "update_shipping_rate", - "section_anchor": "shipping_rates", - "subsection_anchors": null, - "path": "/shipping_rates/update", - "gate": false, - "display_on_load": false - }, - "list_shipping_rates": { - "title": "List all shipping rates", - "group_title": "Products", - "group_anchor": "products_section", - "anchor": "list_shipping_rates", - "section_anchor": "shipping_rates", - "subsection_anchors": null, - "path": "/shipping_rates/list", - "gate": false, - "display_on_load": false - }, - "checkout_sessions": { - "title": "Checkout Sessions", - "group_title": "Checkout", - "group_anchor": "checkout", - "anchor": "checkout_sessions", - "section_anchor": "checkout_sessions", - "subsection_anchors": [ - "checkout_session_object", - "create_checkout_session", - "expire_checkout_session", - "retrieve_checkout_session", - "list_checkout_sessions", - "retrieve_checkout_session_line_items" - ], - "path": "/checkout/sessions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Sessions", - "description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](/docs/payments/checkout)\nor [Payment Links](/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](/docs/api/customers), and either the successful\n[PaymentIntent](/docs/api/payment_intents) or an active\n[Subscription](/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and pass its ID to the\nclient to begin Checkout.\n\nRelated guide: [Checkout Quickstart](/docs/checkout/quickstart).\n", - "section_tag": "checkout_sessions", - "subsection_summaries": [ - { "anchor": "checkout_session_object", "curl_definition": null }, - { "anchor": "create_checkout_session", "curl_definition": "POST /v1/checkout/sessions" }, - { - "anchor": "expire_checkout_session", - "curl_definition": "POST /v1/checkout/sessions/:id/expire" - }, - { - "anchor": "retrieve_checkout_session", - "curl_definition": "GET /v1/checkout/sessions/:id" - }, - { "anchor": "list_checkout_sessions", "curl_definition": "GET /v1/checkout/sessions" }, - { - "anchor": "retrieve_checkout_session_line_items", - "curl_definition": "GET /v1/checkout/sessions/:id/line_items" - } - ] - } - }, - "checkout_session_object": { - "title": "The Checkout Session object", - "group_title": "Checkout", - "group_anchor": "checkout", - "anchor": "checkout_session_object", - "section_anchor": "checkout_sessions", - "subsection_anchors": null, - "path": "/checkout/sessions/object", - "gate": false, - "display_on_load": false - }, - "create_checkout_session": { - "title": "Create a Checkout Session", - "group_title": "Checkout", - "group_anchor": "checkout", - "anchor": "create_checkout_session", - "section_anchor": "checkout_sessions", - "subsection_anchors": null, - "path": "/checkout/sessions/create", - "gate": false, - "display_on_load": false - }, - "expire_checkout_session": { - "title": "Expire a Checkout Session", - "group_title": "Checkout", - "group_anchor": "checkout", - "anchor": "expire_checkout_session", - "section_anchor": "checkout_sessions", - "subsection_anchors": null, - "path": "/checkout/sessions/expire", - "gate": false, - "display_on_load": false - }, - "retrieve_checkout_session": { - "title": "Retrieve a Checkout Session", - "group_title": "Checkout", - "group_anchor": "checkout", - "anchor": "retrieve_checkout_session", - "section_anchor": "checkout_sessions", - "subsection_anchors": null, - "path": "/checkout/sessions/retrieve", - "gate": false, - "display_on_load": false - }, - "list_checkout_sessions": { - "title": "List all Checkout Sessions", - "group_title": "Checkout", - "group_anchor": "checkout", - "anchor": "list_checkout_sessions", - "section_anchor": "checkout_sessions", - "subsection_anchors": null, - "path": "/checkout/sessions/list", - "gate": false, - "display_on_load": false - }, - "retrieve_checkout_session_line_items": { - "title": "Retrieve a Checkout Session's line items", - "group_title": "Checkout", - "group_anchor": "checkout", - "anchor": "retrieve_checkout_session_line_items", - "section_anchor": "checkout_sessions", - "subsection_anchors": null, - "path": "/checkout/sessions/line_items", - "gate": false, - "display_on_load": false - }, - "payment_links": { - "title": "Payment Links", - "group_title": "Payment Links", - "group_anchor": "payment_links_section", - "anchor": "payment_links", - "section_anchor": "payment_links", - "subsection_anchors": [ - "payment_link_object", - "create_payment_link", - "retrieve_payment_link", - "update_payment_link", - "list_payment_link", - "retrieve_payment_link_line_items" - ], - "path": "/payment_links/payment_links", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "resource", - "title": "Payment Link", - "description": "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](/docs/payments/payment-links/api)\n", - "section_tag": "payment_links", - "subsection_summaries": [ - { "anchor": "payment_link_object", "curl_definition": null }, - { "anchor": "create_payment_link", "curl_definition": "POST /v1/payment_links" }, - { "anchor": "retrieve_payment_link", "curl_definition": "GET /v1/payment_links/:id" }, - { "anchor": "update_payment_link", "curl_definition": "POST /v1/payment_links/:id" }, - { "anchor": "list_payment_link", "curl_definition": "GET /v1/payment_links" }, - { - "anchor": "retrieve_payment_link_line_items", - "curl_definition": "GET /v1/payment_links/:id/line_items" - } - ] - } - }, - "payment_link_object": { - "title": "The payment link object", - "group_title": "Payment Links", - "group_anchor": "payment_links_section", - "anchor": "payment_link_object", - "section_anchor": "payment_links", - "subsection_anchors": null, - "path": "/payment_links/payment_links/object", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "response", - "section_tag": "payment_link_object", - "doc_object_type": "payment_link", - "object_type": "payment_link", - "title": "The payment link object", - "specs": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "active": { - "name": "active", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.", - "undocumented": false, - "html": "Whether the payment link’s \u003Ccode\u003Eurl\u003C/code\u003E is active. If \u003Ccode\u003Efalse\u003C/code\u003E, customers visiting the URL will be shown a page saying that the link has been deactivated." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "active" - }, - "after_completion": { - "name": "after_completion", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Behavior after the purchase is complete.", - "undocumented": false, - "html": "Behavior after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "hosted_confirmation": { - "name": "hosted_confirmation", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration when `type=hosted_confirmation`.", - "undocumented": false, - "html": "Configuration when \u003Ccode\u003Etype=hosted_confirmation\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "custom_message": { - "name": "custom_message", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The custom message that is displayed to the customer after the purchase is complete.", - "undocumented": false, - "html": "The custom message that is displayed to the customer after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "custom_message" - } - }, - "object_type": "hosted_confirmation" - }, - "redirect": { - "name": "redirect", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration when `type=redirect`.", - "undocumented": false, - "html": "Configuration when \u003Ccode\u003Etype=redirect\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "url": { - "name": "url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL the customer will be redirected to after the purchase is complete.", - "undocumented": false, - "html": "The URL the customer will be redirected to after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "url" - } - }, - "object_type": "redirect" - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The specified behavior after the purchase is complete.", - "undocumented": false, - "html": "The specified behavior after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "redirect": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Redirects the customer to the specified `url` after the purchase is complete.", - "undocumented": false, - "html": "Redirects the customer to the specified \u003Ccode\u003Eurl\u003C/code\u003E after the purchase is complete." - } - }, - "hosted_confirmation": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Displays a message on the hosted surface after the purchase is complete.", - "undocumented": false, - "html": "Displays a message on the hosted surface after the purchase is complete." - } - } - }, - "object_type": "type" - } - }, - "object_type": "after_completion", - "less_common": true - }, - "allow_promotion_codes": { - "name": "allow_promotion_codes", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether user redeemable promotion codes are enabled.", - "undocumented": false, - "html": "Whether user redeemable promotion codes are enabled." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "allow_promotion_codes", - "less_common": true - }, - "application_fee_amount": { - "name": "application_fee_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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. ", - "undocumented": false, - "html": "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. " - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_fee_amount", - "less_common": true - }, - "application_fee_percent": { - "name": "application_fee_percent", - "check": "decimal", - "validation": "decimal", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.", - "undocumented": false, - "html": "This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "application_fee_percent", - "less_common": true - }, - "automatic_tax": { - "name": "automatic_tax", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration details for automatic tax collection.", - "undocumented": false, - "html": "Configuration details for automatic tax collection." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "enabled": { - "name": "enabled", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If `true`, tax will be calculated automatically using the customer's location.", - "undocumented": false, - "html": "If \u003Ccode\u003Etrue\u003C/code\u003E, tax will be calculated automatically using the customer’s location." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "enabled" - } - }, - "object_type": "automatic_tax", - "less_common": true - }, - "billing_address_collection": { - "name": "billing_address_collection", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for collecting the customer's billing address.", - "undocumented": false, - "html": "Configuration for collecting the customer’s billing address." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "auto": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checkout will only collect the billing address when necessary.", - "undocumented": false, - "badge_text": "Default", - "html": "Checkout will only collect the billing address when necessary." - } - }, - "required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checkout will always collect the customer's billing address.", - "undocumented": false, - "html": "Checkout will always collect the customer’s billing address." - } - } - }, - "object_type": "billing_address_collection", - "less_common": true - }, - "consent_collection": { - "name": "consent_collection", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When set, provides configuration to gather active consent from customers.", - "undocumented": false, - "html": "When set, provides configuration to gather active consent from customers." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "promotions": { - "name": "promotions", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If set to `auto`, enables the collection of customer consent for promotional communications.", - "undocumented": false, - "html": "If set to \u003Ccode\u003Eauto\u003C/code\u003E, enables the collection of customer consent for promotional communications." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "promotions" - }, - "terms_of_service": { - "name": "terms_of_service", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.", - "undocumented": false, - "html": "If set to \u003Ccode\u003Erequired\u003C/code\u003E, it requires cutomers to accept the terms of service before being able to pay. If set to \u003Ccode\u003Enone\u003C/code\u003E, customers won’t be shown a checkbox to accept the terms of service." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "terms_of_service" - } - }, - "object_type": "consent_collection", - "less_common": true - }, - "currency": { - "name": "currency", - "check": "currency", - "validation": "currency", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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).", - "undocumented": false, - "html": "Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "currency", - "less_common": true - }, - "custom_text": { - "name": "custom_text", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Display additional text for your customers using custom text. ", - "undocumented": false, - "html": "Display additional text for your customers using custom text. " - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "shipping_address": { - "name": "shipping_address", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Custom text that should be displayed alongside shipping address collection.", - "undocumented": false, - "html": "Custom text that should be displayed alongside shipping address collection." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "message": { - "name": "message", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Text may be up to 1000 characters in length.", - "undocumented": false, - "html": "Text may be up to 1000 characters in length." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "message" - } - }, - "object_type": "shipping_address" - }, - "submit": { - "name": "submit", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Custom text that should be displayed alongside the payment confirmation button.", - "undocumented": false, - "html": "Custom text that should be displayed alongside the payment confirmation button." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "message": { - "name": "message", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Text may be up to 1000 characters in length.", - "undocumented": false, - "html": "Text may be up to 1000 characters in length." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "message" - } - }, - "object_type": "submit" - } - }, - "object_type": "custom_text", - "less_common": true - }, - "customer_creation": { - "name": "customer_creation", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for Customer creation during checkout.", - "undocumented": false, - "html": "Configuration for Customer creation during checkout." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "if_required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will only create a [Customer](/docs/api/customers) if it is required for Session confirmation.\nCurrently, only `subscription` mode Sessions require a Customer.\n", - "undocumented": false, - "html": "The Checkout Session will only create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E if it is required for Session confirmation.\nCurrently, only \u003Ccode\u003Esubscription\u003C/code\u003E mode Sessions require a Customer." - } - }, - "always": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will always create a [Customer](/docs/api/customers) when a Session confirmation is attempted.\n", - "undocumented": false, - "html": "The Checkout Session will always create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E when a Session confirmation is attempted." - } - } - }, - "object_type": "customer_creation", - "less_common": true - }, - "line_items": { - "name": "line_items", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The line items representing what is being sold.", - "undocumented": false, - "html": "The line items representing what is being sold." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value. Always has the value \u003Ccode\u003Elist\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object" - }, - "data": { - "name": "data", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Details about each object.", - "undocumented": false, - "html": "Details about each object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object" - }, - "amount_discount": { - "name": "amount_discount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Total discount amount applied. If no discounts were applied, defaults to 0.", - "undocumented": false, - "html": "Total discount amount applied. If no discounts were applied, defaults to 0." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_discount" - }, - "amount_subtotal": { - "name": "amount_subtotal", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Total before any discounts or taxes are applied.", - "undocumented": false, - "html": "Total before any discounts or taxes are applied." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_subtotal" - }, - "amount_tax": { - "name": "amount_tax", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Total tax amount applied. If no tax was applied, defaults to 0.", - "undocumented": false, - "html": "Total tax amount applied. If no tax was applied, defaults to 0." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_tax" - }, - "amount_total": { - "name": "amount_total", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Total after discounts and taxes.", - "undocumented": false, - "html": "Total after discounts and taxes." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount_total" - }, - "currency": { - "name": "currency", - "check": "currency", - "validation": "currency", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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).", - "undocumented": false, - "html": "Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "currency" - }, - "description": { - "name": "description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.", - "undocumented": false, - "html": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "description" - }, - "discounts": { - "name": "discounts", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The discounts applied to the line item.", - "undocumented": false, - "html": "The discounts applied to the line item." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "amount": { - "name": "amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The amount discounted.", - "undocumented": false, - "html": "The amount discounted." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "discount": { - "name": "discount", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The discount applied.", - "undocumented": false, - "html": "The discount applied." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "resource_type": "discount", - "resource_type_link": "#discount_object", - "object_type": "discount" - } - }, - "object_type": "discounts" - }, - "price": { - "name": "price", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The price used to generate the line item.", - "undocumented": false, - "html": "The price used to generate the line item." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "active": { - "name": "active", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether the price can be used for new purchases.", - "undocumented": false, - "html": "Whether the price can be used for new purchases." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "active" - }, - "billing_scheme": { - "name": "billing_scheme", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "Describes how to compute the price per period. Either \u003Ccode\u003Eper_unit\u003C/code\u003E or \u003Ccode\u003Etiered\u003C/code\u003E. \u003Ccode\u003Eper_unit\u003C/code\u003E indicates that the fixed amount (specified in \u003Ccode\u003Eunit_amount\u003C/code\u003E or \u003Ccode\u003Eunit_amount_decimal\u003C/code\u003E) will be charged per unit in \u003Ccode\u003Equantity\u003C/code\u003E (for prices with \u003Ccode\u003Eusage_type=licensed\u003C/code\u003E), or per unit of total usage (for prices with \u003Ccode\u003Eusage_type=metered\u003C/code\u003E). \u003Ccode\u003Etiered\u003C/code\u003E indicates that the unit pricing will be computed using a tiering strategy as defined using the \u003Ccode\u003Etiers\u003C/code\u003E and \u003Ccode\u003Etiers_mode\u003C/code\u003E attributes." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "billing_scheme", - "less_common": true - }, - "created": { - "name": "created", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Time at which the object was created. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "created", - "less_common": true - }, - "currency": { - "name": "currency", - "check": "currency", - "validation": "currency", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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).", - "undocumented": false, - "html": "Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "currency" - }, - "currency_options": { - "name": "currency_options", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). For example, to get your price in `eur`, fetch the value of the `eur` key in `currency_options`.", - "undocumented": false, - "html": "Prices defined in each available currency option. Each key must be a three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E and a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E. For example, to get your price in \u003Ccode\u003Eeur\u003C/code\u003E, fetch the value of the \u003Ccode\u003Eeur\u003C/code\u003E key in \u003Ccode\u003Ecurrency_options\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "map_key_name_for_docs": "currency", - "subspec": { - "custom_unit_amount": { - "name": "\u003Ccurrency\u003E.custom_unit_amount", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", - "undocumented": false, - "html": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "maximum": { - "name": "maximum", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The maximum unit amount the customer can specify for this item.", - "undocumented": false, - "html": "The maximum unit amount the customer can specify for this item." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "maximum" - }, - "minimum": { - "name": "minimum", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", - "undocumented": false, - "html": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "minimum" - }, - "preset": { - "name": "preset", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The starting unit amount which can be updated by the customer.", - "undocumented": false, - "html": "The starting unit amount which can be updated by the customer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preset" - } - }, - "object_type": "custom_unit_amount", - "less_common": true - }, - "tax_behavior": { - "name": "\u003Ccurrency\u003E.tax_behavior", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of \u003Ccode\u003Einclusive\u003C/code\u003E, \u003Ccode\u003Eexclusive\u003C/code\u003E, or \u003Ccode\u003Eunspecified\u003C/code\u003E. Once specified as either \u003Ccode\u003Einclusive\u003C/code\u003E or \u003Ccode\u003Eexclusive\u003C/code\u003E, it cannot be changed." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tax_behavior", - "less_common": true - }, - "tiers": { - "name": "\u003Ccurrency\u003E.tiers", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", - "undocumented": false, - "html": "Each element represents a pricing tier. This parameter requires \u003Ccode\u003Ebilling_scheme\u003C/code\u003E to be set to \u003Ccode\u003Etiered\u003C/code\u003E. See also the documentation for \u003Ccode\u003Ebilling_scheme\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "flat_amount": { - "name": "flat_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Price for the entire tier.", - "undocumented": false, - "html": "Price for the entire tier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "flat_amount" - }, - "flat_amount_decimal": { - "name": "flat_amount_decimal", - "check": "decimal_string", - "validation": "decimal string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", - "undocumented": false, - "html": "Same as \u003Ccode\u003Eflat_amount\u003C/code\u003E, but contains a decimal value with at most 12 decimal places." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "flat_amount_decimal" - }, - "unit_amount": { - "name": "unit_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Per unit price for units relevant to the tier.", - "undocumented": false, - "html": "Per unit price for units relevant to the tier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount" - }, - "unit_amount_decimal": { - "name": "unit_amount_decimal", - "check": "decimal_string", - "validation": "decimal string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", - "undocumented": false, - "html": "Same as \u003Ccode\u003Eunit_amount\u003C/code\u003E, but contains a decimal value with at most 12 decimal places." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount_decimal" - }, - "up_to": { - "name": "up_to", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Up to and including to this quantity will be contained in the tier.", - "undocumented": false, - "html": "Up to and including to this quantity will be contained in the tier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "up_to" - } - }, - "object_type": "tiers", - "less_common": true - }, - "unit_amount": { - "name": "\u003Ccurrency\u003E.unit_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": ["currency_sub_unit"], - "markdown": "The unit amount in sen to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", - "undocumented": false, - "html": "The unit amount in sen to be charged, represented as a whole integer if possible. Only set if \u003Ccode\u003Ebilling_scheme=per_unit\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount" - }, - "unit_amount_decimal": { - "name": "\u003Ccurrency\u003E.unit_amount_decimal", - "check": "decimal_string", - "validation": "decimal string", - "documentation": { - "gate_specific": {}, - "localize_terms": ["currency_sub_unit"], - "markdown": "The unit amount in sen to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", - "undocumented": false, - "html": "The unit amount in sen to be charged, represented as a decimal string with at most 12 decimal places. Only set if \u003Ccode\u003Ebilling_scheme=per_unit\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount_decimal", - "less_common": true - } - }, - "object_type": "currency_options", - "less_common": true - }, - "custom_unit_amount": { - "name": "custom_unit_amount", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.", - "undocumented": false, - "html": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "maximum": { - "name": "maximum", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The maximum unit amount the customer can specify for this item.", - "undocumented": false, - "html": "The maximum unit amount the customer can specify for this item." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "maximum" - }, - "minimum": { - "name": "minimum", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.", - "undocumented": false, - "html": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "minimum" - }, - "preset": { - "name": "preset", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The starting unit amount which can be updated by the customer.", - "undocumented": false, - "html": "The starting unit amount which can be updated by the customer." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "preset" - } - }, - "object_type": "custom_unit_amount", - "less_common": true - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "lookup_key": { - "name": "lookup_key", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.", - "undocumented": false, - "html": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "lookup_key", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "nickname": { - "name": "nickname", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A brief description of the price, hidden from customers.", - "undocumented": false, - "html": "A brief description of the price, hidden from customers." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "nickname" - }, - "product": { - "name": "product", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the product this price is associated with.", - "undocumented": false, - "html": "The ID of the product this price is associated with." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["product"], - "object_type": "product" - }, - "recurring": { - "name": "recurring", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The recurring components of a price such as `interval` and `usage_type`.", - "undocumented": false, - "html": "The recurring components of a price such as \u003Ccode\u003Einterval\u003C/code\u003E and \u003Ccode\u003Eusage_type\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "aggregate_usage": { - "name": "aggregate_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`.", - "undocumented": false, - "html": "Specifies a usage aggregation strategy for prices of \u003Ccode\u003Eusage_type=metered\u003C/code\u003E. Allowed values are \u003Ccode\u003Esum\u003C/code\u003E for summing up all usage during a period, \u003Ccode\u003Elast_during_period\u003C/code\u003E for using the last usage record reported within a period, \u003Ccode\u003Elast_ever\u003C/code\u003E for using the last usage record ever (across period bounds) or \u003Ccode\u003Emax\u003C/code\u003E which uses the usage record with the maximum reported usage during a period. Defaults to \u003Ccode\u003Esum\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "aggregate_usage", - "less_common": true - }, - "interval": { - "name": "interval", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.", - "undocumented": false, - "html": "The frequency at which a subscription is billed. One of \u003Ccode\u003Eday\u003C/code\u003E, \u003Ccode\u003Eweek\u003C/code\u003E, \u003Ccode\u003Emonth\u003C/code\u003E or \u003Ccode\u003Eyear\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "month": { "documentation": null }, - "year": { "documentation": null }, - "week": { "documentation": null }, - "day": { "documentation": null } - }, - "object_type": "interval" - }, - "interval_count": { - "name": "interval_count", - "check": "positive_integer", - "validation": "positive integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", - "undocumented": false, - "html": "The number of intervals (specified in the \u003Ccode\u003Einterval\u003C/code\u003E attribute) between subscription billings. For example, \u003Ccode\u003Einterval=month\u003C/code\u003E and \u003Ccode\u003Einterval_count=3\u003C/code\u003E bills every 3 months." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "interval_count", - "less_common": true - }, - "usage_type": { - "name": "usage_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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`.", - "undocumented": false, - "html": "Configures how the quantity per period should be determined. Can be either \u003Ccode\u003Emetered\u003C/code\u003E or \u003Ccode\u003Elicensed\u003C/code\u003E. \u003Ccode\u003Elicensed\u003C/code\u003E automatically bills the \u003Ccode\u003Equantity\u003C/code\u003E set when adding it to a subscription. \u003Ccode\u003Emetered\u003C/code\u003E aggregates the total usage based on usage records. Defaults to \u003Ccode\u003Elicensed\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "metered": { "documentation": null }, - "licensed": { "documentation": null } - }, - "object_type": "usage_type", - "less_common": true - } - }, - "object_type": "recurring" - }, - "tax_behavior": { - "name": "tax_behavior", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of \u003Ccode\u003Einclusive\u003C/code\u003E, \u003Ccode\u003Eexclusive\u003C/code\u003E, or \u003Ccode\u003Eunspecified\u003C/code\u003E. Once specified as either \u003Ccode\u003Einclusive\u003C/code\u003E or \u003Ccode\u003Eexclusive\u003C/code\u003E, it cannot be changed." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tax_behavior", - "less_common": true - }, - "tiers": { - "name": "tiers", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.", - "undocumented": false, - "html": "Each element represents a pricing tier. This parameter requires \u003Ccode\u003Ebilling_scheme\u003C/code\u003E to be set to \u003Ccode\u003Etiered\u003C/code\u003E. See also the documentation for \u003Ccode\u003Ebilling_scheme\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "flat_amount": { - "name": "flat_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Price for the entire tier.", - "undocumented": false, - "html": "Price for the entire tier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "flat_amount" - }, - "flat_amount_decimal": { - "name": "flat_amount_decimal", - "check": "decimal_string", - "validation": "decimal string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", - "undocumented": false, - "html": "Same as \u003Ccode\u003Eflat_amount\u003C/code\u003E, but contains a decimal value with at most 12 decimal places." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "flat_amount_decimal" - }, - "unit_amount": { - "name": "unit_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Per unit price for units relevant to the tier.", - "undocumented": false, - "html": "Per unit price for units relevant to the tier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount" - }, - "unit_amount_decimal": { - "name": "unit_amount_decimal", - "check": "decimal_string", - "validation": "decimal string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", - "undocumented": false, - "html": "Same as \u003Ccode\u003Eunit_amount\u003C/code\u003E, but contains a decimal value with at most 12 decimal places." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount_decimal" - }, - "up_to": { - "name": "up_to", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Up to and including to this quantity will be contained in the tier.", - "undocumented": false, - "html": "Up to and including to this quantity will be contained in the tier." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "up_to" - } - }, - "object_type": "tiers", - "less_common": true - }, - "tiers_mode": { - "name": "tiers_mode", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "Defines if the tiering price should be \u003Ccode\u003Egraduated\u003C/code\u003E or \u003Ccode\u003Evolume\u003C/code\u003E based. In \u003Ccode\u003Evolume\u003C/code\u003E-based tiering, the maximum quantity within a period determines the per unit price. In \u003Ccode\u003Egraduated\u003C/code\u003E tiering, pricing can change as the quantity grows." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tiers_mode", - "less_common": true - }, - "transform_quantity": { - "name": "transform_quantity", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.", - "undocumented": false, - "html": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with \u003Ccode\u003Etiers\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "divide_by": { - "name": "divide_by", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Divide usage by this number.", - "undocumented": false, - "html": "Divide usage by this number." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "divide_by" - }, - "round": { - "name": "round", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "After division, either round the result `up` or `down`.", - "undocumented": false, - "html": "After division, either round the result \u003Ccode\u003Eup\u003C/code\u003E or \u003Ccode\u003Edown\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "up": { "documentation": null }, - "down": { "documentation": null } - }, - "object_type": "round" - } - }, - "object_type": "transform_quantity", - "less_common": true - }, - "type": { - "name": "type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.", - "undocumented": false, - "html": "One of \u003Ccode\u003Eone_time\u003C/code\u003E or \u003Ccode\u003Erecurring\u003C/code\u003E depending on whether the price is for a one-time purchase or a recurring (subscription) purchase." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "type" - }, - "unit_amount": { - "name": "unit_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": ["currency_sub_unit"], - "markdown": "The unit amount in sen to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", - "undocumented": false, - "html": "The unit amount in sen to be charged, represented as a whole integer if possible. Only set if \u003Ccode\u003Ebilling_scheme=per_unit\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount" - }, - "unit_amount_decimal": { - "name": "unit_amount_decimal", - "check": "decimal_string", - "validation": "decimal string", - "documentation": { - "gate_specific": {}, - "localize_terms": ["currency_sub_unit"], - "markdown": "The unit amount in sen to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", - "undocumented": false, - "html": "The unit amount in sen to be charged, represented as a decimal string with at most 12 decimal places. Only set if \u003Ccode\u003Ebilling_scheme=per_unit\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "unit_amount_decimal", - "less_common": true - } - }, - "object_type": "price" - }, - "quantity": { - "name": "quantity", - "check": "nonnegative_integer", - "validation": "positive integer or zero", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The quantity of products being purchased.", - "undocumented": false, - "html": "The quantity of products being purchased." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "quantity" - }, - "taxes": { - "name": "taxes", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The taxes applied to the line item.", - "undocumented": false, - "html": "The taxes applied to the line item." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": true, - "subspec": { - "amount": { - "name": "amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Amount of tax applied for this rate.", - "undocumented": false, - "html": "Amount of tax applied for this rate." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "rate": { - "name": "rate", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The tax rate applied.", - "undocumented": false, - "html": "The tax rate applied." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "id": { - "name": "id", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Unique identifier for the object.", - "undocumented": false, - "html": "Unique identifier for the object." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "id" - }, - "object": { - "name": "object", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "String representing the object's type. Objects of the same type share the same value.", - "undocumented": false, - "html": "String representing the object’s type. Objects of the same type share the same value." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "object", - "less_common": true - }, - "active": { - "name": "active", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "Defaults to \u003Ccode\u003Etrue\u003C/code\u003E. When set to \u003Ccode\u003Efalse\u003C/code\u003E, 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." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "active" - }, - "country": { - "name": "country", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", - "undocumented": false, - "html": "Two-letter country code (\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\"\u003EISO 3166-1 alpha-2\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "country" - }, - "created": { - "name": "created", - "check": "timestamp", - "validation": "timestamp", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "undocumented": false, - "html": "Time at which the object was created. Measured in seconds since the Unix epoch." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "created", - "less_common": true - }, - "description": { - "name": "description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", - "undocumented": false, - "html": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "description" - }, - "display_name": { - "name": "display_name", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.", - "undocumented": false, - "html": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "display_name" - }, - "inclusive": { - "name": "inclusive", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "This specifies if the tax rate is inclusive or exclusive.", - "undocumented": false, - "html": "This specifies if the tax rate is inclusive or exclusive." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "inclusive" - }, - "jurisdiction": { - "name": "jurisdiction", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", - "undocumented": false, - "html": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "jurisdiction" - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "percentage": { - "name": "percentage", - "check": "decimal", - "validation": "decimal", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "This represents the tax rate percent out of 100.", - "undocumented": false, - "html": "This represents the tax rate percent out of 100." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "percentage" - }, - "state": { - "name": "state", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "[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.", - "undocumented": false, - "html": "\u003Ca href=\"https://en.wikipedia.org/wiki/ISO_3166-2:US\"\u003EISO 3166-2 subdivision code\u003C/a\u003E, without country prefix. For example, “NY” for New York, United States." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "state" - }, - "tax_type": { - "name": "tax_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The high-level tax type, such as `vat` or `sales_tax`.", - "undocumented": false, - "html": "The high-level tax type, such as \u003Ccode\u003Evat\u003C/code\u003E or \u003Ccode\u003Esales_tax\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "tax_type", - "less_common": true - } - }, - "object_type": "tax_rate" - } - }, - "object_type": "taxes" - } - }, - "object_type": "item" - }, - "has_more": { - "name": "has_more", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "True if this list has another page of items after this one that can be fetched.", - "undocumented": false, - "html": "True if this list has another page of items after this one that can be fetched." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "has_more" - }, - "url": { - "name": "url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL where this list can be accessed.", - "undocumented": false, - "html": "The URL where this list can be accessed." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "url" - } - }, - "object_type": "list" - }, - "livemode": { - "name": "livemode", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "undocumented": false, - "html": "Has the value \u003Ccode\u003Etrue\u003C/code\u003E if the object exists in live mode or the value \u003Ccode\u003Efalse\u003C/code\u003E if the object exists in test mode." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "livemode", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "metadata" - }, - "on_behalf_of": { - "name": "on_behalf_of", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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.", - "undocumented": false, - "html": "The account on behalf of which to charge. See the \u003Ca href=\"https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts\"\u003EConnect documentation\u003C/a\u003E for details." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["account"], - "object_type": "on_behalf_of", - "less_common": true - }, - "payment_intent_data": { - "name": "payment_intent_data", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates the parameters to be passed to PaymentIntent creation during checkout.", - "undocumented": false, - "html": "Indicates the parameters to be passed to PaymentIntent creation during checkout." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates when the funds will be captured from the customer's account.", - "undocumented": false, - "html": "Indicates when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "(Default) Stripe automatically captures funds when the customer authorizes the payment.", - "undocumented": false, - "html": "(Default) Stripe automatically captures funds when the customer authorizes the payment." - } - }, - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Place a hold on the funds when the customer authorizes the payment, but [don't capture the funds until later](/docs/payments/capture-later). (Not all payment methods support this.)", - "undocumented": false, - "html": "Place a hold on the funds when the customer authorizes the payment, but \u003Ca href=\"/docs/payments/capture-later\"\u003Edon’t capture the funds until later\u003C/a\u003E. (Not all payment methods support this.)" - } - } - }, - "object_type": "capture_method" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to make future payments with the payment method collected during checkout.", - "undocumented": false, - "html": "Indicates that you intend to make future payments with the payment method collected during checkout." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "object_type": "payment_intent_data", - "less_common": true - }, - "payment_method_collection": { - "name": "payment_method_collection", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for collecting a payment method during checkout.", - "undocumented": false, - "html": "Configuration for collecting a payment method during checkout." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "always": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will always collect a PaymentMethod.\n", - "undocumented": false, - "html": "The Checkout Session will always collect a PaymentMethod." - } - }, - "if_required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will only collect a PaymentMethod if there is an amount due.\n", - "undocumented": false, - "html": "The Checkout Session will only collect a PaymentMethod if there is an amount due." - } - } - }, - "object_type": "payment_method_collection", - "less_common": true - }, - "payment_method_types": { - "name": "payment_method_types", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).", - "undocumented": false, - "html": "The list of payment method types that customers can use. When \u003Ccode\u003Enull\u003C/code\u003E, Stripe will dynamically show relevant payment methods you’ve enabled in your \u003Ca href=\"https://dashboard.stripe.com/settings/payment_methods\"\u003Epayment method settings\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "card": { "documentation": null }, - "affirm": { "documentation": null }, - "promptpay": { "documentation": null }, - "bacs_debit": { "documentation": null }, - "bancontact": { "documentation": null }, - "blik": { "documentation": null }, - "boleto": { "documentation": null }, - "eps": { "documentation": null }, - "fpx": { "documentation": null }, - "giropay": { "documentation": null }, - "grabpay": { "documentation": null }, - "ideal": { "documentation": null }, - "klarna": { "documentation": null }, - "konbini": { "documentation": null }, - "oxxo": { "documentation": null }, - "p24": { "documentation": null }, - "paynow": { "documentation": null }, - "pix": { "documentation": null }, - "afterpay_clearpay": { "documentation": null }, - "alipay": { "documentation": null }, - "au_becs_debit": { "documentation": null }, - "sepa_debit": { "documentation": null }, - "sofort": { "documentation": null }, - "us_bank_account": { "documentation": null }, - "wechat_pay": { "documentation": null } - }, - "object_type": "payment_method_types" - }, - "phone_number_collection": { - "name": "phone_number_collection", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls phone number collection settings during checkout.", - "undocumented": false, - "html": "Controls phone number collection settings during checkout." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "enabled": { - "name": "enabled", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If `true`, a phone number will be collected during checkout.", - "undocumented": false, - "html": "If \u003Ccode\u003Etrue\u003C/code\u003E, a phone number will be collected during checkout." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "enabled" - } - }, - "object_type": "phone_number_collection", - "less_common": true - }, - "shipping_address_collection": { - "name": "shipping_address_collection", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for collecting the customer's shipping address.", - "undocumented": false, - "html": "Configuration for collecting the customer’s shipping address." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "allowed_countries": { - "name": "allowed_countries", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.\n", - "undocumented": false, - "html": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: \u003Ccode\u003EAS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "AC": { "documentation": null }, - "AD": { "documentation": null }, - "AE": { "documentation": null }, - "AF": { "documentation": null }, - "AG": { "documentation": null }, - "AI": { "documentation": null }, - "AL": { "documentation": null }, - "AM": { "documentation": null }, - "AO": { "documentation": null }, - "AQ": { "documentation": null }, - "AR": { "documentation": null }, - "AT": { "documentation": null }, - "AU": { "documentation": null }, - "AW": { "documentation": null }, - "AX": { "documentation": null }, - "AZ": { "documentation": null }, - "BA": { "documentation": null }, - "BB": { "documentation": null }, - "BD": { "documentation": null }, - "BE": { "documentation": null }, - "BF": { "documentation": null }, - "BG": { "documentation": null }, - "BH": { "documentation": null }, - "BI": { "documentation": null }, - "BJ": { "documentation": null }, - "BL": { "documentation": null }, - "BM": { "documentation": null }, - "BN": { "documentation": null }, - "BO": { "documentation": null }, - "BQ": { "documentation": null }, - "BR": { "documentation": null }, - "BS": { "documentation": null }, - "BT": { "documentation": null }, - "BV": { "documentation": null }, - "BW": { "documentation": null }, - "BY": { "documentation": null }, - "BZ": { "documentation": null }, - "CA": { "documentation": null }, - "CD": { "documentation": null }, - "CF": { "documentation": null }, - "CG": { "documentation": null }, - "CH": { "documentation": null }, - "CI": { "documentation": null }, - "CK": { "documentation": null }, - "CL": { "documentation": null }, - "CM": { "documentation": null }, - "CN": { "documentation": null }, - "CO": { "documentation": null }, - "CR": { "documentation": null }, - "CV": { "documentation": null }, - "CW": { "documentation": null }, - "CY": { "documentation": null }, - "CZ": { "documentation": null }, - "DE": { "documentation": null }, - "DJ": { "documentation": null }, - "DK": { "documentation": null }, - "DM": { "documentation": null }, - "DO": { "documentation": null }, - "DZ": { "documentation": null }, - "EC": { "documentation": null }, - "EE": { "documentation": null }, - "EG": { "documentation": null }, - "EH": { "documentation": null }, - "ER": { "documentation": null }, - "ES": { "documentation": null }, - "ET": { "documentation": null }, - "FI": { "documentation": null }, - "FJ": { "documentation": null }, - "FK": { "documentation": null }, - "FO": { "documentation": null }, - "FR": { "documentation": null }, - "GA": { "documentation": null }, - "GB": { "documentation": null }, - "GD": { "documentation": null }, - "GE": { "documentation": null }, - "GF": { "documentation": null }, - "GG": { "documentation": null }, - "GH": { "documentation": null }, - "GI": { "documentation": null }, - "GL": { "documentation": null }, - "GM": { "documentation": null }, - "GN": { "documentation": null }, - "GP": { "documentation": null }, - "GQ": { "documentation": null }, - "GR": { "documentation": null }, - "GS": { "documentation": null }, - "GT": { "documentation": null }, - "GU": { "documentation": null }, - "GW": { "documentation": null }, - "GY": { "documentation": null }, - "HK": { "documentation": null }, - "HN": { "documentation": null }, - "HR": { "documentation": null }, - "HT": { "documentation": null }, - "HU": { "documentation": null }, - "ID": { "documentation": null }, - "IE": { "documentation": null }, - "IL": { "documentation": null }, - "IM": { "documentation": null }, - "IN": { "documentation": null }, - "IO": { "documentation": null }, - "IQ": { "documentation": null }, - "IS": { "documentation": null }, - "IT": { "documentation": null }, - "JE": { "documentation": null }, - "JM": { "documentation": null }, - "JO": { "documentation": null }, - "JP": { "documentation": null }, - "KE": { "documentation": null }, - "KG": { "documentation": null }, - "KH": { "documentation": null }, - "KI": { "documentation": null }, - "KM": { "documentation": null }, - "KN": { "documentation": null }, - "KR": { "documentation": null }, - "KW": { "documentation": null }, - "KY": { "documentation": null }, - "KZ": { "documentation": null }, - "LA": { "documentation": null }, - "LB": { "documentation": null }, - "LC": { "documentation": null }, - "LI": { "documentation": null }, - "LK": { "documentation": null }, - "LR": { "documentation": null }, - "LS": { "documentation": null }, - "LT": { "documentation": null }, - "LU": { "documentation": null }, - "LV": { "documentation": null }, - "LY": { "documentation": null }, - "MA": { "documentation": null }, - "MC": { "documentation": null }, - "MD": { "documentation": null }, - "ME": { "documentation": null }, - "MF": { "documentation": null }, - "MG": { "documentation": null }, - "MK": { "documentation": null }, - "ML": { "documentation": null }, - "MM": { "documentation": null }, - "MN": { "documentation": null }, - "MO": { "documentation": null }, - "MQ": { "documentation": null }, - "MR": { "documentation": null }, - "MS": { "documentation": null }, - "MT": { "documentation": null }, - "MU": { "documentation": null }, - "MV": { "documentation": null }, - "MW": { "documentation": null }, - "MX": { "documentation": null }, - "MY": { "documentation": null }, - "MZ": { "documentation": null }, - "NA": { "documentation": null }, - "NC": { "documentation": null }, - "NE": { "documentation": null }, - "NG": { "documentation": null }, - "NI": { "documentation": null }, - "NL": { "documentation": null }, - "NO": { "documentation": null }, - "NP": { "documentation": null }, - "NR": { "documentation": null }, - "NU": { "documentation": null }, - "NZ": { "documentation": null }, - "OM": { "documentation": null }, - "PA": { "documentation": null }, - "PE": { "documentation": null }, - "PF": { "documentation": null }, - "PG": { "documentation": null }, - "PH": { "documentation": null }, - "PK": { "documentation": null }, - "PL": { "documentation": null }, - "PM": { "documentation": null }, - "PN": { "documentation": null }, - "PR": { "documentation": null }, - "PS": { "documentation": null }, - "PT": { "documentation": null }, - "PY": { "documentation": null }, - "QA": { "documentation": null }, - "RE": { "documentation": null }, - "RO": { "documentation": null }, - "RS": { "documentation": null }, - "RU": { "documentation": null }, - "RW": { "documentation": null }, - "SA": { "documentation": null }, - "SB": { "documentation": null }, - "SC": { "documentation": null }, - "SE": { "documentation": null }, - "SG": { "documentation": null }, - "SH": { "documentation": null }, - "SI": { "documentation": null }, - "SJ": { "documentation": null }, - "SK": { "documentation": null }, - "SL": { "documentation": null }, - "SM": { "documentation": null }, - "SN": { "documentation": null }, - "SO": { "documentation": null }, - "SR": { "documentation": null }, - "SS": { "documentation": null }, - "ST": { "documentation": null }, - "SV": { "documentation": null }, - "SX": { "documentation": null }, - "SZ": { "documentation": null }, - "TA": { "documentation": null }, - "TC": { "documentation": null }, - "TD": { "documentation": null }, - "TF": { "documentation": null }, - "TG": { "documentation": null }, - "TH": { "documentation": null }, - "TJ": { "documentation": null }, - "TK": { "documentation": null }, - "TL": { "documentation": null }, - "TM": { "documentation": null }, - "TN": { "documentation": null }, - "TO": { "documentation": null }, - "TR": { "documentation": null }, - "TT": { "documentation": null }, - "TV": { "documentation": null }, - "TW": { "documentation": null }, - "TZ": { "documentation": null }, - "UA": { "documentation": null }, - "UG": { "documentation": null }, - "US": { "documentation": null }, - "UY": { "documentation": null }, - "UZ": { "documentation": null }, - "VA": { "documentation": null }, - "VC": { "documentation": null }, - "VE": { "documentation": null }, - "VG": { "documentation": null }, - "VN": { "documentation": null }, - "VU": { "documentation": null }, - "WF": { "documentation": null }, - "WS": { "documentation": null }, - "XK": { "documentation": null }, - "YE": { "documentation": null }, - "YT": { "documentation": null }, - "ZA": { "documentation": null }, - "ZM": { "documentation": null }, - "ZW": { "documentation": null }, - "ZZ": { "documentation": null } - }, - "object_type": "allowed_countries" - } - }, - "object_type": "shipping_address_collection", - "less_common": true - }, - "shipping_options": { - "name": "shipping_options", - "check": "array", - "validation": "array", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The shipping rate options applied to the session.", - "undocumented": false, - "html": "The shipping rate options applied to the session." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "shipping_amount": { - "name": "shipping_amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A non-negative integer in cents representing how much to charge.", - "undocumented": false, - "html": "A non-negative integer in cents representing how much to charge." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "shipping_amount" - }, - "shipping_rate": { - "name": "shipping_rate", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Shipping Rate to use for this shipping option.", - "undocumented": false, - "html": "The ID of the Shipping Rate to use for this shipping option." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["shipping_rate"], - "object_type": "shipping_rate" - } - }, - "object_type": "shipping_options", - "less_common": true - }, - "submit_type": { - "name": "submit_type", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.", - "undocumented": false, - "html": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "enum_values": { - "auto": { "documentation": null }, - "pay": { "documentation": null }, - "book": { "documentation": null }, - "donate": { "documentation": null } - }, - "object_type": "submit_type", - "less_common": true - }, - "subscription_data": { - "name": "subscription_data", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", - "undocumented": false, - "html": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use \u003Ccode\u003Esubscription_data\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "description": { - "name": "description", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", - "undocumented": false, - "html": "The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "description" - }, - "trial_period_days": { - "name": "trial_period_days", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Integer representing the number of trial period days before the customer is charged for the first time.", - "undocumented": false, - "html": "Integer representing the number of trial period days before the customer is charged for the first time." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "trial_period_days" - } - }, - "object_type": "subscription_data", - "less_common": true - }, - "tax_id_collection": { - "name": "tax_id_collection", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Details on the state of tax ID collection for the payment link.", - "undocumented": false, - "html": "Details on the state of tax ID collection for the payment link." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "enabled": { - "name": "enabled", - "check": "boolean", - "validation": "boolean", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates whether tax ID collection is enabled for the session.", - "undocumented": false, - "html": "Indicates whether tax ID collection is enabled for the session." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "enabled" - } - }, - "object_type": "tax_id_collection", - "less_common": true - }, - "transfer_data": { - "name": "transfer_data", - "check": "hash", - "validation": "hash", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.", - "undocumented": false, - "html": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "subspec": { - "amount": { - "name": "amount", - "check": "integer", - "validation": "integer", - "documentation": { - "gate_specific": {}, - "localize_terms": ["currency_sub_unit"], - "markdown": "The amount in sen that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", - "undocumented": false, - "html": "The amount in sen that will be transferred to the destination account. By default, the entire amount is transferred to the destination." - }, - "gate": false, - "hide_unset_desc": null, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "amount" - }, - "destination": { - "name": "destination", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The connected account receiving the transfer.", - "undocumented": false, - "html": "The connected account receiving the transfer." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "user_expandable": ["account"], - "object_type": "destination" - } - }, - "object_type": "transfer_data", - "less_common": true - }, - "url": { - "name": "url", - "check": "string", - "validation": "string", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The public URL that can be shared with customers.", - "undocumented": false, - "html": "The public URL that can be shared with customers." - }, - "gate": false, - "hide_unset_desc": null, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "includable": null, - "object_type": "url" - } - }, - "snippets": [ - { - "prefix": "", - "code": "{\n \"id\": \"plink_1MWb7e2eZvKYlo2CTAnxRZDR\",\n \"object\": \"payment_link\",\n \"active\": true,\n \"after_completion\": {\n \"hosted_confirmation\": {\n \"custom_message\": null\n },\n \"type\": \"hosted_confirmation\"\n },\n \"allow_promotion_codes\": false,\n \"application_fee_amount\": null,\n \"application_fee_percent\": null,\n \"automatic_tax\": {\n \"enabled\": false\n },\n \"billing_address_collection\": \"auto\",\n \"consent_collection\": null,\n \"currency\": \"usd\",\n \"custom_text\": {\n \"shipping_address\": null,\n \"submit\": null\n },\n \"customer_creation\": \"always\",\n \"livemode\": false,\n \"metadata\": {\n },\n \"on_behalf_of\": null,\n \"payment_intent_data\": null,\n \"payment_method_collection\": \"always\",\n \"payment_method_types\": null,\n \"phone_number_collection\": {\n \"enabled\": false\n },\n \"shipping_address_collection\": null,\n \"shipping_options\": [\n\n ],\n \"submit_type\": \"auto\",\n \"subscription_data\": null,\n \"tax_id_collection\": {\n \"enabled\": false\n },\n \"transfer_data\": null,\n \"url\": \"https://buy.stripe.com/test_5kAcPyarJaIPaQg4gg\"\n}" - } - ], - "top_level_changes": [], - "changes": {}, - "version": null - } - }, - "create_payment_link": { - "title": "Create a payment link", - "group_title": "Payment Links", - "group_anchor": "payment_links_section", - "anchor": "create_payment_link", - "section_anchor": "payment_links", - "subsection_anchors": null, - "path": "/payment_links/payment_links/create", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "request", - "title": "Create a payment link", - "description": "Creates a payment link.", - "top_level_changes": [], - "changes": {}, - "version": null, - "returns": "Returns the payment link.", - "section_tag": "create_payment_link", - "specs": { - "line_items": { - "name": "line_items", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", - "undocumented": false, - "html": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "array_contents_spec": { - "price": { - "name": "price", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the [Price](/docs/api/prices) or [Plan](/docs/api/plans) object.", - "undocumented": false, - "html": "The ID of the \u003Ca href=\"/docs/api/prices\"\u003EPrice\u003C/a\u003E or \u003Ca href=\"/docs/api/plans\"\u003EPlan\u003C/a\u003E object." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "price" - }, - "quantity": { - "name": "quantity", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The quantity of the line item being purchased.", - "undocumented": false, - "html": "The quantity of the line item being purchased." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "quantity" - }, - "adjustable_quantity": { - "name": "adjustable_quantity", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.", - "undocumented": false, - "html": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "enabled": { - "name": "enabled", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set to true if the quantity can be adjusted to any non-negative Integer.", - "undocumented": false, - "html": "Set to true if the quantity can be adjusted to any non-negative Integer." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "enabled" - }, - "maximum": { - "name": "maximum", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.", - "undocumented": false, - "html": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "maximum" - }, - "minimum": { - "name": "minimum", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.", - "undocumented": false, - "html": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item’s quantity cannot go down to 0." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "minimum" - } - }, - "deprecated_allow_empty": false, - "object_type": "adjustable_quantity" - } - }, - "object_type": "line_items" - }, - "after_completion": { - "name": "after_completion", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Behavior after the purchase is complete.", - "undocumented": false, - "html": "Behavior after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "type": { - "name": "type", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.", - "undocumented": false, - "html": "The specified behavior after the purchase is complete. Either \u003Ccode\u003Eredirect\u003C/code\u003E or \u003Ccode\u003Ehosted_confirmation\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "redirect": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Redirects the customer to the specified `url` after the purchase is complete.", - "undocumented": false, - "html": "Redirects the customer to the specified \u003Ccode\u003Eurl\u003C/code\u003E after the purchase is complete." - } - }, - "hosted_confirmation": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Displays a message on the hosted surface after the purchase is complete.", - "undocumented": false, - "html": "Displays a message on the hosted surface after the purchase is complete." - } - } - }, - "object_type": "type" - }, - "hosted_confirmation": { - "name": "hosted_confirmation", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration when `type=hosted_confirmation`.", - "undocumented": false, - "html": "Configuration when \u003Ccode\u003Etype=hosted_confirmation\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "custom_message": { - "name": "custom_message", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A custom message to display to the customer after the purchase is complete.", - "undocumented": false, - "html": "A custom message to display to the customer after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "custom_message" - } - }, - "deprecated_allow_empty": false, - "object_type": "hosted_confirmation" - }, - "redirect": { - "name": "redirect", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration when `type=redirect`.", - "undocumented": false, - "html": "Configuration when \u003Ccode\u003Etype=redirect\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "url": { - "name": "url", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](/docs/api/checkout/sessions/object#checkout_session_object-id) included.", - "undocumented": false, - "html": "The URL the customer will be redirected to after the purchase is complete. You can embed \u003Ccode\u003E{CHECKOUT_SESSION_ID}\u003C/code\u003E into the URL to have the \u003Ccode\u003Eid\u003C/code\u003E of the completed \u003Ca href=\"/docs/api/checkout/sessions/object#checkout_session_object-id\"\u003Echeckout session\u003C/a\u003E included." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "url" - } - }, - "deprecated_allow_empty": false, - "object_type": "redirect" - } - }, - "deprecated_allow_empty": false, - "object_type": "after_completion", - "less_common": true - }, - "allow_promotion_codes": { - "name": "allow_promotion_codes", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Enables user redeemable promotion codes.", - "undocumented": false, - "html": "Enables user redeemable promotion codes." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "allow_promotion_codes", - "less_common": true - }, - "application_fee_amount": { - "name": "application_fee_amount", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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. Can only be applied when there are no line items with recurring prices.", - "undocumented": false, - "html": "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. Can only be applied when there are no line items with recurring prices." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "application_fee_amount", - "less_common": true - }, - "application_fee_percent": { - "name": "application_fee_percent", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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. There must be at least 1 line item with a recurring price to use this field.", - "undocumented": false, - "html": "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. There must be at least 1 line item with a recurring price to use this field." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "application_fee_percent", - "less_common": true - }, - "automatic_tax": { - "name": "automatic_tax", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for automatic tax collection.", - "undocumented": false, - "html": "Configuration for automatic tax collection." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "enabled": { - "name": "enabled", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If `true`, tax will be calculated automatically using the customer's location.", - "undocumented": false, - "html": "If \u003Ccode\u003Etrue\u003C/code\u003E, tax will be calculated automatically using the customer’s location." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "enabled" - } - }, - "deprecated_allow_empty": false, - "object_type": "automatic_tax", - "less_common": true - }, - "billing_address_collection": { - "name": "billing_address_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for collecting the customer's billing address.", - "undocumented": false, - "html": "Configuration for collecting the customer’s billing address." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "auto": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checkout will only collect the billing address when necessary.", - "undocumented": false, - "badge_text": "Default", - "html": "Checkout will only collect the billing address when necessary." - } - }, - "required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checkout will always collect the customer's billing address.", - "undocumented": false, - "html": "Checkout will always collect the customer’s billing address." - } - } - }, - "object_type": "billing_address_collection", - "less_common": true - }, - "consent_collection": { - "name": "consent_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configure fields to gather active consent from customers.", - "undocumented": false, - "html": "Configure fields to gather active consent from customers." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "promotions": { - "name": "promotions", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.\n", - "undocumented": false, - "html": "If set to \u003Ccode\u003Eauto\u003C/code\u003E, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer’s locale. Only available to US merchants." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "auto": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Enable the collection of customer consent for promotional communications.\nThe Checkout Session will determine whether to display an option to opt into promotional\ncommunication from the merchant depending on if a customer is provided, and if that customer\nhas consented to receiving promotional communications from the merchant in the past.\n", - "undocumented": false, - "html": "Enable the collection of customer consent for promotional communications.\nThe Checkout Session will determine whether to display an option to opt into promotional\ncommunication from the merchant depending on if a customer is provided, and if that customer\nhas consented to receiving promotional communications from the merchant in the past." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checkout will not collect customer consent for promotional communications.\n", - "undocumented": false, - "html": "Checkout will not collect customer consent for promotional communications." - } - } - }, - "object_type": "promotions" - }, - "terms_of_service": { - "name": "terms_of_service", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).\n", - "undocumented": false, - "html": "If set to \u003Ccode\u003Erequired\u003C/code\u003E, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your \u003Ca href=\"https://dashboard.stripe.com/settings/public\"\u003EDashboard settings\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Displays a checkbox for the terms of service agreement which requires customer to check before being able to pay.\n", - "undocumented": false, - "html": "Displays a checkbox for the terms of service agreement which requires customer to check before being able to pay." - } - }, - "none": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Does not display checkbox for the terms of service agreement.\n", - "undocumented": false, - "html": "Does not display checkbox for the terms of service agreement." - } - } - }, - "object_type": "terms_of_service" - } - }, - "deprecated_allow_empty": false, - "object_type": "consent_collection", - "less_common": true - }, - "currency": { - "name": "currency", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "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) and supported by each line item's price.", - "undocumented": false, - "html": "Three-letter \u003Ca href=\"https://www.iso.org/iso-4217-currency-codes.html\"\u003EISO currency code\u003C/a\u003E, in lowercase. Must be a \u003Ca href=\"https://stripe.com/docs/currencies\"\u003Esupported currency\u003C/a\u003E and supported by each line item’s price." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "currency", - "less_common": true - }, - "custom_text": { - "name": "custom_text", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Display additional text for your customers using custom text. ", - "undocumented": false, - "html": "Display additional text for your customers using custom text. " - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "shipping_address": { - "name": "shipping_address", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Custom text that should be displayed alongside shipping address collection.", - "undocumented": false, - "html": "Custom text that should be displayed alongside shipping address collection." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "message": { - "name": "message", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Text may be up to 1000 characters in length.", - "undocumented": false, - "html": "Text may be up to 1000 characters in length." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "message" - } - }, - "deprecated_allow_empty": false, - "object_type": "shipping_address" - }, - "submit": { - "name": "submit", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Custom text that should be displayed alongside the payment confirmation button.", - "undocumented": false, - "html": "Custom text that should be displayed alongside the payment confirmation button." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "message": { - "name": "message", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Text may be up to 1000 characters in length.", - "undocumented": false, - "html": "Text may be up to 1000 characters in length." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "message" - } - }, - "deprecated_allow_empty": false, - "object_type": "submit" - } - }, - "deprecated_allow_empty": false, - "object_type": "custom_text", - "less_common": true - }, - "customer_creation": { - "name": "customer_creation", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configures whether [checkout sessions](/docs/api/checkout/sessions) created by this payment link create a [Customer](/docs/api/customers).", - "undocumented": false, - "html": "Configures whether \u003Ca href=\"/docs/api/checkout/sessions\"\u003Echeckout sessions\u003C/a\u003E created by this payment link create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "if_required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will only create a [Customer](/docs/api/customers) if it is required for Session confirmation.\nCurrently, only `subscription` mode Sessions require a Customer.\n", - "undocumented": false, - "html": "The Checkout Session will only create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E if it is required for Session confirmation.\nCurrently, only \u003Ccode\u003Esubscription\u003C/code\u003E mode Sessions require a Customer." - } - }, - "always": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will always create a [Customer](/docs/api/customers) when a Session confirmation is attempted.\n", - "undocumented": false, - "html": "The Checkout Session will always create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E when a Session confirmation is attempted." - } - } - }, - "object_type": "customer_creation", - "less_common": true - }, - "metadata": { - "name": "metadata", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](/docs/api/checkout/sessions) created by this payment link.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to \u003Ccode\u003Emetadata\u003C/code\u003E. Metadata associated with this Payment Link will automatically be copied to \u003Ca href=\"/docs/api/checkout/sessions\"\u003Echeckout sessions\u003C/a\u003E created by this payment link." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "metadata" - }, - "on_behalf_of": { - "name": "on_behalf_of", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account on behalf of which to charge.", - "undocumented": false, - "html": "The account on behalf of which to charge." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "on_behalf_of", - "less_common": true - }, - "payment_intent_data": { - "name": "payment_intent_data", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.", - "undocumented": false, - "html": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in \u003Ccode\u003Epayment\u003C/code\u003E mode." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "capture_method": { - "name": "capture_method", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls when the funds will be captured from the customer's account.\n", - "undocumented": false, - "html": "Controls when the funds will be captured from the customer’s account." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "automatic": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "(Default) Stripe automatically captures funds when the customer authorizes the payment.", - "undocumented": false, - "html": "(Default) Stripe automatically captures funds when the customer authorizes the payment." - } - }, - "manual": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Place a hold on the funds when the customer authorizes the payment, but [don't capture the funds until later](/docs/payments/capture-later). (Not all payment methods support this.)", - "undocumented": false, - "html": "Place a hold on the funds when the customer authorizes the payment, but \u003Ca href=\"/docs/payments/capture-later\"\u003Edon’t capture the funds until later\u003C/a\u003E. (Not all payment methods support this.)" - } - } - }, - "object_type": "capture_method" - }, - "setup_future_usage": { - "name": "setup_future_usage", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Indicates that you intend to [make future payments](/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\n\nIf a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.", - "undocumented": false, - "html": "Indicates that you intend to \u003Ca href=\"/docs/payments/payment-intents#future-usage\"\u003Emake future payments\u003C/a\u003E with the payment method collected by this Checkout Session.\u003C/p\u003E\n\n\u003Cp\u003EWhen setting this to \u003Ccode\u003Eon_session\u003C/code\u003E, Checkout will show a notice to the customer that their payment details will be saved.\u003C/p\u003E\n\n\u003Cp\u003EWhen setting this to \u003Ccode\u003Eoff_session\u003C/code\u003E, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\u003C/p\u003E\n\n\u003Cp\u003EIf a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.\u003C/p\u003E\n\n\u003Cp\u003EIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session’s PaymentIntent.\u003C/p\u003E\n\n\u003Cp\u003EWhen processing card payments, Checkout also uses \u003Ccode\u003Esetup_future_usage\u003C/code\u003E to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "on_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eon_session\u003C/code\u003E if you intend to only reuse the payment method when your customer is present in your checkout flow." - } - }, - "off_session": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Use `off_session` if your customer may or may not be present in your checkout flow.", - "undocumented": false, - "html": "Use \u003Ccode\u003Eoff_session\u003C/code\u003E if your customer may or may not be present in your checkout flow." - } - } - }, - "object_type": "setup_future_usage" - } - }, - "deprecated_allow_empty": false, - "object_type": "payment_intent_data", - "less_common": true - }, - "payment_method_collection": { - "name": "payment_method_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](/docs/payments/checkout/free-trials).", - "undocumented": false, - "html": "Specify whether Checkout should collect a payment method. When set to \u003Ccode\u003Eif_required\u003C/code\u003E, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\u003C/p\u003E\n\n\u003Cp\u003ECan only be set in \u003Ccode\u003Esubscription\u003C/code\u003E mode.\u003C/p\u003E\n\n\u003Cp\u003EIf you’d like information on how to collect a payment method outside of Checkout, read the guide on \u003Ca href=\"/docs/payments/checkout/free-trials\"\u003Econfiguring subscriptions with a free trial\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "always": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will always collect a PaymentMethod.\n", - "undocumented": false, - "html": "The Checkout Session will always collect a PaymentMethod." - } - }, - "if_required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will only collect a PaymentMethod if there is an amount due.\n", - "undocumented": false, - "html": "The Checkout Session will only collect a PaymentMethod if there is an amount due." - } - } - }, - "object_type": "payment_method_collection", - "less_common": true - }, - "payment_method_types": { - "name": "payment_method_types", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](/docs/payments/payment-methods/integration-options#payment-method-product-support)).", - "undocumented": false, - "html": "The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your \u003Ca href=\"https://dashboard.stripe.com/settings/payment_methods\"\u003Epayment method settings\u003C/a\u003E (20+ payment methods \u003Ca href=\"/docs/payments/payment-methods/integration-options#payment-method-product-support\"\u003Esupported\u003C/a\u003E)." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "enum_values": { - "card": { "documentation": null }, - "affirm": { "documentation": null }, - "promptpay": { "documentation": null }, - "bacs_debit": { "documentation": null }, - "bancontact": { "documentation": null }, - "blik": { "documentation": null }, - "boleto": { "documentation": null }, - "eps": { "documentation": null }, - "fpx": { "documentation": null }, - "giropay": { "documentation": null }, - "grabpay": { "documentation": null }, - "ideal": { "documentation": null }, - "klarna": { "documentation": null }, - "konbini": { "documentation": null }, - "oxxo": { "documentation": null }, - "p24": { "documentation": null }, - "paynow": { "documentation": null }, - "pix": { "documentation": null }, - "afterpay_clearpay": { "documentation": null }, - "alipay": { "documentation": null }, - "au_becs_debit": { "documentation": null }, - "sepa_debit": { "documentation": null }, - "sofort": { "documentation": null }, - "us_bank_account": { "documentation": null }, - "wechat_pay": { "documentation": null } - }, - "object_type": "payment_method_types" - }, - "phone_number_collection": { - "name": "phone_number_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.\n", - "undocumented": false, - "html": "Controls phone number collection settings during checkout.\u003C/p\u003E\n\n\u003Cp\u003EWe recommend that you review your privacy policy and check with your legal contacts." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "enabled": { - "name": "enabled", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set to `true` to enable phone number collection.", - "undocumented": false, - "html": "Set to \u003Ccode\u003Etrue\u003C/code\u003E to enable phone number collection." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "enabled" - } - }, - "deprecated_allow_empty": false, - "object_type": "phone_number_collection", - "less_common": true - }, - "shipping_address_collection": { - "name": "shipping_address_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for collecting the customer's shipping address.", - "undocumented": false, - "html": "Configuration for collecting the customer’s shipping address." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "allowed_countries": { - "name": "allowed_countries", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.\n", - "undocumented": false, - "html": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: \u003Ccode\u003EAS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "enum_values": { - "AC": { "documentation": null }, - "AD": { "documentation": null }, - "AE": { "documentation": null }, - "AF": { "documentation": null }, - "AG": { "documentation": null }, - "AI": { "documentation": null }, - "AL": { "documentation": null }, - "AM": { "documentation": null }, - "AO": { "documentation": null }, - "AQ": { "documentation": null }, - "AR": { "documentation": null }, - "AT": { "documentation": null }, - "AU": { "documentation": null }, - "AW": { "documentation": null }, - "AX": { "documentation": null }, - "AZ": { "documentation": null }, - "BA": { "documentation": null }, - "BB": { "documentation": null }, - "BD": { "documentation": null }, - "BE": { "documentation": null }, - "BF": { "documentation": null }, - "BG": { "documentation": null }, - "BH": { "documentation": null }, - "BI": { "documentation": null }, - "BJ": { "documentation": null }, - "BL": { "documentation": null }, - "BM": { "documentation": null }, - "BN": { "documentation": null }, - "BO": { "documentation": null }, - "BQ": { "documentation": null }, - "BR": { "documentation": null }, - "BS": { "documentation": null }, - "BT": { "documentation": null }, - "BV": { "documentation": null }, - "BW": { "documentation": null }, - "BY": { "documentation": null }, - "BZ": { "documentation": null }, - "CA": { "documentation": null }, - "CD": { "documentation": null }, - "CF": { "documentation": null }, - "CG": { "documentation": null }, - "CH": { "documentation": null }, - "CI": { "documentation": null }, - "CK": { "documentation": null }, - "CL": { "documentation": null }, - "CM": { "documentation": null }, - "CN": { "documentation": null }, - "CO": { "documentation": null }, - "CR": { "documentation": null }, - "CV": { "documentation": null }, - "CW": { "documentation": null }, - "CY": { "documentation": null }, - "CZ": { "documentation": null }, - "DE": { "documentation": null }, - "DJ": { "documentation": null }, - "DK": { "documentation": null }, - "DM": { "documentation": null }, - "DO": { "documentation": null }, - "DZ": { "documentation": null }, - "EC": { "documentation": null }, - "EE": { "documentation": null }, - "EG": { "documentation": null }, - "EH": { "documentation": null }, - "ER": { "documentation": null }, - "ES": { "documentation": null }, - "ET": { "documentation": null }, - "FI": { "documentation": null }, - "FJ": { "documentation": null }, - "FK": { "documentation": null }, - "FO": { "documentation": null }, - "FR": { "documentation": null }, - "GA": { "documentation": null }, - "GB": { "documentation": null }, - "GD": { "documentation": null }, - "GE": { "documentation": null }, - "GF": { "documentation": null }, - "GG": { "documentation": null }, - "GH": { "documentation": null }, - "GI": { "documentation": null }, - "GL": { "documentation": null }, - "GM": { "documentation": null }, - "GN": { "documentation": null }, - "GP": { "documentation": null }, - "GQ": { "documentation": null }, - "GR": { "documentation": null }, - "GS": { "documentation": null }, - "GT": { "documentation": null }, - "GU": { "documentation": null }, - "GW": { "documentation": null }, - "GY": { "documentation": null }, - "HK": { "documentation": null }, - "HN": { "documentation": null }, - "HR": { "documentation": null }, - "HT": { "documentation": null }, - "HU": { "documentation": null }, - "ID": { "documentation": null }, - "IE": { "documentation": null }, - "IL": { "documentation": null }, - "IM": { "documentation": null }, - "IN": { "documentation": null }, - "IO": { "documentation": null }, - "IQ": { "documentation": null }, - "IS": { "documentation": null }, - "IT": { "documentation": null }, - "JE": { "documentation": null }, - "JM": { "documentation": null }, - "JO": { "documentation": null }, - "JP": { "documentation": null }, - "KE": { "documentation": null }, - "KG": { "documentation": null }, - "KH": { "documentation": null }, - "KI": { "documentation": null }, - "KM": { "documentation": null }, - "KN": { "documentation": null }, - "KR": { "documentation": null }, - "KW": { "documentation": null }, - "KY": { "documentation": null }, - "KZ": { "documentation": null }, - "LA": { "documentation": null }, - "LB": { "documentation": null }, - "LC": { "documentation": null }, - "LI": { "documentation": null }, - "LK": { "documentation": null }, - "LR": { "documentation": null }, - "LS": { "documentation": null }, - "LT": { "documentation": null }, - "LU": { "documentation": null }, - "LV": { "documentation": null }, - "LY": { "documentation": null }, - "MA": { "documentation": null }, - "MC": { "documentation": null }, - "MD": { "documentation": null }, - "ME": { "documentation": null }, - "MF": { "documentation": null }, - "MG": { "documentation": null }, - "MK": { "documentation": null }, - "ML": { "documentation": null }, - "MM": { "documentation": null }, - "MN": { "documentation": null }, - "MO": { "documentation": null }, - "MQ": { "documentation": null }, - "MR": { "documentation": null }, - "MS": { "documentation": null }, - "MT": { "documentation": null }, - "MU": { "documentation": null }, - "MV": { "documentation": null }, - "MW": { "documentation": null }, - "MX": { "documentation": null }, - "MY": { "documentation": null }, - "MZ": { "documentation": null }, - "NA": { "documentation": null }, - "NC": { "documentation": null }, - "NE": { "documentation": null }, - "NG": { "documentation": null }, - "NI": { "documentation": null }, - "NL": { "documentation": null }, - "NO": { "documentation": null }, - "NP": { "documentation": null }, - "NR": { "documentation": null }, - "NU": { "documentation": null }, - "NZ": { "documentation": null }, - "OM": { "documentation": null }, - "PA": { "documentation": null }, - "PE": { "documentation": null }, - "PF": { "documentation": null }, - "PG": { "documentation": null }, - "PH": { "documentation": null }, - "PK": { "documentation": null }, - "PL": { "documentation": null }, - "PM": { "documentation": null }, - "PN": { "documentation": null }, - "PR": { "documentation": null }, - "PS": { "documentation": null }, - "PT": { "documentation": null }, - "PY": { "documentation": null }, - "QA": { "documentation": null }, - "RE": { "documentation": null }, - "RO": { "documentation": null }, - "RS": { "documentation": null }, - "RU": { "documentation": null }, - "RW": { "documentation": null }, - "SA": { "documentation": null }, - "SB": { "documentation": null }, - "SC": { "documentation": null }, - "SE": { "documentation": null }, - "SG": { "documentation": null }, - "SH": { "documentation": null }, - "SI": { "documentation": null }, - "SJ": { "documentation": null }, - "SK": { "documentation": null }, - "SL": { "documentation": null }, - "SM": { "documentation": null }, - "SN": { "documentation": null }, - "SO": { "documentation": null }, - "SR": { "documentation": null }, - "SS": { "documentation": null }, - "ST": { "documentation": null }, - "SV": { "documentation": null }, - "SX": { "documentation": null }, - "SZ": { "documentation": null }, - "TA": { "documentation": null }, - "TC": { "documentation": null }, - "TD": { "documentation": null }, - "TF": { "documentation": null }, - "TG": { "documentation": null }, - "TH": { "documentation": null }, - "TJ": { "documentation": null }, - "TK": { "documentation": null }, - "TL": { "documentation": null }, - "TM": { "documentation": null }, - "TN": { "documentation": null }, - "TO": { "documentation": null }, - "TR": { "documentation": null }, - "TT": { "documentation": null }, - "TV": { "documentation": null }, - "TW": { "documentation": null }, - "TZ": { "documentation": null }, - "UA": { "documentation": null }, - "UG": { "documentation": null }, - "US": { "documentation": null }, - "UY": { "documentation": null }, - "UZ": { "documentation": null }, - "VA": { "documentation": null }, - "VC": { "documentation": null }, - "VE": { "documentation": null }, - "VG": { "documentation": null }, - "VN": { "documentation": null }, - "VU": { "documentation": null }, - "WF": { "documentation": null }, - "WS": { "documentation": null }, - "XK": { "documentation": null }, - "YE": { "documentation": null }, - "YT": { "documentation": null }, - "ZA": { "documentation": null }, - "ZM": { "documentation": null }, - "ZW": { "documentation": null }, - "ZZ": { "documentation": null } - }, - "object_type": "allowed_countries" - } - }, - "deprecated_allow_empty": false, - "object_type": "shipping_address_collection", - "less_common": true - }, - "shipping_options": { - "name": "shipping_options", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The shipping rate options to apply to [checkout sessions](/docs/api/checkout/sessions) created by this payment link.", - "undocumented": false, - "html": "The shipping rate options to apply to \u003Ca href=\"/docs/api/checkout/sessions\"\u003Echeckout sessions\u003C/a\u003E created by this payment link." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "array_contents_spec": { - "shipping_rate": { - "name": "shipping_rate", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of the Shipping Rate to use for this shipping option.", - "undocumented": false, - "html": "The ID of the Shipping Rate to use for this shipping option." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "shipping_rate" - } - }, - "object_type": "shipping_options", - "less_common": true - }, - "submit_type": { - "name": "submit_type", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).", - "undocumented": false, - "html": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the \u003Ca href=\"/docs/api/payment_links/payment_links/object#url\"\u003Eurl\u003C/a\u003E property (example: \u003Ccode\u003Edonate.stripe.com\u003C/code\u003E)." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "auto": { "documentation": null }, - "pay": { "documentation": null }, - "book": { "documentation": null }, - "donate": { "documentation": null } - }, - "object_type": "submit_type", - "less_common": true - }, - "subscription_data": { - "name": "subscription_data", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", - "undocumented": false, - "html": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use \u003Ccode\u003Esubscription_data\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "description": { - "name": "description", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.", - "undocumented": false, - "html": "The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "description" - }, - "trial_period_days": { - "name": "trial_period_days", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.", - "undocumented": false, - "html": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "trial_period_days" - } - }, - "deprecated_allow_empty": false, - "object_type": "subscription_data", - "less_common": true - }, - "tax_id_collection": { - "name": "tax_id_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Controls tax ID collection during checkout.", - "undocumented": false, - "html": "Controls tax ID collection during checkout." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "enabled": { - "name": "enabled", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set to `true` to enable tax ID collection.", - "undocumented": false, - "html": "Set to \u003Ccode\u003Etrue\u003C/code\u003E to enable tax ID collection." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "enabled" - } - }, - "deprecated_allow_empty": false, - "object_type": "tax_id_collection", - "less_common": true - }, - "transfer_data": { - "name": "transfer_data", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.", - "undocumented": false, - "html": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": "Connect only", - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "destination": { - "name": "destination", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge's `transfer` field.\n", - "undocumented": false, - "html": "If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge’s \u003Ccode\u003Etransfer\u003C/code\u003E field." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "destination" - }, - "amount": { - "name": "amount", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The amount that will be transferred automatically when a charge succeeds.", - "undocumented": false, - "html": "The amount that will be transferred automatically when a charge succeeds." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "amount" - } - }, - "deprecated_allow_empty": false, - "object_type": "transfer_data", - "less_common": true - } - }, - "supported_languages": null, - "action": "method", - "curl_definition": "POST /v1/payment_links", - "request": null, - "request_data": { - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "action_type": "create", - "action_name": null, - "action_path": null, - "resource_name": "payment_link", - "parent_resource_name": null, - "namespace": null, - "test_helper": false, - "request_params": { - "line_items": [{ "price": "price_1MWZrQ2eZvKYlo2CFNmBYW1q", "quantity": 1 }] - }, - "url_params": {}, - "overridden_languages": [], - "preamble_comment": null - }, - "response": "{\n \"id\": \"plink_1MWb7e2eZvKYlo2CTAnxRZDR\",\n \"object\": \"payment_link\",\n \"active\": true,\n \"after_completion\": {\n \"hosted_confirmation\": {\n \"custom_message\": null\n },\n \"type\": \"hosted_confirmation\"\n },\n \"allow_promotion_codes\": false,\n \"application_fee_amount\": null,\n \"application_fee_percent\": null,\n \"automatic_tax\": {\n \"enabled\": false\n },\n \"billing_address_collection\": \"auto\",\n \"consent_collection\": null,\n \"currency\": \"usd\",\n \"custom_text\": {\n \"shipping_address\": null,\n \"submit\": null\n },\n \"customer_creation\": \"always\",\n \"livemode\": false,\n \"metadata\": {\n },\n \"on_behalf_of\": null,\n \"payment_intent_data\": null,\n \"payment_method_collection\": \"always\",\n \"payment_method_types\": null,\n \"phone_number_collection\": {\n \"enabled\": false\n },\n \"shipping_address_collection\": null,\n \"shipping_options\": [\n\n ],\n \"submit_type\": \"auto\",\n \"subscription_data\": null,\n \"tax_id_collection\": {\n \"enabled\": false\n },\n \"transfer_data\": null,\n \"url\": \"https://buy.stripe.com/test_5kAcPyarJaIPaQg4gg\"\n}" - } - }, - "retrieve_payment_link": { - "title": "Retrieve payment link", - "group_title": "Payment Links", - "group_anchor": "payment_links_section", - "anchor": "retrieve_payment_link", - "section_anchor": "payment_links", - "subsection_anchors": null, - "path": "/payment_links/payment_links/retrieve", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "request", - "title": "Retrieve payment link", - "description": "Retrieve a payment link.", - "top_level_changes": [], - "changes": {}, - "version": null, - "returns": "Returns the payment link.", - "section_tag": "retrieve_payment_link", - "specs": {}, - "supported_languages": null, - "action": "method", - "curl_definition": "GET /v1/payment_links/:id", - "request": null, - "request_data": { - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "action_type": "retrieve", - "action_name": null, - "action_path": null, - "resource_name": "payment_link", - "parent_resource_name": null, - "namespace": null, - "test_helper": false, - "request_params": {}, - "url_params": { "id": "plink_1MWb7e2eZvKYlo2CTAnxRZDR" }, - "overridden_languages": [], - "preamble_comment": null - }, - "response": "{\n \"id\": \"plink_1MWb7e2eZvKYlo2CTAnxRZDR\",\n \"object\": \"payment_link\",\n \"active\": true,\n \"after_completion\": {\n \"hosted_confirmation\": {\n \"custom_message\": null\n },\n \"type\": \"hosted_confirmation\"\n },\n \"allow_promotion_codes\": false,\n \"application_fee_amount\": null,\n \"application_fee_percent\": null,\n \"automatic_tax\": {\n \"enabled\": false\n },\n \"billing_address_collection\": \"auto\",\n \"consent_collection\": null,\n \"currency\": \"usd\",\n \"custom_text\": {\n \"shipping_address\": null,\n \"submit\": null\n },\n \"customer_creation\": \"always\",\n \"livemode\": false,\n \"metadata\": {\n },\n \"on_behalf_of\": null,\n \"payment_intent_data\": null,\n \"payment_method_collection\": \"always\",\n \"payment_method_types\": null,\n \"phone_number_collection\": {\n \"enabled\": false\n },\n \"shipping_address_collection\": null,\n \"shipping_options\": [\n\n ],\n \"submit_type\": \"auto\",\n \"subscription_data\": null,\n \"tax_id_collection\": {\n \"enabled\": false\n },\n \"transfer_data\": null,\n \"url\": \"https://buy.stripe.com/test_5kAcPyarJaIPaQg4gg\"\n}" - } - }, - "update_payment_link": { - "title": "Update a payment link", - "group_title": "Payment Links", - "group_anchor": "payment_links_section", - "anchor": "update_payment_link", - "section_anchor": "payment_links", - "subsection_anchors": null, - "path": "/payment_links/payment_links/update", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "request", - "title": "Update a payment link", - "description": "Updates a payment link.", - "top_level_changes": [], - "changes": {}, - "version": null, - "returns": "Updated payment link.", - "section_tag": "update_payment_link", - "specs": { - "active": { - "name": "active", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.", - "undocumented": false, - "html": "Whether the payment link’s \u003Ccode\u003Eurl\u003C/code\u003E is active. If \u003Ccode\u003Efalse\u003C/code\u003E, customers visiting the URL will be shown a page saying that the link has been deactivated." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "active" - }, - "after_completion": { - "name": "after_completion", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Behavior after the purchase is complete.", - "undocumented": false, - "html": "Behavior after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "type": { - "name": "type", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.", - "undocumented": false, - "html": "The specified behavior after the purchase is complete. Either \u003Ccode\u003Eredirect\u003C/code\u003E or \u003Ccode\u003Ehosted_confirmation\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "redirect": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Redirects the customer to the specified `url` after the purchase is complete.", - "undocumented": false, - "html": "Redirects the customer to the specified \u003Ccode\u003Eurl\u003C/code\u003E after the purchase is complete." - } - }, - "hosted_confirmation": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Displays a message on the hosted surface after the purchase is complete.", - "undocumented": false, - "html": "Displays a message on the hosted surface after the purchase is complete." - } - } - }, - "object_type": "type" - }, - "hosted_confirmation": { - "name": "hosted_confirmation", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration when `type=hosted_confirmation`.", - "undocumented": false, - "html": "Configuration when \u003Ccode\u003Etype=hosted_confirmation\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "custom_message": { - "name": "custom_message", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A custom message to display to the customer after the purchase is complete.", - "undocumented": false, - "html": "A custom message to display to the customer after the purchase is complete." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "custom_message" - } - }, - "deprecated_allow_empty": false, - "object_type": "hosted_confirmation" - }, - "redirect": { - "name": "redirect", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration when `type=redirect`.", - "undocumented": false, - "html": "Configuration when \u003Ccode\u003Etype=redirect\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "url": { - "name": "url", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](/docs/api/checkout/sessions/object#checkout_session_object-id) included.", - "undocumented": false, - "html": "The URL the customer will be redirected to after the purchase is complete. You can embed \u003Ccode\u003E{CHECKOUT_SESSION_ID}\u003C/code\u003E into the URL to have the \u003Ccode\u003Eid\u003C/code\u003E of the completed \u003Ca href=\"/docs/api/checkout/sessions/object#checkout_session_object-id\"\u003Echeckout session\u003C/a\u003E included." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "url" - } - }, - "deprecated_allow_empty": false, - "object_type": "redirect" - } - }, - "deprecated_allow_empty": false, - "object_type": "after_completion", - "less_common": true - }, - "allow_promotion_codes": { - "name": "allow_promotion_codes", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Enables user redeemable promotion codes.", - "undocumented": false, - "html": "Enables user redeemable promotion codes." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "allow_promotion_codes", - "less_common": true - }, - "automatic_tax": { - "name": "automatic_tax", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for automatic tax collection.", - "undocumented": false, - "html": "Configuration for automatic tax collection." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "enabled": { - "name": "enabled", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "If `true`, tax will be calculated automatically using the customer's location.", - "undocumented": false, - "html": "If \u003Ccode\u003Etrue\u003C/code\u003E, tax will be calculated automatically using the customer’s location." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "enabled" - } - }, - "deprecated_allow_empty": false, - "object_type": "automatic_tax", - "less_common": true - }, - "billing_address_collection": { - "name": "billing_address_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for collecting the customer's billing address.", - "undocumented": false, - "html": "Configuration for collecting the customer’s billing address." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "auto": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checkout will only collect the billing address when necessary.", - "undocumented": false, - "badge_text": "Default", - "html": "Checkout will only collect the billing address when necessary." - } - }, - "required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Checkout will always collect the customer's billing address.", - "undocumented": false, - "html": "Checkout will always collect the customer’s billing address." - } - } - }, - "object_type": "billing_address_collection", - "less_common": true - }, - "custom_text": { - "name": "custom_text", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Display additional text for your customers using custom text. ", - "undocumented": false, - "html": "Display additional text for your customers using custom text. " - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "shipping_address": { - "name": "shipping_address", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Custom text that should be displayed alongside shipping address collection.", - "undocumented": false, - "html": "Custom text that should be displayed alongside shipping address collection." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "message": { - "name": "message", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Text may be up to 1000 characters in length.", - "undocumented": false, - "html": "Text may be up to 1000 characters in length." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "message" - } - }, - "deprecated_allow_empty": false, - "object_type": "shipping_address" - }, - "submit": { - "name": "submit", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Custom text that should be displayed alongside the payment confirmation button.", - "undocumented": false, - "html": "Custom text that should be displayed alongside the payment confirmation button." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "message": { - "name": "message", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Text may be up to 1000 characters in length.", - "undocumented": false, - "html": "Text may be up to 1000 characters in length." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "message" - } - }, - "deprecated_allow_empty": false, - "object_type": "submit" - } - }, - "deprecated_allow_empty": false, - "object_type": "custom_text", - "less_common": true - }, - "customer_creation": { - "name": "customer_creation", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configures whether [checkout sessions](/docs/api/checkout/sessions) created by this payment link create a [Customer](/docs/api/customers).", - "undocumented": false, - "html": "Configures whether \u003Ca href=\"/docs/api/checkout/sessions\"\u003Echeckout sessions\u003C/a\u003E created by this payment link create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "if_required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will only create a [Customer](/docs/api/customers) if it is required for Session confirmation.\nCurrently, only `subscription` mode Sessions require a Customer.\n", - "undocumented": false, - "html": "The Checkout Session will only create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E if it is required for Session confirmation.\nCurrently, only \u003Ccode\u003Esubscription\u003C/code\u003E mode Sessions require a Customer." - } - }, - "always": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will always create a [Customer](/docs/api/customers) when a Session confirmation is attempted.\n", - "undocumented": false, - "html": "The Checkout Session will always create a \u003Ca href=\"/docs/api/customers\"\u003ECustomer\u003C/a\u003E when a Session confirmation is attempted." - } - } - }, - "object_type": "customer_creation", - "less_common": true - }, - "line_items": { - "name": "line_items", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.", - "undocumented": false, - "html": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "array_contents_spec": { - "id": { - "name": "id", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The ID of an existing line item on the payment link.", - "undocumented": false, - "html": "The ID of an existing line item on the payment link." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "id" - }, - "adjustable_quantity": { - "name": "adjustable_quantity", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.", - "undocumented": false, - "html": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "enabled": { - "name": "enabled", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set to true if the quantity can be adjusted to any non-negative Integer.", - "undocumented": false, - "html": "Set to true if the quantity can be adjusted to any non-negative Integer." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "enabled" - }, - "maximum": { - "name": "maximum", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.", - "undocumented": false, - "html": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "maximum" - }, - "minimum": { - "name": "minimum", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.", - "undocumented": false, - "html": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item’s quantity cannot go down to 0." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "minimum" - } - }, - "deprecated_allow_empty": false, - "object_type": "adjustable_quantity" - }, - "quantity": { - "name": "quantity", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The quantity of the line item being purchased.", - "undocumented": false, - "html": "The quantity of the line item being purchased." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "quantity" - } - }, - "object_type": "line_items" - }, - "metadata": { - "name": "metadata", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Set of [key-value pairs](/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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](/docs/api/checkout/sessions) created by this payment link.", - "undocumented": false, - "html": "Set of \u003Ca href=\"/docs/api/metadata\"\u003Ekey-value pairs\u003C/a\u003E that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to \u003Ccode\u003Emetadata\u003C/code\u003E. Metadata associated with this Payment Link will automatically be copied to \u003Ca href=\"/docs/api/checkout/sessions\"\u003Echeckout sessions\u003C/a\u003E created by this payment link." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "metadata" - }, - "payment_method_collection": { - "name": "payment_method_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](/docs/payments/checkout/free-trials).", - "undocumented": false, - "html": "Specify whether Checkout should collect a payment method. When set to \u003Ccode\u003Eif_required\u003C/code\u003E, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\u003C/p\u003E\n\n\u003Cp\u003ECan only be set in \u003Ccode\u003Esubscription\u003C/code\u003E mode.\u003C/p\u003E\n\n\u003Cp\u003EIf you’d like information on how to collect a payment method outside of Checkout, read the guide on \u003Ca href=\"/docs/payments/checkout/free-trials\"\u003Econfiguring subscriptions with a free trial\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "enum_values": { - "always": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will always collect a PaymentMethod.\n", - "undocumented": false, - "html": "The Checkout Session will always collect a PaymentMethod." - } - }, - "if_required": { - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The Checkout Session will only collect a PaymentMethod if there is an amount due.\n", - "undocumented": false, - "html": "The Checkout Session will only collect a PaymentMethod if there is an amount due." - } - } - }, - "object_type": "payment_method_collection", - "less_common": true - }, - "payment_method_types": { - "name": "payment_method_types", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "The list of payment method types that customers can use. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).", - "undocumented": false, - "html": "The list of payment method types that customers can use. Pass an empty string to enable automatic payment methods that use your \u003Ca href=\"https://dashboard.stripe.com/settings/payment_methods\"\u003Epayment method settings\u003C/a\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "enum_values": { - "card": { "documentation": null }, - "affirm": { "documentation": null }, - "promptpay": { "documentation": null }, - "bacs_debit": { "documentation": null }, - "bancontact": { "documentation": null }, - "blik": { "documentation": null }, - "boleto": { "documentation": null }, - "eps": { "documentation": null }, - "fpx": { "documentation": null }, - "giropay": { "documentation": null }, - "grabpay": { "documentation": null }, - "ideal": { "documentation": null }, - "klarna": { "documentation": null }, - "konbini": { "documentation": null }, - "oxxo": { "documentation": null }, - "p24": { "documentation": null }, - "paynow": { "documentation": null }, - "pix": { "documentation": null }, - "afterpay_clearpay": { "documentation": null }, - "alipay": { "documentation": null }, - "au_becs_debit": { "documentation": null }, - "sepa_debit": { "documentation": null }, - "sofort": { "documentation": null }, - "us_bank_account": { "documentation": null }, - "wechat_pay": { "documentation": null } - }, - "object_type": "payment_method_types" - }, - "shipping_address_collection": { - "name": "shipping_address_collection", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Configuration for collecting the customer's shipping address.", - "undocumented": false, - "html": "Configuration for collecting the customer’s shipping address." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "subspec": { - "allowed_countries": { - "name": "allowed_countries", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.\n", - "undocumented": false, - "html": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: \u003Ccode\u003EAS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI\u003C/code\u003E." - }, - "gate": false, - "hide_unset_desc": false, - "required": true, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "enum_values": { - "AC": { "documentation": null }, - "AD": { "documentation": null }, - "AE": { "documentation": null }, - "AF": { "documentation": null }, - "AG": { "documentation": null }, - "AI": { "documentation": null }, - "AL": { "documentation": null }, - "AM": { "documentation": null }, - "AO": { "documentation": null }, - "AQ": { "documentation": null }, - "AR": { "documentation": null }, - "AT": { "documentation": null }, - "AU": { "documentation": null }, - "AW": { "documentation": null }, - "AX": { "documentation": null }, - "AZ": { "documentation": null }, - "BA": { "documentation": null }, - "BB": { "documentation": null }, - "BD": { "documentation": null }, - "BE": { "documentation": null }, - "BF": { "documentation": null }, - "BG": { "documentation": null }, - "BH": { "documentation": null }, - "BI": { "documentation": null }, - "BJ": { "documentation": null }, - "BL": { "documentation": null }, - "BM": { "documentation": null }, - "BN": { "documentation": null }, - "BO": { "documentation": null }, - "BQ": { "documentation": null }, - "BR": { "documentation": null }, - "BS": { "documentation": null }, - "BT": { "documentation": null }, - "BV": { "documentation": null }, - "BW": { "documentation": null }, - "BY": { "documentation": null }, - "BZ": { "documentation": null }, - "CA": { "documentation": null }, - "CD": { "documentation": null }, - "CF": { "documentation": null }, - "CG": { "documentation": null }, - "CH": { "documentation": null }, - "CI": { "documentation": null }, - "CK": { "documentation": null }, - "CL": { "documentation": null }, - "CM": { "documentation": null }, - "CN": { "documentation": null }, - "CO": { "documentation": null }, - "CR": { "documentation": null }, - "CV": { "documentation": null }, - "CW": { "documentation": null }, - "CY": { "documentation": null }, - "CZ": { "documentation": null }, - "DE": { "documentation": null }, - "DJ": { "documentation": null }, - "DK": { "documentation": null }, - "DM": { "documentation": null }, - "DO": { "documentation": null }, - "DZ": { "documentation": null }, - "EC": { "documentation": null }, - "EE": { "documentation": null }, - "EG": { "documentation": null }, - "EH": { "documentation": null }, - "ER": { "documentation": null }, - "ES": { "documentation": null }, - "ET": { "documentation": null }, - "FI": { "documentation": null }, - "FJ": { "documentation": null }, - "FK": { "documentation": null }, - "FO": { "documentation": null }, - "FR": { "documentation": null }, - "GA": { "documentation": null }, - "GB": { "documentation": null }, - "GD": { "documentation": null }, - "GE": { "documentation": null }, - "GF": { "documentation": null }, - "GG": { "documentation": null }, - "GH": { "documentation": null }, - "GI": { "documentation": null }, - "GL": { "documentation": null }, - "GM": { "documentation": null }, - "GN": { "documentation": null }, - "GP": { "documentation": null }, - "GQ": { "documentation": null }, - "GR": { "documentation": null }, - "GS": { "documentation": null }, - "GT": { "documentation": null }, - "GU": { "documentation": null }, - "GW": { "documentation": null }, - "GY": { "documentation": null }, - "HK": { "documentation": null }, - "HN": { "documentation": null }, - "HR": { "documentation": null }, - "HT": { "documentation": null }, - "HU": { "documentation": null }, - "ID": { "documentation": null }, - "IE": { "documentation": null }, - "IL": { "documentation": null }, - "IM": { "documentation": null }, - "IN": { "documentation": null }, - "IO": { "documentation": null }, - "IQ": { "documentation": null }, - "IS": { "documentation": null }, - "IT": { "documentation": null }, - "JE": { "documentation": null }, - "JM": { "documentation": null }, - "JO": { "documentation": null }, - "JP": { "documentation": null }, - "KE": { "documentation": null }, - "KG": { "documentation": null }, - "KH": { "documentation": null }, - "KI": { "documentation": null }, - "KM": { "documentation": null }, - "KN": { "documentation": null }, - "KR": { "documentation": null }, - "KW": { "documentation": null }, - "KY": { "documentation": null }, - "KZ": { "documentation": null }, - "LA": { "documentation": null }, - "LB": { "documentation": null }, - "LC": { "documentation": null }, - "LI": { "documentation": null }, - "LK": { "documentation": null }, - "LR": { "documentation": null }, - "LS": { "documentation": null }, - "LT": { "documentation": null }, - "LU": { "documentation": null }, - "LV": { "documentation": null }, - "LY": { "documentation": null }, - "MA": { "documentation": null }, - "MC": { "documentation": null }, - "MD": { "documentation": null }, - "ME": { "documentation": null }, - "MF": { "documentation": null }, - "MG": { "documentation": null }, - "MK": { "documentation": null }, - "ML": { "documentation": null }, - "MM": { "documentation": null }, - "MN": { "documentation": null }, - "MO": { "documentation": null }, - "MQ": { "documentation": null }, - "MR": { "documentation": null }, - "MS": { "documentation": null }, - "MT": { "documentation": null }, - "MU": { "documentation": null }, - "MV": { "documentation": null }, - "MW": { "documentation": null }, - "MX": { "documentation": null }, - "MY": { "documentation": null }, - "MZ": { "documentation": null }, - "NA": { "documentation": null }, - "NC": { "documentation": null }, - "NE": { "documentation": null }, - "NG": { "documentation": null }, - "NI": { "documentation": null }, - "NL": { "documentation": null }, - "NO": { "documentation": null }, - "NP": { "documentation": null }, - "NR": { "documentation": null }, - "NU": { "documentation": null }, - "NZ": { "documentation": null }, - "OM": { "documentation": null }, - "PA": { "documentation": null }, - "PE": { "documentation": null }, - "PF": { "documentation": null }, - "PG": { "documentation": null }, - "PH": { "documentation": null }, - "PK": { "documentation": null }, - "PL": { "documentation": null }, - "PM": { "documentation": null }, - "PN": { "documentation": null }, - "PR": { "documentation": null }, - "PS": { "documentation": null }, - "PT": { "documentation": null }, - "PY": { "documentation": null }, - "QA": { "documentation": null }, - "RE": { "documentation": null }, - "RO": { "documentation": null }, - "RS": { "documentation": null }, - "RU": { "documentation": null }, - "RW": { "documentation": null }, - "SA": { "documentation": null }, - "SB": { "documentation": null }, - "SC": { "documentation": null }, - "SE": { "documentation": null }, - "SG": { "documentation": null }, - "SH": { "documentation": null }, - "SI": { "documentation": null }, - "SJ": { "documentation": null }, - "SK": { "documentation": null }, - "SL": { "documentation": null }, - "SM": { "documentation": null }, - "SN": { "documentation": null }, - "SO": { "documentation": null }, - "SR": { "documentation": null }, - "SS": { "documentation": null }, - "ST": { "documentation": null }, - "SV": { "documentation": null }, - "SX": { "documentation": null }, - "SZ": { "documentation": null }, - "TA": { "documentation": null }, - "TC": { "documentation": null }, - "TD": { "documentation": null }, - "TF": { "documentation": null }, - "TG": { "documentation": null }, - "TH": { "documentation": null }, - "TJ": { "documentation": null }, - "TK": { "documentation": null }, - "TL": { "documentation": null }, - "TM": { "documentation": null }, - "TN": { "documentation": null }, - "TO": { "documentation": null }, - "TR": { "documentation": null }, - "TT": { "documentation": null }, - "TV": { "documentation": null }, - "TW": { "documentation": null }, - "TZ": { "documentation": null }, - "UA": { "documentation": null }, - "UG": { "documentation": null }, - "US": { "documentation": null }, - "UY": { "documentation": null }, - "UZ": { "documentation": null }, - "VA": { "documentation": null }, - "VC": { "documentation": null }, - "VE": { "documentation": null }, - "VG": { "documentation": null }, - "VN": { "documentation": null }, - "VU": { "documentation": null }, - "WF": { "documentation": null }, - "WS": { "documentation": null }, - "XK": { "documentation": null }, - "YE": { "documentation": null }, - "YT": { "documentation": null }, - "ZA": { "documentation": null }, - "ZM": { "documentation": null }, - "ZW": { "documentation": null }, - "ZZ": { "documentation": null } - }, - "object_type": "allowed_countries" - } - }, - "deprecated_allow_empty": false, - "object_type": "shipping_address_collection", - "less_common": true - } - }, - "supported_languages": null, - "action": "method", - "curl_definition": "POST /v1/payment_links/:id", - "request": null, - "request_data": { - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "action_type": "update", - "action_name": null, - "action_path": null, - "resource_name": "payment_link", - "parent_resource_name": null, - "namespace": null, - "test_helper": false, - "request_params": { "active": false }, - "url_params": { "id": "plink_1MWb7e2eZvKYlo2CTAnxRZDR" }, - "overridden_languages": [], - "preamble_comment": null - }, - "response": "{\n \"id\": \"plink_1MWb7e2eZvKYlo2CTAnxRZDR\",\n \"object\": \"payment_link\",\n \"active\": false,\n \"after_completion\": {\n \"hosted_confirmation\": {\n \"custom_message\": null\n },\n \"type\": \"hosted_confirmation\"\n },\n \"allow_promotion_codes\": false,\n \"application_fee_amount\": null,\n \"application_fee_percent\": null,\n \"automatic_tax\": {\n \"enabled\": false\n },\n \"billing_address_collection\": \"auto\",\n \"consent_collection\": null,\n \"currency\": \"usd\",\n \"custom_text\": {\n \"shipping_address\": null,\n \"submit\": null\n },\n \"customer_creation\": \"always\",\n \"livemode\": false,\n \"metadata\": {\n },\n \"on_behalf_of\": null,\n \"payment_intent_data\": null,\n \"payment_method_collection\": \"always\",\n \"payment_method_types\": null,\n \"phone_number_collection\": {\n \"enabled\": false\n },\n \"shipping_address_collection\": null,\n \"shipping_options\": [\n\n ],\n \"submit_type\": \"auto\",\n \"subscription_data\": null,\n \"tax_id_collection\": {\n \"enabled\": false\n },\n \"transfer_data\": null,\n \"url\": \"https://buy.stripe.com/test_5kAcPyarJaIPaQg4gg\"\n}" - } - }, - "list_payment_link": { - "title": "List all payment links", - "group_title": "Payment Links", - "group_anchor": "payment_links_section", - "anchor": "list_payment_link", - "section_anchor": "payment_links", - "subsection_anchors": null, - "path": "/payment_links/payment_links/list", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "request", - "title": "List all payment links", - "description": "Returns a list of your payment links.", - "top_level_changes": [], - "changes": {}, - "version": null, - "returns": "A dictionary with a \u003Ccode\u003Edata\u003C/code\u003E property that contains an array of up to \u003Ccode\u003Elimit\u003C/code\u003E payment links, starting after payment link \u003Ccode\u003Estarting_after\u003C/code\u003E. Each entry in the array is a separate payment link object. If no more payment links are available, the resulting array will be empty. This request should never return an error.", - "section_tag": "list_payment_link", - "specs": { - "active": { - "name": "active", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).", - "undocumented": false, - "html": "Only return payment links that are active or inactive (e.g., pass \u003Ccode\u003Efalse\u003C/code\u003E to list all inactive payment links)." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "active" - }, - "ending_before": { - "name": "ending_before", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "undocumented": false, - "html": "A cursor for use in pagination. \u003Ccode\u003Eending_before\u003C/code\u003E is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with \u003Ccode\u003Eobj_bar\u003C/code\u003E, your subsequent call can include \u003Ccode\u003Eending_before=obj_bar\u003C/code\u003E in order to fetch the previous page of the list." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "ending_before", - "less_common": true - }, - "limit": { - "name": "limit", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "undocumented": false, - "html": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "limit", - "less_common": true - }, - "starting_after": { - "name": "starting_after", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "undocumented": false, - "html": "A cursor for use in pagination. \u003Ccode\u003Estarting_after\u003C/code\u003E is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with \u003Ccode\u003Eobj_foo\u003C/code\u003E, your subsequent call can include \u003Ccode\u003Estarting_after=obj_foo\u003C/code\u003E in order to fetch the next page of the list." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "starting_after", - "less_common": true - } - }, - "supported_languages": null, - "action": "method", - "curl_definition": "GET /v1/payment_links", - "request": null, - "request_data": { - "test_key": "sk_test_4eC39HqLyjWDarjtT1zdp7dc", - "action_type": "list", - "action_name": null, - "action_path": null, - "resource_name": "payment_link", - "parent_resource_name": null, - "namespace": null, - "test_helper": false, - "request_params": { "limit": 3 }, - "url_params": {}, - "overridden_languages": [], - "preamble_comment": null - }, - "response": "{\n \"object\": \"list\",\n \"url\": \"/v1/payment_links\",\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"plink_1MWb7e2eZvKYlo2CTAnxRZDR\",\n \"object\": \"payment_link\",\n \"active\": true,\n \"after_completion\": {\n \"hosted_confirmation\": {\n \"custom_message\": null\n },\n \"type\": \"hosted_confirmation\"\n },\n \"allow_promotion_codes\": false,\n \"application_fee_amount\": null,\n \"application_fee_percent\": null,\n \"automatic_tax\": {\n \"enabled\": false\n },\n \"billing_address_collection\": \"auto\",\n \"consent_collection\": null,\n \"currency\": \"usd\",\n \"custom_text\": {\n \"shipping_address\": null,\n \"submit\": null\n },\n \"customer_creation\": \"always\",\n \"livemode\": false,\n \"metadata\": {\n },\n \"on_behalf_of\": null,\n \"payment_intent_data\": null,\n \"payment_method_collection\": \"always\",\n \"payment_method_types\": null,\n \"phone_number_collection\": {\n \"enabled\": false\n },\n \"shipping_address_collection\": null,\n \"shipping_options\": [\n \n ],\n \"submit_type\": \"auto\",\n \"subscription_data\": null,\n \"tax_id_collection\": {\n \"enabled\": false\n },\n \"transfer_data\": null,\n \"url\": \"https://buy.stripe.com/test_5kAcPyarJaIPaQg4gg\"\n },\n {...},\n {...}\n ]\n}\n" - } - }, - "retrieve_payment_link_line_items": { - "title": "Retrieve a payment link's line items", - "group_title": "Payment Links", - "group_anchor": "payment_links_section", - "anchor": "retrieve_payment_link_line_items", - "section_anchor": "payment_links", - "subsection_anchors": null, - "path": "/payment_links/line_items", - "gate": false, - "display_on_load": true, - "data": { - "section_type": "request", - "title": "Retrieve a payment link's line items", - "description": "When retrieving a payment link, there is an includable \u003Cstrong\u003Eline_items\u003C/strong\u003E property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.", - "top_level_changes": [], - "changes": {}, - "version": null, - "returns": "A dictionary with a \u003Ccode\u003Edata\u003C/code\u003E property that contains an array of up to \u003Ccode\u003Elimit\u003C/code\u003E payment link line items, starting after Line Item \u003Ccode\u003Estarting_after\u003C/code\u003E. Each entry in the array is a separate Line Item object. If no more line items are available, the resulting array will be empty. ", - "section_tag": "retrieve_payment_link_line_items", - "specs": { - "ending_before": { - "name": "ending_before", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "undocumented": false, - "html": "A cursor for use in pagination. \u003Ccode\u003Eending_before\u003C/code\u003E is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with \u003Ccode\u003Eobj_bar\u003C/code\u003E, your subsequent call can include \u003Ccode\u003Eending_before=obj_bar\u003C/code\u003E in order to fetch the previous page of the list." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "ending_before", - "less_common": true - }, - "limit": { - "name": "limit", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "undocumented": false, - "html": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "object_type": "limit", - "less_common": true - }, - "starting_after": { - "name": "starting_after", - "check": null, - "validation": "", - "documentation": { - "gate_specific": {}, - "localize_terms": [], - "markdown": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "undocumented": false, - "html": "A cursor for use in pagination. \u003Ccode\u003Estarting_after\u003C/code\u003E is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with \u003Ccode\u003Eobj_foo\u003C/code\u003E, your subsequent call can include \u003Ccode\u003Estarting_after=obj_foo\u003C/code\u003E in order to fetch the next page of the list." - }, - "gate": false, - "hide_unset_desc": false, - "required": false, - "default": null, - "badge_text": null, - "requirement_text": null, - "permission": null, - "hide_nil": null, - "is_country_specific": false, - "deprecated_allow_empty": false, - "object_type": "starting_after", - "less_common": true - } - }, - "supported_languages": null, - "action": "method", - "curl_definition": "GET /v1/payment_links/:id/line_items", - "request": "curl https://api.stripe.com/v1/payment_links/plink_1MWb7e2eZvKYlo2CTAnxRZDR/line_items \\\n -u sk_test_4eC39HqLyjWDarjtT1zdp7dc:\n", - "request_data": null, - "response": "{\n \"object\": \"list\",\n \"url\": \"/v1/payment_links/plink_1MWb7e2eZvKYlo2CTAnxRZDR/line_items\",\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"li_1MWb7e2eZvKYlo2CouWkOJkL\",\n \"object\": \"item\",\n \"amount_discount\": 0,\n \"amount_subtotal\": 0,\n \"amount_tax\": 0,\n \"amount_total\": 0,\n \"currency\": \"usd\",\n \"description\": \"Gold Special\",\n \"price\": {\n \"id\": \"price_1MWXoV2eZvKYlo2CxNVrmRLD\",\n \"object\": \"price\",\n \"active\": true,\n \"billing_scheme\": \"per_unit\",\n \"created\": 1675225251,\n \"currency\": \"usd\",\n \"custom_unit_amount\": null,\n \"livemode\": false,\n \"lookup_key\": null,\n \"metadata\": {\n },\n \"nickname\": null,\n \"product\": \"prod_NH60TC6ig2RLb2\",\n \"recurring\": null,\n \"tax_behavior\": \"unspecified\",\n \"tiers_mode\": null,\n \"transform_quantity\": null,\n \"type\": \"one_time\",\n \"unit_amount\": 2000,\n \"unit_amount_decimal\": \"2000\"\n },\n \"quantity\": 1\n },\n {...},\n {...}\n ]\n}\n" - } - }, - "credit_notes": { - "title": "Credit Notes", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "credit_notes", - "section_anchor": "credit_notes", - "subsection_anchors": [ - "credit_note_object", - "credit_note_line_item_object", - "preview_credit_note", - "create_credit_note", - "retrieve_credit_note", - "update_credit_note", - "credit_note_lines", - "credit_note_preview_lines", - "void_credit_note", - "list_credit_notes" - ], - "path": "/credit_notes", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Credit Note", - "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit Notes](/docs/billing/invoices/credit-notes).\n", - "section_tag": "credit_notes", - "subsection_summaries": [ - { "anchor": "credit_note_object", "curl_definition": null }, - { "anchor": "credit_note_line_item_object", "curl_definition": null }, - { "anchor": "preview_credit_note", "curl_definition": "GET /v1/credit_notes/preview" }, - { "anchor": "create_credit_note", "curl_definition": "POST /v1/credit_notes" }, - { "anchor": "retrieve_credit_note", "curl_definition": "GET /v1/credit_notes/:id" }, - { "anchor": "update_credit_note", "curl_definition": "POST /v1/credit_notes/:id" }, - { - "anchor": "credit_note_lines", - "curl_definition": "GET /v1/credit_notes/:credit_note/lines" - }, - { - "anchor": "credit_note_preview_lines", - "curl_definition": "GET /v1/credit_notes/preview/lines" - }, - { "anchor": "void_credit_note", "curl_definition": "POST /v1/credit_notes/:id/void" }, - { "anchor": "list_credit_notes", "curl_definition": "GET /v1/credit_notes" } - ] - } - }, - "credit_note_object": { - "title": "The credit note object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "credit_note_object", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/object", - "gate": false, - "display_on_load": false - }, - "credit_note_line_item_object": { - "title": "The (Credit Note) line item object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "credit_note_line_item_object", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/line_item", - "gate": false, - "display_on_load": false - }, - "preview_credit_note": { - "title": "Preview a credit note", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "preview_credit_note", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/preview", - "gate": false, - "display_on_load": false - }, - "create_credit_note": { - "title": "Create a credit note", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_credit_note", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/create", - "gate": false, - "display_on_load": false - }, - "retrieve_credit_note": { - "title": "Retrieve a credit note", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_credit_note", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/retrieve", - "gate": false, - "display_on_load": false - }, - "update_credit_note": { - "title": "Update a credit note", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_credit_note", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/update", - "gate": false, - "display_on_load": false - }, - "credit_note_lines": { - "title": "Retrieve a credit note's line items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "credit_note_lines", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/lines", - "gate": false, - "display_on_load": false - }, - "credit_note_preview_lines": { - "title": "Retrieve a credit note preview's line items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "credit_note_preview_lines", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/preview_lines", - "gate": false, - "display_on_load": false - }, - "void_credit_note": { - "title": "Void a credit note", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "void_credit_note", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/void", - "gate": false, - "display_on_load": false - }, - "list_credit_notes": { - "title": "List all credit notes", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_credit_notes", - "section_anchor": "credit_notes", - "subsection_anchors": null, - "path": "/credit_notes/list", - "gate": false, - "display_on_load": false - }, - "customer_balance_transactions": { - "title": "Customer Balance Transactions", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "customer_balance_transactions", - "section_anchor": "customer_balance_transactions", - "subsection_anchors": [ - "customer_balance_transaction_object", - "create_customer_balance_transaction", - "retrieve_customer_balance_transaction", - "update_customer_balance_transaction", - "list_customer_balance_transactions" - ], - "path": "/customer_balance_transactions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Customer Balance Transaction", - "description": "Each customer has a [`balance`](/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer Balance](/docs/billing/customer/balance) to learn more.\n", - "section_tag": "customer_balance_transactions", - "subsection_summaries": [ - { "anchor": "customer_balance_transaction_object", "curl_definition": null }, - { - "anchor": "create_customer_balance_transaction", - "curl_definition": "POST /v1/customers/:id/balance_transactions" - }, - { - "anchor": "retrieve_customer_balance_transaction", - "curl_definition": "GET /v1/customers/:id/balance_transactions/:id" - }, - { - "anchor": "update_customer_balance_transaction", - "curl_definition": "POST /v1/customers/:id/balance_transactions/:id" - }, - { - "anchor": "list_customer_balance_transactions", - "curl_definition": "GET /v1/customers/:id/balance_transactions" - } - ] - } - }, - "customer_balance_transaction_object": { - "title": "The customer balance transaction object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "customer_balance_transaction_object", - "section_anchor": "customer_balance_transactions", - "subsection_anchors": null, - "path": "/customer_balance_transactions/object", - "gate": false, - "display_on_load": false - }, - "create_customer_balance_transaction": { - "title": "Create a customer balance transaction", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_customer_balance_transaction", - "section_anchor": "customer_balance_transactions", - "subsection_anchors": null, - "path": "/customer_balance_transactions/create", - "gate": false, - "display_on_load": false - }, - "retrieve_customer_balance_transaction": { - "title": "Retrieve a customer balance transaction", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_customer_balance_transaction", - "section_anchor": "customer_balance_transactions", - "subsection_anchors": null, - "path": "/customer_balance_transactions/retrieve", - "gate": false, - "display_on_load": false - }, - "update_customer_balance_transaction": { - "title": "Update a customer credit balance transaction", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_customer_balance_transaction", - "section_anchor": "customer_balance_transactions", - "subsection_anchors": null, - "path": "/customer_balance_transactions/update", - "gate": false, - "display_on_load": false - }, - "list_customer_balance_transactions": { - "title": "List customer balance transactions", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_customer_balance_transactions", - "section_anchor": "customer_balance_transactions", - "subsection_anchors": null, - "path": "/customer_balance_transactions/list", - "gate": false, - "display_on_load": false - }, - "customer_portal": { - "title": "Customer Portal", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "customer_portal", - "section_anchor": "customer_portal", - "subsection_anchors": [ - "portal_session_object", - "portal_configuration_object", - "create_portal_session", - "create_portal_configuration", - "update_portal_configuration", - "retrieve_portal_configuration", - "all_portal_configurations" - ], - "path": "/customer_portal", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Customer Portal", - "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nLearn more in the [integration guide](/docs/billing/subscriptions/integrating-customer-portal).\n", - "section_tag": "customer_portal", - "subsection_summaries": [ - { "anchor": "portal_session_object", "curl_definition": null }, - { "anchor": "portal_configuration_object", "curl_definition": null }, - { - "anchor": "create_portal_session", - "curl_definition": "POST /v1/billing_portal/sessions" - }, - { - "anchor": "create_portal_configuration", - "curl_definition": "POST /v1/billing_portal/configurations" - }, - { - "anchor": "update_portal_configuration", - "curl_definition": "POST /v1/billing_portal/configurations/:id" - }, - { - "anchor": "retrieve_portal_configuration", - "curl_definition": "GET /v1/billing_portal/configurations/:id" - }, - { - "anchor": "all_portal_configurations", - "curl_definition": "GET /v1/billing_portal/configurations" - } - ] - } - }, - "portal_session_object": { - "title": "The portal session object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "portal_session_object", - "section_anchor": "customer_portal", - "subsection_anchors": null, - "path": "/customer_portal/session", - "gate": false, - "display_on_load": false - }, - "portal_configuration_object": { - "title": "The portal configuration object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "portal_configuration_object", - "section_anchor": "customer_portal", - "subsection_anchors": null, - "path": "/customer_portal/configuration", - "gate": false, - "display_on_load": false - }, - "create_portal_session": { - "title": "Create a portal session", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_portal_session", - "section_anchor": "customer_portal", - "subsection_anchors": null, - "path": "/customer_portal/sessions/create", - "gate": false, - "display_on_load": false - }, - "create_portal_configuration": { - "title": "Create a portal configuration", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_portal_configuration", - "section_anchor": "customer_portal", - "subsection_anchors": null, - "path": "/customer_portal/configurations/create", - "gate": false, - "display_on_load": false - }, - "update_portal_configuration": { - "title": "Update a portal configuration", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_portal_configuration", - "section_anchor": "customer_portal", - "subsection_anchors": null, - "path": "/customer_portal/configurations/update", - "gate": false, - "display_on_load": false - }, - "retrieve_portal_configuration": { - "title": "Retrieve a portal configuration", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_portal_configuration", - "section_anchor": "customer_portal", - "subsection_anchors": null, - "path": "/customer_portal/configurations/retrieve", - "gate": false, - "display_on_load": false - }, - "all_portal_configurations": { - "title": "List portal configurations", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "all_portal_configurations", - "section_anchor": "customer_portal", - "subsection_anchors": null, - "path": "/customer_portal/configurations/list", - "gate": false, - "display_on_load": false - }, - "customer_tax_ids": { - "title": "Customer Tax IDs", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "customer_tax_ids", - "section_anchor": "customer_tax_ids", - "subsection_anchors": [ - "tax_id_object", - "create_tax_id", - "retrieve_tax_id", - "delete_tax_id", - "list_tax_ids" - ], - "path": "/customer_tax_ids", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Customer Tax IDs", - "description": "You can add one or multiple tax IDs to a [customer](/docs/api/customers).\nA customer's tax IDs are displayed on invoices and credit notes issued for the customer.\n\nRelated guide: [Customer Tax Identification Numbers](/docs/billing/taxes/tax-ids).\n", - "section_tag": "customer_tax_ids", - "subsection_summaries": [ - { "anchor": "tax_id_object", "curl_definition": null }, - { "anchor": "create_tax_id", "curl_definition": "POST /v1/customers/:id/tax_ids" }, - { "anchor": "retrieve_tax_id", "curl_definition": "GET /v1/customers/:id/tax_ids/:id" }, - { "anchor": "delete_tax_id", "curl_definition": "DELETE /v1/customers/:id/tax_ids/:id" }, - { "anchor": "list_tax_ids", "curl_definition": "GET /v1/customers/:id/tax_ids" } - ] - } - }, - "tax_id_object": { - "title": "The tax ID object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "tax_id_object", - "section_anchor": "customer_tax_ids", - "subsection_anchors": null, - "path": "/customer_tax_ids/object", - "gate": false, - "display_on_load": false - }, - "create_tax_id": { - "title": "Create a tax ID", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_tax_id", - "section_anchor": "customer_tax_ids", - "subsection_anchors": null, - "path": "/customer_tax_ids/create", - "gate": false, - "display_on_load": false - }, - "retrieve_tax_id": { - "title": "Retrieve a tax ID", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_tax_id", - "section_anchor": "customer_tax_ids", - "subsection_anchors": null, - "path": "/customer_tax_ids/retrieve", - "gate": false, - "display_on_load": false - }, - "delete_tax_id": { - "title": "Delete a tax ID", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "delete_tax_id", - "section_anchor": "customer_tax_ids", - "subsection_anchors": null, - "path": "/customer_tax_ids/delete", - "gate": false, - "display_on_load": false - }, - "list_tax_ids": { - "title": "List all tax IDs", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_tax_ids", - "section_anchor": "customer_tax_ids", - "subsection_anchors": null, - "path": "/customer_tax_ids/list", - "gate": false, - "display_on_load": false - }, - "invoices": { - "title": "Invoices", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "invoices", - "section_anchor": "invoices", - "subsection_anchors": [ - "invoice_object", - "invoice_line_item_object", - "create_invoice", - "retrieve_invoice", - "update_invoice", - "delete_invoice", - "finalize_invoice", - "pay_invoice", - "send_invoice", - "void_invoice", - "mark_uncollectible_invoice", - "invoice_lines", - "upcoming_invoice", - "upcoming_invoice_lines", - "list_invoices", - "search_invoices" - ], - "path": "/invoices", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Invoices", - "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](/docs/billing/invoices/workflow/#auto_advance), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](/docs/billing/customer/balance).\n\nRelated guide: [Send Invoices to Customers](/docs/billing/invoices/sending).\n", - "section_tag": "invoices", - "subsection_summaries": [ - { "anchor": "invoice_object", "curl_definition": null }, - { "anchor": "invoice_line_item_object", "curl_definition": null }, - { "anchor": "create_invoice", "curl_definition": "POST /v1/invoices" }, - { "anchor": "retrieve_invoice", "curl_definition": "GET /v1/invoices/:id" }, - { "anchor": "update_invoice", "curl_definition": "POST /v1/invoices/:id" }, - { "anchor": "delete_invoice", "curl_definition": "DELETE /v1/invoices/:id" }, - { "anchor": "finalize_invoice", "curl_definition": "POST /v1/invoices/:id/finalize" }, - { "anchor": "pay_invoice", "curl_definition": "POST /v1/invoices/:id/pay" }, - { "anchor": "send_invoice", "curl_definition": "POST /v1/invoices/:id/send" }, - { "anchor": "void_invoice", "curl_definition": "POST /v1/invoices/:id/void" }, - { - "anchor": "mark_uncollectible_invoice", - "curl_definition": "POST /v1/invoices/:id/mark_uncollectible" - }, - { "anchor": "invoice_lines", "curl_definition": "GET /v1/invoices/:id/lines" }, - { "anchor": "upcoming_invoice", "curl_definition": "GET /v1/invoices/upcoming" }, - { - "anchor": "upcoming_invoice_lines", - "curl_definition": "GET /v1/invoices/upcoming/lines" - }, - { "anchor": "list_invoices", "curl_definition": "GET /v1/invoices" }, - { "anchor": "search_invoices", "curl_definition": "GET /v1/invoices/search" } - ] - } - }, - "invoice_object": { - "title": "The Invoice object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "invoice_object", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/object", - "gate": false, - "display_on_load": false - }, - "invoice_line_item_object": { - "title": "The (Invoice) Line Item object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "invoice_line_item_object", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/line_item", - "gate": false, - "display_on_load": false - }, - "create_invoice": { - "title": "Create an invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/create", - "gate": false, - "display_on_load": false - }, - "retrieve_invoice": { - "title": "Retrieve an invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/retrieve", - "gate": false, - "display_on_load": false - }, - "update_invoice": { - "title": "Update an invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/update", - "gate": false, - "display_on_load": false - }, - "delete_invoice": { - "title": "Delete a draft invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "delete_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/delete", - "gate": false, - "display_on_load": false - }, - "finalize_invoice": { - "title": "Finalize an invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "finalize_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/finalize", - "gate": false, - "display_on_load": false - }, - "pay_invoice": { - "title": "Pay an invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "pay_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/pay", - "gate": false, - "display_on_load": false - }, - "send_invoice": { - "title": "Send an invoice for manual payment", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "send_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/send", - "gate": false, - "display_on_load": false - }, - "void_invoice": { - "title": "Void an invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "void_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/void", - "gate": false, - "display_on_load": false - }, - "mark_uncollectible_invoice": { - "title": "Mark an invoice as uncollectible", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "mark_uncollectible_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/mark_uncollectible", - "gate": false, - "display_on_load": false - }, - "invoice_lines": { - "title": "Retrieve an invoice's line items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "invoice_lines", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/invoice_lines", - "gate": false, - "display_on_load": false - }, - "upcoming_invoice": { - "title": "Retrieve an upcoming invoice", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "upcoming_invoice", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/upcoming", - "gate": false, - "display_on_load": false - }, - "upcoming_invoice_lines": { - "title": "Retrieve an upcoming invoice's line items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "upcoming_invoice_lines", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/upcoming_invoice_lines", - "gate": false, - "display_on_load": false - }, - "list_invoices": { - "title": "List all invoices", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_invoices", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/list", - "gate": false, - "display_on_load": false - }, - "search_invoices": { - "title": "Search invoices", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "search_invoices", - "section_anchor": "invoices", - "subsection_anchors": null, - "path": "/invoices/search", - "gate": false, - "display_on_load": false - }, - "invoiceitems": { - "title": "Invoice Items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "invoiceitems", - "section_anchor": "invoiceitems", - "subsection_anchors": [ - "invoiceitem_object", - "create_invoiceitem", - "retrieve_invoiceitem", - "update_invoiceitem", - "delete_invoiceitem", - "list_invoiceitems" - ], - "path": "/invoiceitems", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Invoice Items", - "description": "Sometimes you want to add a charge or credit to a customer, but actually\ncharge or credit the customer's card only at the end of a regular billing\ncycle. This is useful for combining several charges (to minimize\nper-transaction fees), or for having Stripe tabulate your usage-based billing\ntotals.\n\nRelated guide: [Subscription Invoices](/docs/billing/invoices/subscription#adding-upcoming-invoice-items).\n", - "section_tag": "invoiceitems", - "subsection_summaries": [ - { "anchor": "invoiceitem_object", "curl_definition": null }, - { "anchor": "create_invoiceitem", "curl_definition": "POST /v1/invoiceitems" }, - { "anchor": "retrieve_invoiceitem", "curl_definition": "GET /v1/invoiceitems/:id" }, - { "anchor": "update_invoiceitem", "curl_definition": "POST /v1/invoiceitems/:id" }, - { "anchor": "delete_invoiceitem", "curl_definition": "DELETE /v1/invoiceitems/:id" }, - { "anchor": "list_invoiceitems", "curl_definition": "GET /v1/invoiceitems" } - ] - } - }, - "invoiceitem_object": { - "title": "The invoiceitem object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "invoiceitem_object", - "section_anchor": "invoiceitems", - "subsection_anchors": null, - "path": "/invoiceitems/object", - "gate": false, - "display_on_load": false - }, - "create_invoiceitem": { - "title": "Create an invoice item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_invoiceitem", - "section_anchor": "invoiceitems", - "subsection_anchors": null, - "path": "/invoiceitems/create", - "gate": false, - "display_on_load": false - }, - "retrieve_invoiceitem": { - "title": "Retrieve an invoice item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_invoiceitem", - "section_anchor": "invoiceitems", - "subsection_anchors": null, - "path": "/invoiceitems/retrieve", - "gate": false, - "display_on_load": false - }, - "update_invoiceitem": { - "title": "Update an invoice item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_invoiceitem", - "section_anchor": "invoiceitems", - "subsection_anchors": null, - "path": "/invoiceitems/update", - "gate": false, - "display_on_load": false - }, - "delete_invoiceitem": { - "title": "Delete an invoice item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "delete_invoiceitem", - "section_anchor": "invoiceitems", - "subsection_anchors": null, - "path": "/invoiceitems/delete", - "gate": false, - "display_on_load": false - }, - "list_invoiceitems": { - "title": "List all invoice items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_invoiceitems", - "section_anchor": "invoiceitems", - "subsection_anchors": null, - "path": "/invoiceitems/list", - "gate": false, - "display_on_load": false - }, - "plans": { - "title": "Plans", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "plans", - "section_anchor": "plans", - "subsection_anchors": [ - "plan_object", - "create_plan", - "retrieve_plan", - "update_plan", - "delete_plan", - "list_plans" - ], - "path": "/plans", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Plans", - "description": "You can now model subscriptions more flexibly using the [Prices 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](#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](/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](/docs/products-prices/overview).\n", - "section_tag": "plans", - "subsection_summaries": [ - { "anchor": "plan_object", "curl_definition": null }, - { "anchor": "create_plan", "curl_definition": "POST /v1/plans" }, - { "anchor": "retrieve_plan", "curl_definition": "GET /v1/plans/:id" }, - { "anchor": "update_plan", "curl_definition": "POST /v1/plans/:id" }, - { "anchor": "delete_plan", "curl_definition": "DELETE /v1/plans/:id" }, - { "anchor": "list_plans", "curl_definition": "GET /v1/plans" } - ] - } - }, - "plan_object": { - "title": "The plan object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "plan_object", - "section_anchor": "plans", - "subsection_anchors": null, - "path": "/plans/object", - "gate": false, - "display_on_load": false - }, - "create_plan": { - "title": "Create a plan", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_plan", - "section_anchor": "plans", - "subsection_anchors": null, - "path": "/plans/create", - "gate": false, - "display_on_load": false - }, - "retrieve_plan": { - "title": "Retrieve a plan", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_plan", - "section_anchor": "plans", - "subsection_anchors": null, - "path": "/plans/retrieve", - "gate": false, - "display_on_load": false - }, - "update_plan": { - "title": "Update a plan", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_plan", - "section_anchor": "plans", - "subsection_anchors": null, - "path": "/plans/update", - "gate": false, - "display_on_load": false - }, - "delete_plan": { - "title": "Delete a plan", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "delete_plan", - "section_anchor": "plans", - "subsection_anchors": null, - "path": "/plans/delete", - "gate": false, - "display_on_load": false - }, - "list_plans": { - "title": "List all plans", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_plans", - "section_anchor": "plans", - "subsection_anchors": null, - "path": "/plans/list", - "gate": false, - "display_on_load": false - }, - "quotes": { - "title": "Quotes", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "quotes", - "section_anchor": "quotes", - "subsection_anchors": [ - "quote_object", - "create_quote", - "retrieve_quote", - "update_quote", - "finalize_quote", - "accept_quote", - "cancel_quote", - "download_pdf_method", - "list_line_item", - "list_upfront_line_item", - "list_quote" - ], - "path": "/quotes", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Quote", - "description": "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule.\n", - "section_tag": "quotes", - "subsection_summaries": [ - { "anchor": "quote_object", "curl_definition": null }, - { "anchor": "create_quote", "curl_definition": "POST /v1/quotes" }, - { "anchor": "retrieve_quote", "curl_definition": "GET /v1/quotes/:id" }, - { "anchor": "update_quote", "curl_definition": "POST /v1/quotes/:id" }, - { "anchor": "finalize_quote", "curl_definition": "POST /v1/quotes/:id/finalize" }, - { "anchor": "accept_quote", "curl_definition": "POST /v1/quotes/:id/accept" }, - { "anchor": "cancel_quote", "curl_definition": "POST /v1/quotes/:id/cancel" }, - { - "anchor": "download_pdf_method", - "curl_definition": "GET https://files.stripe.com/v1/quotes/:id/pdf" - }, - { "anchor": "list_line_item", "curl_definition": "GET /v1/quotes/:id/line_items" }, - { - "anchor": "list_upfront_line_item", - "curl_definition": "GET /v1/quotes/:id/computed_upfront_line_items" - }, - { "anchor": "list_quote", "curl_definition": "GET /v1/quotes" } - ] - } - }, - "quote_object": { - "title": "The quote object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "quote_object", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/object", - "gate": false, - "display_on_load": false - }, - "create_quote": { - "title": "Create a quote", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_quote", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/create", - "gate": false, - "display_on_load": false - }, - "retrieve_quote": { - "title": "Retrieve a quote", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_quote", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/retrieve", - "gate": false, - "display_on_load": false - }, - "update_quote": { - "title": "Update a quote", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_quote", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/update", - "gate": false, - "display_on_load": false - }, - "finalize_quote": { - "title": "Finalize a quote", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "finalize_quote", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/finalize", - "gate": false, - "display_on_load": false - }, - "accept_quote": { - "title": "Accept a quote", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "accept_quote", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/accept", - "gate": false, - "display_on_load": false - }, - "cancel_quote": { - "title": "Cancel a quote", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "cancel_quote", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/cancel", - "gate": false, - "display_on_load": false - }, - "download_pdf_method": { - "title": "Download quote PDF", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "download_pdf_method", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/pdf", - "gate": false, - "display_on_load": false - }, - "list_line_item": { - "title": "Retrieve a quote's line items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_line_item", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/line_items/list", - "gate": false, - "display_on_load": false - }, - "list_upfront_line_item": { - "title": "Retrieve a quote's upfront line items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_upfront_line_item", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/line_items/upfront/list", - "gate": false, - "display_on_load": false - }, - "list_quote": { - "title": "List all quotes", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_quote", - "section_anchor": "quotes", - "subsection_anchors": null, - "path": "/quotes/list", - "gate": false, - "display_on_load": false - }, - "subscriptions": { - "title": "Subscriptions", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "subscriptions", - "section_anchor": "subscriptions", - "subsection_anchors": [ - "subscription_object", - "create_subscription", - "retrieve_subscription", - "update_subscription", - "cancel_subscription", - "list_subscriptions", - "subscriptions_search" - ], - "path": "/subscriptions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Subscriptions", - "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating Subscriptions](/docs/billing/subscriptions/creating).\n", - "section_tag": "subscriptions", - "subsection_summaries": [ - { "anchor": "subscription_object", "curl_definition": null }, - { "anchor": "create_subscription", "curl_definition": "POST /v1/subscriptions" }, - { "anchor": "retrieve_subscription", "curl_definition": "GET /v1/subscriptions/:id" }, - { "anchor": "update_subscription", "curl_definition": "POST /v1/subscriptions/:id" }, - { "anchor": "cancel_subscription", "curl_definition": "DELETE /v1/subscriptions/:id" }, - { "anchor": "list_subscriptions", "curl_definition": "GET /v1/subscriptions" }, - { "anchor": "subscriptions_search", "curl_definition": "GET /v1/subscriptions/search" } - ] - } - }, - "subscription_object": { - "title": "The subscription object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "subscription_object", - "section_anchor": "subscriptions", - "subsection_anchors": null, - "path": "/subscriptions/object", - "gate": false, - "display_on_load": false - }, - "create_subscription": { - "title": "Create a subscription", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_subscription", - "section_anchor": "subscriptions", - "subsection_anchors": null, - "path": "/subscriptions/create", - "gate": false, - "display_on_load": false - }, - "retrieve_subscription": { - "title": "Retrieve a subscription", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_subscription", - "section_anchor": "subscriptions", - "subsection_anchors": null, - "path": "/subscriptions/retrieve", - "gate": false, - "display_on_load": false - }, - "update_subscription": { - "title": "Update a subscription", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_subscription", - "section_anchor": "subscriptions", - "subsection_anchors": null, - "path": "/subscriptions/update", - "gate": false, - "display_on_load": false - }, - "cancel_subscription": { - "title": "Cancel a subscription", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "cancel_subscription", - "section_anchor": "subscriptions", - "subsection_anchors": null, - "path": "/subscriptions/cancel", - "gate": false, - "display_on_load": false - }, - "list_subscriptions": { - "title": "List subscriptions", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_subscriptions", - "section_anchor": "subscriptions", - "subsection_anchors": null, - "path": "/subscriptions/list", - "gate": false, - "display_on_load": false - }, - "subscriptions_search": { - "title": "Search subscriptions", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "subscriptions_search", - "section_anchor": "subscriptions", - "subsection_anchors": null, - "path": "/subscriptions/search", - "gate": false, - "display_on_load": false - }, - "subscription_items": { - "title": "Subscription Items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "subscription_items", - "section_anchor": "subscription_items", - "subsection_anchors": [ - "subscription_item_object", - "create_subscription_item", - "retrieve_subscription_item", - "update_subscription_item", - "delete_subscription_item", - "list_subscription_items" - ], - "path": "/subscription_items", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Subscription Items", - "description": "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.\n", - "section_tag": "subscription_items", - "subsection_summaries": [ - { "anchor": "subscription_item_object", "curl_definition": null }, - { "anchor": "create_subscription_item", "curl_definition": "POST /v1/subscription_items" }, - { - "anchor": "retrieve_subscription_item", - "curl_definition": "GET /v1/subscription_items/:id" - }, - { - "anchor": "update_subscription_item", - "curl_definition": "POST /v1/subscription_items/:id" - }, - { - "anchor": "delete_subscription_item", - "curl_definition": "DELETE /v1/subscription_items/:id" - }, - { "anchor": "list_subscription_items", "curl_definition": "GET /v1/subscription_items" } - ] - } - }, - "subscription_item_object": { - "title": "The subscription item object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "subscription_item_object", - "section_anchor": "subscription_items", - "subsection_anchors": null, - "path": "/subscription_items/object", - "gate": false, - "display_on_load": false - }, - "create_subscription_item": { - "title": "Create a subscription item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_subscription_item", - "section_anchor": "subscription_items", - "subsection_anchors": null, - "path": "/subscription_items/create", - "gate": false, - "display_on_load": false - }, - "retrieve_subscription_item": { - "title": "Retrieve a subscription item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_subscription_item", - "section_anchor": "subscription_items", - "subsection_anchors": null, - "path": "/subscription_items/retrieve", - "gate": false, - "display_on_load": false - }, - "update_subscription_item": { - "title": "Update a subscription item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_subscription_item", - "section_anchor": "subscription_items", - "subsection_anchors": null, - "path": "/subscription_items/update", - "gate": false, - "display_on_load": false - }, - "delete_subscription_item": { - "title": "Delete a subscription item", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "delete_subscription_item", - "section_anchor": "subscription_items", - "subsection_anchors": null, - "path": "/subscription_items/delete", - "gate": false, - "display_on_load": false - }, - "list_subscription_items": { - "title": "List all subscription items", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_subscription_items", - "section_anchor": "subscription_items", - "subsection_anchors": null, - "path": "/subscription_items/list", - "gate": false, - "display_on_load": false - }, - "subscription_schedules": { - "title": "Subscription Schedules", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "subscription_schedules", - "section_anchor": "subscription_schedules", - "subsection_anchors": [ - "subscription_schedule_object", - "create_subscription_schedule", - "retrieve_subscription_schedule", - "update_subscription_schedule", - "cancel_subscription_schedule", - "release_subscription_schedule", - "list_subscription_schedules" - ], - "path": "/subscription_schedules", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Subscription Schedule", - "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription Schedules](/docs/billing/subscriptions/subscription-schedules).\n", - "section_tag": "subscription_schedules", - "subsection_summaries": [ - { "anchor": "subscription_schedule_object", "curl_definition": null }, - { - "anchor": "create_subscription_schedule", - "curl_definition": "POST /v1/subscription_schedules" - }, - { - "anchor": "retrieve_subscription_schedule", - "curl_definition": "GET /v1/subscription_schedules/:id" - }, - { - "anchor": "update_subscription_schedule", - "curl_definition": "POST /v1/subscription_schedules/:id" - }, - { - "anchor": "cancel_subscription_schedule", - "curl_definition": "POST /v1/subscription_schedules/:id/cancel" - }, - { - "anchor": "release_subscription_schedule", - "curl_definition": "POST /v1/subscription_schedules/:id/release" - }, - { - "anchor": "list_subscription_schedules", - "curl_definition": "GET /v1/subscription_schedules" - } - ] - } - }, - "subscription_schedule_object": { - "title": "The schedule object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "subscription_schedule_object", - "section_anchor": "subscription_schedules", - "subsection_anchors": null, - "path": "/subscription_schedules/object", - "gate": false, - "display_on_load": false - }, - "create_subscription_schedule": { - "title": "Create a schedule", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_subscription_schedule", - "section_anchor": "subscription_schedules", - "subsection_anchors": null, - "path": "/subscription_schedules/create", - "gate": false, - "display_on_load": false - }, - "retrieve_subscription_schedule": { - "title": "Retrieve a schedule", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_subscription_schedule", - "section_anchor": "subscription_schedules", - "subsection_anchors": null, - "path": "/subscription_schedules/retrieve", - "gate": false, - "display_on_load": false - }, - "update_subscription_schedule": { - "title": "Update a schedule", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "update_subscription_schedule", - "section_anchor": "subscription_schedules", - "subsection_anchors": null, - "path": "/subscription_schedules/update", - "gate": false, - "display_on_load": false - }, - "cancel_subscription_schedule": { - "title": "Cancel a schedule", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "cancel_subscription_schedule", - "section_anchor": "subscription_schedules", - "subsection_anchors": null, - "path": "/subscription_schedules/cancel", - "gate": false, - "display_on_load": false - }, - "release_subscription_schedule": { - "title": "Release a schedule", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "release_subscription_schedule", - "section_anchor": "subscription_schedules", - "subsection_anchors": null, - "path": "/subscription_schedules/release", - "gate": false, - "display_on_load": false - }, - "list_subscription_schedules": { - "title": "List all schedules", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_subscription_schedules", - "section_anchor": "subscription_schedules", - "subsection_anchors": null, - "path": "/subscription_schedules/list", - "gate": false, - "display_on_load": false - }, - "test_clocks": { - "title": "Test Clocks", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "test_clocks", - "section_anchor": "test_clocks", - "subsection_anchors": [ - "test_clock_object", - "create_test_clock", - "retrieve_test_clock", - "delete_test_clock", - "advance_test_clock", - "list_test_clocks" - ], - "path": "/test_clocks", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Test Clocks", - "description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.\n", - "section_tag": "test_clocks", - "subsection_summaries": [ - { "anchor": "test_clock_object", "curl_definition": null }, - { "anchor": "create_test_clock", "curl_definition": "POST /v1/test_helpers/test_clocks" }, - { - "anchor": "retrieve_test_clock", - "curl_definition": "GET /v1/test_helpers/test_clocks/:id" - }, - { - "anchor": "delete_test_clock", - "curl_definition": "DELETE /v1/test_helpers/test_clocks/:id" - }, - { - "anchor": "advance_test_clock", - "curl_definition": "POST /v1/test_helpers/test_clocks/:id/advance" - }, - { "anchor": "list_test_clocks", "curl_definition": "GET /v1/test_helpers/test_clocks" } - ] - } - }, - "test_clock_object": { - "title": "The test clock object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "test_clock_object", - "section_anchor": "test_clocks", - "subsection_anchors": null, - "path": "/test_clocks/object", - "gate": false, - "display_on_load": false - }, - "create_test_clock": { - "title": "Create a test clock", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "create_test_clock", - "section_anchor": "test_clocks", - "subsection_anchors": null, - "path": "/test_clocks/create", - "gate": false, - "display_on_load": false - }, - "retrieve_test_clock": { - "title": "Retrieve a test clock", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "retrieve_test_clock", - "section_anchor": "test_clocks", - "subsection_anchors": null, - "path": "/test_clocks/retrieve", - "gate": false, - "display_on_load": false - }, - "delete_test_clock": { - "title": "Delete a test clock", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "delete_test_clock", - "section_anchor": "test_clocks", - "subsection_anchors": null, - "path": "/test_clocks/delete", - "gate": false, - "display_on_load": false - }, - "advance_test_clock": { - "title": "Advance a test clock", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "advance_test_clock", - "section_anchor": "test_clocks", - "subsection_anchors": null, - "path": "/test_clocks/advance", - "gate": false, - "display_on_load": false - }, - "list_test_clocks": { - "title": "List all test clocks", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "list_test_clocks", - "section_anchor": "test_clocks", - "subsection_anchors": null, - "path": "/test_clocks/list", - "gate": false, - "display_on_load": false - }, - "usage_records": { - "title": "Usage Records", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "usage_records", - "section_anchor": "usage_records", - "subsection_anchors": [ - "usage_record_object", - "usage_record_create", - "usage_record_summary_all" - ], - "path": "/usage_records", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Usage Records", - "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered Billing](/docs/billing/subscriptions/metered-billing).\n", - "section_tag": "usage_records", - "subsection_summaries": [ - { "anchor": "usage_record_object", "curl_definition": null }, - { - "anchor": "usage_record_create", - "curl_definition": "POST /v1/subscription_items/:id/usage_records" - }, - { - "anchor": "usage_record_summary_all", - "curl_definition": "GET /v1/subscription_items/:id/usage_record_summaries" - } - ] - } - }, - "usage_record_object": { - "title": "The usage record object", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "usage_record_object", - "section_anchor": "usage_records", - "subsection_anchors": null, - "path": "/usage_records/object", - "gate": false, - "display_on_load": false - }, - "usage_record_create": { - "title": "Create a usage record", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "usage_record_create", - "section_anchor": "usage_records", - "subsection_anchors": null, - "path": "/usage_records/create", - "gate": false, - "display_on_load": false - }, - "usage_record_summary_all": { - "title": "List all subscription item period summaries", - "group_title": "Billing", - "group_anchor": "billing", - "anchor": "usage_record_summary_all", - "section_anchor": "usage_records", - "subsection_anchors": null, - "path": "/usage_records/subscription_item_summary_list", - "gate": false, - "display_on_load": false - }, - "accounts": { - "title": "Accounts", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "accounts", - "section_anchor": "accounts", - "subsection_anchors": [ - "account_object", - "create_account", - "retrieve_account", - "update_account", - "delete_account", - "reject_account", - "list_accounts", - "login_link_object", - "create_login_link" - ], - "path": "/accounts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Accounts", - "description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current e-mail address or if the account is\nenabled yet to make live charges.\n\nSome properties, marked below, are available only to platforms that want to\n[create and manage Express or Custom accounts](/docs/connect/accounts).\n", - "section_tag": "accounts", - "subsection_summaries": [ - { "anchor": "account_object", "curl_definition": null }, - { "anchor": "create_account", "curl_definition": "POST /v1/accounts" }, - { "anchor": "retrieve_account", "curl_definition": "GET /v1/accounts/:id" }, - { "anchor": "update_account", "curl_definition": "POST /v1/accounts/:id" }, - { "anchor": "delete_account", "curl_definition": "DELETE /v1/accounts/:id" }, - { "anchor": "reject_account", "curl_definition": "POST /v1/accounts/:id/reject" }, - { "anchor": "list_accounts", "curl_definition": "GET /v1/accounts" }, - { "anchor": "login_link_object", "curl_definition": null }, - { "anchor": "create_login_link", "curl_definition": "POST /v1/accounts/:id/login_links" } - ] - } - }, - "account_object": { - "title": "The account object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_object", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/accounts/object", - "gate": false, - "display_on_load": false - }, - "create_account": { - "title": "Create an account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_account", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/accounts/create", - "gate": false, - "display_on_load": false - }, - "retrieve_account": { - "title": "Retrieve account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_account", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/accounts/retrieve", - "gate": false, - "display_on_load": false - }, - "update_account": { - "title": "Update an account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "update_account", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/accounts/update", - "gate": false, - "display_on_load": false - }, - "delete_account": { - "title": "Delete an account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "delete_account", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/accounts/delete", - "gate": false, - "display_on_load": false - }, - "reject_account": { - "title": "Reject an account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "reject_account", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/account/reject", - "gate": false, - "display_on_load": false - }, - "list_accounts": { - "title": "List all connected accounts", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_accounts", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/accounts/list", - "gate": false, - "display_on_load": false - }, - "login_link_object": { - "title": "The login link object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "login_link_object", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/account/login_link", - "gate": false, - "display_on_load": false - }, - "create_login_link": { - "title": "Create a login link", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_login_link", - "section_anchor": "accounts", - "subsection_anchors": null, - "path": "/account/create_login_link", - "gate": false, - "display_on_load": false - }, - "account_links": { - "title": "Account Links", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_links", - "section_anchor": "account_links", - "subsection_anchors": ["account_link_object", "create_account_link"], - "path": "/account_links", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Account Links", - "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](/docs/connect/connect-onboarding).\n", - "section_tag": "account_links", - "subsection_summaries": [ - { "anchor": "account_link_object", "curl_definition": null }, - { "anchor": "create_account_link", "curl_definition": "POST /v1/account_links" } - ] - } - }, - "account_link_object": { - "title": "The account link object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_link_object", - "section_anchor": "account_links", - "subsection_anchors": null, - "path": "/account_links/object", - "gate": false, - "display_on_load": false - }, - "create_account_link": { - "title": "Create an account link", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_account_link", - "section_anchor": "account_links", - "subsection_anchors": null, - "path": "/account_links/create", - "gate": false, - "display_on_load": false - }, - "account_sessions": { - "title": "Account Sessions", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_sessions", - "section_anchor": "account_sessions", - "subsection_anchors": ["account_session_object", "create_account_session"], - "path": "/account_sessions", - "gate": true, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Account Session", - "description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded UIs.\n\nWe recommend that you create an AccountSession each time you need to display an embedded UI\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded UIs](/docs/connect/get-started-connect-embedded-uis).\n", - "section_tag": "account_sessions", - "subsection_summaries": [ - { "anchor": "account_session_object", "curl_definition": null }, - { "anchor": "create_account_session", "curl_definition": "POST /v1/account_sessions" } - ] - } - }, - "account_session_object": { - "title": "The account session object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_session_object", - "section_anchor": "account_sessions", - "subsection_anchors": null, - "path": "/account_sessions/object", - "gate": false, - "display_on_load": false - }, - "create_account_session": { - "title": "Create an Account Session", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_account_session", - "section_anchor": "account_sessions", - "subsection_anchors": null, - "path": "/account_sessions/create", - "gate": false, - "display_on_load": false - }, - "application_fees": { - "title": "Application Fees", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "application_fees", - "section_anchor": "application_fees", - "subsection_anchors": [ - "application_fee_object", - "retrieve_application_fee", - "list_application_fees" - ], - "path": "/application_fees", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Application Fees", - "description": "When you collect a transaction fee on top of a charge made for your user\n(using [Connect](/docs/connect)), an `Application Fee` object is created in\nyour account. You can list, retrieve, and refund application fees.\n\nRelated guide: [Collecting Application Fees](/docs/connect/direct-charges#collecting-fees).\n", - "section_tag": "application_fees", - "subsection_summaries": [ - { "anchor": "application_fee_object", "curl_definition": null }, - { "anchor": "retrieve_application_fee", "curl_definition": "GET /v1/application_fees/:id" }, - { "anchor": "list_application_fees", "curl_definition": "GET /v1/application_fees" } - ] - } - }, - "application_fee_object": { - "title": "The application fee object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "application_fee_object", - "section_anchor": "application_fees", - "subsection_anchors": null, - "path": "/application_fees/object", - "gate": false, - "display_on_load": false - }, - "retrieve_application_fee": { - "title": "Retrieve an application fee", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_application_fee", - "section_anchor": "application_fees", - "subsection_anchors": null, - "path": "/application_fees/retrieve", - "gate": false, - "display_on_load": false - }, - "list_application_fees": { - "title": "List all application fees", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_application_fees", - "section_anchor": "application_fees", - "subsection_anchors": null, - "path": "/application_fees/list", - "gate": false, - "display_on_load": false - }, - "fee_refunds": { - "title": "Application Fee Refunds", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "fee_refunds", - "section_anchor": "fee_refunds", - "subsection_anchors": [ - "fee_refund_object", - "create_fee_refund", - "retrieve_fee_refund", - "update_fee_refund", - "list_fee_refunds" - ], - "path": "/fee_refunds", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Application Fee Refunds", - "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding Application Fees](/docs/connect/destination-charges#refunding-app-fee).\n", - "section_tag": "fee_refunds", - "subsection_summaries": [ - { "anchor": "fee_refund_object", "curl_definition": null }, - { - "anchor": "create_fee_refund", - "curl_definition": "POST /v1/application_fees/:id/refunds" - }, - { - "anchor": "retrieve_fee_refund", - "curl_definition": "GET /v1/application_fees/:id/refunds/:id" - }, - { - "anchor": "update_fee_refund", - "curl_definition": "POST /v1/application_fees/:id/refunds/:id" - }, - { "anchor": "list_fee_refunds", "curl_definition": "GET /v1/application_fees/:id/refunds" } - ] - } - }, - "fee_refund_object": { - "title": "The application fee refund object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "fee_refund_object", - "section_anchor": "fee_refunds", - "subsection_anchors": null, - "path": "/fee_refunds/object", - "gate": false, - "display_on_load": false - }, - "create_fee_refund": { - "title": "Create an application fee refund", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_fee_refund", - "section_anchor": "fee_refunds", - "subsection_anchors": null, - "path": "/fee_refunds/create", - "gate": false, - "display_on_load": false - }, - "retrieve_fee_refund": { - "title": "Retrieve an application fee refund", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_fee_refund", - "section_anchor": "fee_refunds", - "subsection_anchors": null, - "path": "/fee_refunds/retrieve", - "gate": false, - "display_on_load": false - }, - "update_fee_refund": { - "title": "Update an application fee refund", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "update_fee_refund", - "section_anchor": "fee_refunds", - "subsection_anchors": null, - "path": "/fee_refunds/update", - "gate": false, - "display_on_load": false - }, - "list_fee_refunds": { - "title": "List all application fee refunds", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_fee_refunds", - "section_anchor": "fee_refunds", - "subsection_anchors": null, - "path": "/fee_refunds/list", - "gate": false, - "display_on_load": false - }, - "capabilities": { - "title": "Capabilities", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "capabilities", - "section_anchor": "capabilities", - "subsection_anchors": [ - "capability_object", - "retrieve_capability", - "update_capability", - "list_capability" - ], - "path": "/capabilities", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Capabilities", - "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](/docs/connect/account-capabilities).\n", - "section_tag": "capabilities", - "subsection_summaries": [ - { "anchor": "capability_object", "curl_definition": null }, - { - "anchor": "retrieve_capability", - "curl_definition": "GET /v1/accounts/:id/capabilities/:id" - }, - { - "anchor": "update_capability", - "curl_definition": "POST /v1/accounts/:id/capabilities/:id" - }, - { "anchor": "list_capability", "curl_definition": "GET /v1/accounts/:id/capabilities" } - ] - } - }, - "capability_object": { - "title": "The capability object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "capability_object", - "section_anchor": "capabilities", - "subsection_anchors": null, - "path": "/capabilities/object", - "gate": false, - "display_on_load": false - }, - "retrieve_capability": { - "title": "Retrieve an Account Capability", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_capability", - "section_anchor": "capabilities", - "subsection_anchors": null, - "path": "/capabilities/retrieve", - "gate": false, - "display_on_load": false - }, - "update_capability": { - "title": "Update an Account Capability", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "update_capability", - "section_anchor": "capabilities", - "subsection_anchors": null, - "path": "/capabilities/update", - "gate": false, - "display_on_load": false - }, - "list_capability": { - "title": "List all account capabilities", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_capability", - "section_anchor": "capabilities", - "subsection_anchors": null, - "path": "/capabilities/list", - "gate": false, - "display_on_load": false - }, - "country_specs": { - "title": "Country Specs", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "country_specs", - "section_anchor": "country_specs", - "subsection_anchors": ["country_spec_object", "list_country_specs", "retrieve_country_spec"], - "path": "/country_specs", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Country Specs", - "description": "Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information).\n", - "section_tag": "country_specs", - "subsection_summaries": [ - { "anchor": "country_spec_object", "curl_definition": null }, - { "anchor": "list_country_specs", "curl_definition": "GET /v1/country_specs" }, - { "anchor": "retrieve_country_spec", "curl_definition": "GET /v1/country_specs/:id" } - ] - } - }, - "country_spec_object": { - "title": "The country spec object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "country_spec_object", - "section_anchor": "country_specs", - "subsection_anchors": null, - "path": "/country_specs/object", - "gate": false, - "display_on_load": false - }, - "list_country_specs": { - "title": "List Country Specs", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_country_specs", - "section_anchor": "country_specs", - "subsection_anchors": null, - "path": "/country_specs/list", - "gate": false, - "display_on_load": false - }, - "retrieve_country_spec": { - "title": "Retrieve a Country Spec", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_country_spec", - "section_anchor": "country_specs", - "subsection_anchors": null, - "path": "/country_specs/retrieve", - "gate": false, - "display_on_load": false - }, - "external_accounts": { - "title": "External Accounts", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "external_accounts", - "section_anchor": "external_accounts", - "subsection_anchors": [ - "account_bank_account_object", - "account_create_bank_account", - "account_retrieve_bank_account", - "account_update_bank_account", - "account_delete_bank_account", - "account_list_bank_accounts", - "account_card_object", - "account_create_card", - "account_retrieve_card", - "account_update_card", - "account_delete_card", - "account_list_cards" - ], - "path": "/external_accounts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "External Accounts", - "description": "External Accounts are transfer destinations on `Account` objects for\n[connected accounts](/docs/connect/accounts). They can be bank accounts or\ndebit cards.\n\n[Bank accounts](/docs/api#customer_bank_account_object) and [debit\ncards](/docs/api#card_object) can also be used as payment sources\non regular charges, and are documented in the links above.\n\nRelated guide: [Setting Bank and Debit Card Payouts](/docs/connect/bank-debit-card-payouts).\n", - "section_tag": "external_accounts", - "subsection_summaries": [ - { "anchor": "account_bank_account_object", "curl_definition": null }, - { - "anchor": "account_create_bank_account", - "curl_definition": "POST /v1/accounts/:id/external_accounts" - }, - { - "anchor": "account_retrieve_bank_account", - "curl_definition": "GET /v1/accounts/:id/external_accounts/:id" - }, - { - "anchor": "account_update_bank_account", - "curl_definition": "POST /v1/accounts/:id/external_accounts/:id" - }, - { - "anchor": "account_delete_bank_account", - "curl_definition": "DELETE /v1/accounts/:id/external_accounts/:id" - }, - { - "anchor": "account_list_bank_accounts", - "curl_definition": "GET /v1/accounts/:id/external_accounts?object=bank_account" - }, - { "anchor": "account_card_object", "curl_definition": null }, - { - "anchor": "account_create_card", - "curl_definition": "POST /v1/accounts/:id/external_accounts" - }, - { - "anchor": "account_retrieve_card", - "curl_definition": "GET /v1/accounts/:id/external_accounts/:id" - }, - { - "anchor": "account_update_card", - "curl_definition": "POST /v1/accounts/:id/external_accounts/:id" - }, - { - "anchor": "account_delete_card", - "curl_definition": "DELETE /v1/accounts/:id/external_accounts/:id" - }, - { - "anchor": "account_list_cards", - "curl_definition": "GET /v1/accounts/:id/external_accounts?object=card" - } - ] - } - }, - "account_bank_account_object": { - "title": "The (account) bank account object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_bank_account_object", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_bank_accounts/object", - "gate": false, - "display_on_load": false - }, - "account_create_bank_account": { - "title": "Create a bank account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_create_bank_account", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_bank_accounts/create", - "gate": false, - "display_on_load": false - }, - "account_retrieve_bank_account": { - "title": "Retrieve a bank account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_retrieve_bank_account", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_bank_accounts/retrieve", - "gate": false, - "display_on_load": false - }, - "account_update_bank_account": { - "title": "Update a bank account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_update_bank_account", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_bank_accounts/update", - "gate": false, - "display_on_load": false - }, - "account_delete_bank_account": { - "title": "Delete a bank account", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_delete_bank_account", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_bank_accounts/delete", - "gate": false, - "display_on_load": false - }, - "account_list_bank_accounts": { - "title": "List all bank accounts", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_list_bank_accounts", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_bank_accounts/list", - "gate": false, - "display_on_load": false - }, - "account_card_object": { - "title": "The (account) card object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_card_object", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_cards/object", - "gate": false, - "display_on_load": false - }, - "account_create_card": { - "title": "Create a card", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_create_card", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_cards/create", - "gate": false, - "display_on_load": false - }, - "account_retrieve_card": { - "title": "Retrieve a card", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_retrieve_card", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_cards/retrieve", - "gate": false, - "display_on_load": false - }, - "account_update_card": { - "title": "Update a card", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_update_card", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_cards/update", - "gate": false, - "display_on_load": false - }, - "account_delete_card": { - "title": "Delete a card", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_delete_card", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_cards/delete", - "gate": false, - "display_on_load": false - }, - "account_list_cards": { - "title": "List all cards", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "account_list_cards", - "section_anchor": "external_accounts", - "subsection_anchors": null, - "path": "/external_account_cards/list", - "gate": false, - "display_on_load": false - }, - "persons": { - "title": "Persons", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "persons", - "section_anchor": "persons", - "subsection_anchors": [ - "person_object", - "create_person", - "retrieve_person", - "update_person", - "delete_person", - "list_person" - ], - "path": "/persons", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "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](/docs/connect/standard-accounts) or [Express onboarding documentation](/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.\n\nRelated guide: [Handling Identity Verification with the API](/docs/connect/identity-verification-api#person-information).\n", - "section_tag": "persons", - "subsection_summaries": [ - { "anchor": "person_object", "curl_definition": null }, - { "anchor": "create_person", "curl_definition": "POST /v1/accounts/:id/persons" }, - { "anchor": "retrieve_person", "curl_definition": "GET /v1/accounts/:id/persons/:id" }, - { "anchor": "update_person", "curl_definition": "POST /v1/accounts/:id/persons/:id" }, - { "anchor": "delete_person", "curl_definition": "DELETE /v1/accounts/:id/persons/:id" }, - { "anchor": "list_person", "curl_definition": "GET /v1/accounts/:id/persons" } - ] - } - }, - "person_object": { - "title": "The person object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "person_object", - "section_anchor": "persons", - "subsection_anchors": null, - "path": "/persons/object", - "gate": false, - "display_on_load": false - }, - "create_person": { - "title": "Create a person", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_person", - "section_anchor": "persons", - "subsection_anchors": null, - "path": "/persons/create", - "gate": false, - "display_on_load": false - }, - "retrieve_person": { - "title": "Retrieve a person", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_person", - "section_anchor": "persons", - "subsection_anchors": null, - "path": "/persons/retrieve", - "gate": false, - "display_on_load": false - }, - "update_person": { - "title": "Update a person", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "update_person", - "section_anchor": "persons", - "subsection_anchors": null, - "path": "/persons/update", - "gate": false, - "display_on_load": false - }, - "delete_person": { - "title": "Delete a person", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "delete_person", - "section_anchor": "persons", - "subsection_anchors": null, - "path": "/persons/delete", - "gate": false, - "display_on_load": false - }, - "list_person": { - "title": "List all persons", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_person", - "section_anchor": "persons", - "subsection_anchors": null, - "path": "/persons/list", - "gate": false, - "display_on_load": false - }, - "topups": { - "title": "Top-ups", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "topups", - "section_anchor": "topups", - "subsection_anchors": [ - "topup_object", - "create_topup", - "retrieve_topup", - "update_topup", - "list_topups", - "cancel_topup" - ], - "path": "/topups", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Top-ups", - "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping Up your Platform Account](/docs/connect/top-ups).\n", - "section_tag": "topups", - "subsection_summaries": [ - { "anchor": "topup_object", "curl_definition": null }, - { "anchor": "create_topup", "curl_definition": "POST /v1/topups" }, - { "anchor": "retrieve_topup", "curl_definition": "GET /v1/topups/:id" }, - { "anchor": "update_topup", "curl_definition": "POST /v1/topups/:id" }, - { "anchor": "list_topups", "curl_definition": "GET /v1/topups" }, - { "anchor": "cancel_topup", "curl_definition": "POST /v1/topups/:id/cancel" } - ] - } - }, - "topup_object": { - "title": "The top-up object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "topup_object", - "section_anchor": "topups", - "subsection_anchors": null, - "path": "/topups/object", - "gate": false, - "display_on_load": false - }, - "create_topup": { - "title": "Create a top-up", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_topup", - "section_anchor": "topups", - "subsection_anchors": null, - "path": "/topups/create", - "gate": false, - "display_on_load": false - }, - "retrieve_topup": { - "title": "Retrieve a top-up", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_topup", - "section_anchor": "topups", - "subsection_anchors": null, - "path": "/topups/retrieve", - "gate": false, - "display_on_load": false - }, - "update_topup": { - "title": "Update a top-up", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "update_topup", - "section_anchor": "topups", - "subsection_anchors": null, - "path": "/topups/update", - "gate": false, - "display_on_load": false - }, - "list_topups": { - "title": "List all top-ups", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_topups", - "section_anchor": "topups", - "subsection_anchors": null, - "path": "/topups/list", - "gate": false, - "display_on_load": false - }, - "cancel_topup": { - "title": "Cancel a top-up", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "cancel_topup", - "section_anchor": "topups", - "subsection_anchors": null, - "path": "/topups/cancel", - "gate": false, - "display_on_load": false - }, - "transfers": { - "title": "Transfers", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "transfers", - "section_anchor": "transfers", - "subsection_anchors": [ - "transfer_object", - "create_transfer", - "retrieve_transfer", - "update_transfer", - "list_transfers" - ], - "path": "/transfers", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Transfers", - "description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](/docs/transfer-payout-split).\n\nRelated guide: [Creating Separate Charges and Transfers](/docs/connect/charges-transfers).\n", - "section_tag": "transfers", - "subsection_summaries": [ - { "anchor": "transfer_object", "curl_definition": null }, - { "anchor": "create_transfer", "curl_definition": "POST /v1/transfers" }, - { "anchor": "retrieve_transfer", "curl_definition": "GET /v1/transfers/:id" }, - { "anchor": "update_transfer", "curl_definition": "POST /v1/transfers/:id" }, - { "anchor": "list_transfers", "curl_definition": "GET /v1/transfers" } - ] - } - }, - "transfer_object": { - "title": "The transfer object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "transfer_object", - "section_anchor": "transfers", - "subsection_anchors": null, - "path": "/transfers/object", - "gate": false, - "display_on_load": false - }, - "create_transfer": { - "title": "Create a transfer", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_transfer", - "section_anchor": "transfers", - "subsection_anchors": null, - "path": "/transfers/create", - "gate": false, - "display_on_load": false - }, - "retrieve_transfer": { - "title": "Retrieve a transfer", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_transfer", - "section_anchor": "transfers", - "subsection_anchors": null, - "path": "/transfers/retrieve", - "gate": false, - "display_on_load": false - }, - "update_transfer": { - "title": "Update a transfer", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "update_transfer", - "section_anchor": "transfers", - "subsection_anchors": null, - "path": "/transfers/update", - "gate": false, - "display_on_load": false - }, - "list_transfers": { - "title": "List all transfers", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_transfers", - "section_anchor": "transfers", - "subsection_anchors": null, - "path": "/transfers/list", - "gate": false, - "display_on_load": false - }, - "transfer_reversals": { - "title": "Transfer Reversals", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "transfer_reversals", - "section_anchor": "transfer_reversals", - "subsection_anchors": [ - "transfer_reversal_object", - "create_transfer_reversal", - "retrieve_transfer_reversal", - "update_transfer_reversal", - "list_transfer_reversals" - ], - "path": "/transfer_reversals", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Transfer Reversals", - "description": "[Stripe Connect](/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](/docs/connect/charges-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing Transfers](/docs/connect/charges-transfers#reversing-transfers).\n", - "section_tag": "transfer_reversals", - "subsection_summaries": [ - { "anchor": "transfer_reversal_object", "curl_definition": null }, - { - "anchor": "create_transfer_reversal", - "curl_definition": "POST /v1/transfers/:id/reversals" - }, - { - "anchor": "retrieve_transfer_reversal", - "curl_definition": "GET /v1/transfers/:id/reversals/:id" - }, - { - "anchor": "update_transfer_reversal", - "curl_definition": "POST /v1/transfers/:id/reversals/:id" - }, - { - "anchor": "list_transfer_reversals", - "curl_definition": "GET /v1/transfers/:id/reversals" - } - ] - } - }, - "transfer_reversal_object": { - "title": "The transfer reversal object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "transfer_reversal_object", - "section_anchor": "transfer_reversals", - "subsection_anchors": null, - "path": "/transfer_reversals/object", - "gate": false, - "display_on_load": false - }, - "create_transfer_reversal": { - "title": "Create a transfer reversal", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "create_transfer_reversal", - "section_anchor": "transfer_reversals", - "subsection_anchors": null, - "path": "/transfer_reversals/create", - "gate": false, - "display_on_load": false - }, - "retrieve_transfer_reversal": { - "title": "Retrieve a reversal", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "retrieve_transfer_reversal", - "section_anchor": "transfer_reversals", - "subsection_anchors": null, - "path": "/transfer_reversals/retrieve", - "gate": false, - "display_on_load": false - }, - "update_transfer_reversal": { - "title": "Update a reversal", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "update_transfer_reversal", - "section_anchor": "transfer_reversals", - "subsection_anchors": null, - "path": "/transfer_reversals/update", - "gate": false, - "display_on_load": false - }, - "list_transfer_reversals": { - "title": "List all reversals", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_transfer_reversals", - "section_anchor": "transfer_reversals", - "subsection_anchors": null, - "path": "/transfer_reversals/list", - "gate": false, - "display_on_load": false - }, - "secret_management": { - "title": "Secret Management", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "secret_management", - "section_anchor": "secret_management", - "subsection_anchors": [ - "secret_object", - "set_secret", - "find_secret", - "delete_secret", - "list_secret" - ], - "path": "/secret_management", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Secrets", - "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](/docs/stripe-apps/store-auth-data-custom-objects).\n", - "section_tag": "secret_management", - "subsection_summaries": [ - { "anchor": "secret_object", "curl_definition": null }, - { "anchor": "set_secret", "curl_definition": "POST /v1/apps/secrets" }, - { "anchor": "find_secret", "curl_definition": "GET /v1/apps/secrets/find" }, - { "anchor": "delete_secret", "curl_definition": "POST /v1/apps/secrets/delete" }, - { "anchor": "list_secret", "curl_definition": "GET /v1/apps/secrets" } - ] - } - }, - "secret_object": { - "title": "The Secret object", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "secret_object", - "section_anchor": "secret_management", - "subsection_anchors": null, - "path": "/apps/secret_store/secret_resource", - "gate": false, - "display_on_load": false - }, - "set_secret": { - "title": "Set a secret", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "set_secret", - "section_anchor": "secret_management", - "subsection_anchors": null, - "path": "/apps/secret_store/set", - "gate": false, - "display_on_load": false - }, - "find_secret": { - "title": "Find a secret", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "find_secret", - "section_anchor": "secret_management", - "subsection_anchors": null, - "path": "/apps/secret_store/find", - "gate": false, - "display_on_load": false - }, - "delete_secret": { - "title": "Delete a secret", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "delete_secret", - "section_anchor": "secret_management", - "subsection_anchors": null, - "path": "/apps/secret_store/delete", - "gate": false, - "display_on_load": false - }, - "list_secret": { - "title": "List secrets", - "group_title": "Connect", - "group_anchor": "connect", - "anchor": "list_secret", - "section_anchor": "secret_management", - "subsection_anchors": null, - "path": "/apps/secret_store/list", - "gate": false, - "display_on_load": false - }, - "early_fraud_warnings": { - "title": "Early Fraud Warnings", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "early_fraud_warnings", - "section_anchor": "early_fraud_warnings", - "subsection_anchors": [ - "early_fraud_warning_object", - "retrieve_early_fraud_warning", - "list_early_fraud_warnings" - ], - "path": "/radar/early_fraud_warnings", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Early Fraud Warning", - "description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early Fraud Warnings](/docs/disputes/measuring#early-fraud-warnings).\n", - "section_tag": "early_fraud_warnings", - "subsection_summaries": [ - { "anchor": "early_fraud_warning_object", "curl_definition": null }, - { - "anchor": "retrieve_early_fraud_warning", - "curl_definition": "GET /v1/radar/early_fraud_warnings/:id" - }, - { - "anchor": "list_early_fraud_warnings", - "curl_definition": "GET /v1/radar/early_fraud_warnings" - } - ] - } - }, - "early_fraud_warning_object": { - "title": "The early fraud warning object", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "early_fraud_warning_object", - "section_anchor": "early_fraud_warnings", - "subsection_anchors": null, - "path": "/radar/early_fraud_warnings/object", - "gate": false, - "display_on_load": false - }, - "retrieve_early_fraud_warning": { - "title": "Retrieve an early fraud warning", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "retrieve_early_fraud_warning", - "section_anchor": "early_fraud_warnings", - "subsection_anchors": null, - "path": "/radar/early_fraud_warnings/retrieve", - "gate": false, - "display_on_load": false - }, - "list_early_fraud_warnings": { - "title": "List all early fraud warnings", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "list_early_fraud_warnings", - "section_anchor": "early_fraud_warnings", - "subsection_anchors": null, - "path": "/radar/early_fraud_warnings/list", - "gate": false, - "display_on_load": false - }, - "reviews": { - "title": "Reviews", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "reviews", - "section_anchor": "reviews", - "subsection_anchors": ["review_object", "approve_review", "retrieve_review", "list_reviews"], - "path": "/radar/reviews", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Reviews", - "description": "Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](/docs/radar/reviews).\n", - "section_tag": "reviews", - "subsection_summaries": [ - { "anchor": "review_object", "curl_definition": null }, - { "anchor": "approve_review", "curl_definition": "POST /v1/reviews/:id/approve" }, - { "anchor": "retrieve_review", "curl_definition": "GET /v1/reviews/:id" }, - { "anchor": "list_reviews", "curl_definition": "GET /v1/reviews" } - ] - } - }, - "review_object": { - "title": "The review object", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "review_object", - "section_anchor": "reviews", - "subsection_anchors": null, - "path": "/radar/reviews/object", - "gate": false, - "display_on_load": false - }, - "approve_review": { - "title": "Approve a review", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "approve_review", - "section_anchor": "reviews", - "subsection_anchors": null, - "path": "/radar/reviews/approve", - "gate": false, - "display_on_load": false - }, - "retrieve_review": { - "title": "Retrieve a review", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "retrieve_review", - "section_anchor": "reviews", - "subsection_anchors": null, - "path": "/radar/reviews/retrieve", - "gate": false, - "display_on_load": false - }, - "list_reviews": { - "title": "List all open reviews", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "list_reviews", - "section_anchor": "reviews", - "subsection_anchors": null, - "path": "/radar/reviews/list", - "gate": false, - "display_on_load": false - }, - "value_lists": { - "title": "Value Lists", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "value_lists", - "section_anchor": "value_lists", - "subsection_anchors": [ - "radar_value_list_object", - "create_value_list", - "retrieve_value_list", - "update_value_list", - "delete_value_list", - "list_value_lists" - ], - "path": "/radar/value_lists", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Value Lists", - "description": "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe Lists](/docs/radar/lists#managing-list-items).\n", - "section_tag": "value_lists", - "subsection_summaries": [ - { "anchor": "radar_value_list_object", "curl_definition": null }, - { "anchor": "create_value_list", "curl_definition": "POST /v1/radar/value_lists" }, - { "anchor": "retrieve_value_list", "curl_definition": "GET /v1/radar/value_lists/:id" }, - { "anchor": "update_value_list", "curl_definition": "POST /v1/radar/value_lists/:id" }, - { "anchor": "delete_value_list", "curl_definition": "DELETE /v1/radar/value_lists/:id" }, - { "anchor": "list_value_lists", "curl_definition": "GET /v1/radar/value_lists" } - ] - } - }, - "radar_value_list_object": { - "title": "The value list object", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "radar_value_list_object", - "section_anchor": "value_lists", - "subsection_anchors": null, - "path": "/radar/value_lists/object", - "gate": false, - "display_on_load": false - }, - "create_value_list": { - "title": "Create a value list", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "create_value_list", - "section_anchor": "value_lists", - "subsection_anchors": null, - "path": "/radar/value_lists/create", - "gate": false, - "display_on_load": false - }, - "retrieve_value_list": { - "title": "Retrieve a value list", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "retrieve_value_list", - "section_anchor": "value_lists", - "subsection_anchors": null, - "path": "/radar/value_lists/retrieve", - "gate": false, - "display_on_load": false - }, - "update_value_list": { - "title": "Update a value list", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "update_value_list", - "section_anchor": "value_lists", - "subsection_anchors": null, - "path": "/radar/value_lists/update", - "gate": false, - "display_on_load": false - }, - "delete_value_list": { - "title": "Delete a value list", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "delete_value_list", - "section_anchor": "value_lists", - "subsection_anchors": null, - "path": "/radar/value_lists/delete", - "gate": false, - "display_on_load": false - }, - "list_value_lists": { - "title": "List all value lists", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "list_value_lists", - "section_anchor": "value_lists", - "subsection_anchors": null, - "path": "/radar/value_lists/list", - "gate": false, - "display_on_load": false - }, - "value_list_items": { - "title": "Value List Items", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "value_list_items", - "section_anchor": "value_list_items", - "subsection_anchors": [ - "radar_value_list_item_object", - "create_value_list_item", - "retrieve_value_list_item", - "delete_value_list_item", - "list_value_list_items" - ], - "path": "/radar/value_list_items", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Value List Items", - "description": "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing List Items](/docs/radar/lists#managing-list-items).\n", - "section_tag": "value_list_items", - "subsection_summaries": [ - { "anchor": "radar_value_list_item_object", "curl_definition": null }, - { - "anchor": "create_value_list_item", - "curl_definition": "POST /v1/radar/value_list_items" - }, - { - "anchor": "retrieve_value_list_item", - "curl_definition": "GET /v1/radar/value_list_items/:id" - }, - { - "anchor": "delete_value_list_item", - "curl_definition": "DELETE /v1/radar/value_list_items/:id" - }, - { "anchor": "list_value_list_items", "curl_definition": "GET /v1/radar/value_list_items" } - ] - } - }, - "radar_value_list_item_object": { - "title": "The value list item object", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "radar_value_list_item_object", - "section_anchor": "value_list_items", - "subsection_anchors": null, - "path": "/radar/value_list_items/object", - "gate": false, - "display_on_load": false - }, - "create_value_list_item": { - "title": "Create a value list item", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "create_value_list_item", - "section_anchor": "value_list_items", - "subsection_anchors": null, - "path": "/radar/value_list_items/create", - "gate": false, - "display_on_load": false - }, - "retrieve_value_list_item": { - "title": "Retrieve a value list item", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "retrieve_value_list_item", - "section_anchor": "value_list_items", - "subsection_anchors": null, - "path": "/radar/value_list_items/retrieve", - "gate": false, - "display_on_load": false - }, - "delete_value_list_item": { - "title": "Delete a value list item", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "delete_value_list_item", - "section_anchor": "value_list_items", - "subsection_anchors": null, - "path": "/radar/value_list_items/delete", - "gate": false, - "display_on_load": false - }, - "list_value_list_items": { - "title": "List all value list items", - "group_title": "Fraud", - "group_anchor": "fraud", - "anchor": "list_value_list_items", - "section_anchor": "value_list_items", - "subsection_anchors": null, - "path": "/radar/value_list_items/list", - "gate": false, - "display_on_load": false - }, - "issuing_authorizations": { - "title": "Authorizations", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_authorizations", - "section_anchor": "issuing_authorizations", - "subsection_anchors": [ - "issuing_authorization_object", - "retrieve_issuing_authorization", - "update_issuing_authorization", - "approve_issuing_authorization", - "decline_issuing_authorization", - "list_issuing_authorizations" - ], - "path": "/issuing/authorizations", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Authorizations", - "description": "When an [issued card](/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued Card Authorizations](/docs/issuing/purchases/authorizations).\n", - "section_tag": "issuing_authorizations", - "subsection_summaries": [ - { "anchor": "issuing_authorization_object", "curl_definition": null }, - { - "anchor": "retrieve_issuing_authorization", - "curl_definition": "GET /v1/issuing/authorizations/:id" - }, - { - "anchor": "update_issuing_authorization", - "curl_definition": "POST /v1/issuing/authorizations/:id" - }, - { - "anchor": "approve_issuing_authorization", - "curl_definition": "POST /v1/issuing/authorizations/:id/approve" - }, - { - "anchor": "decline_issuing_authorization", - "curl_definition": "POST /v1/issuing/authorizations/:id/decline" - }, - { - "anchor": "list_issuing_authorizations", - "curl_definition": "GET /v1/issuing/authorizations" - } - ] - } - }, - "issuing_authorization_object": { - "title": "The Authorization object", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_authorization_object", - "section_anchor": "issuing_authorizations", - "subsection_anchors": null, - "path": "/issuing/authorizations/object", - "gate": false, - "display_on_load": false - }, - "retrieve_issuing_authorization": { - "title": "Retrieve an authorization", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "retrieve_issuing_authorization", - "section_anchor": "issuing_authorizations", - "subsection_anchors": null, - "path": "/issuing/authorizations/retrieve", - "gate": false, - "display_on_load": false - }, - "update_issuing_authorization": { - "title": "Update an authorization", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "update_issuing_authorization", - "section_anchor": "issuing_authorizations", - "subsection_anchors": null, - "path": "/issuing/authorizations/update", - "gate": false, - "display_on_load": false - }, - "approve_issuing_authorization": { - "title": "Approve an authorization", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "approve_issuing_authorization", - "section_anchor": "issuing_authorizations", - "subsection_anchors": null, - "path": "/issuing/authorizations/approve", - "gate": false, - "display_on_load": false - }, - "decline_issuing_authorization": { - "title": "Decline an authorization", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "decline_issuing_authorization", - "section_anchor": "issuing_authorizations", - "subsection_anchors": null, - "path": "/issuing/authorizations/decline", - "gate": false, - "display_on_load": false - }, - "list_issuing_authorizations": { - "title": "List all authorizations", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "list_issuing_authorizations", - "section_anchor": "issuing_authorizations", - "subsection_anchors": null, - "path": "/issuing/authorizations/list", - "gate": false, - "display_on_load": false - }, - "issuing_cardholders": { - "title": "Cardholders", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_cardholders", - "section_anchor": "issuing_cardholders", - "subsection_anchors": [ - "issuing_cardholder_object", - "create_issuing_cardholder", - "retrieve_issuing_cardholder", - "update_issuing_cardholder", - "list_issuing_cardholders" - ], - "path": "/issuing/cardholders", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Cardholders", - "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](/docs/issuing) cards.\n\nRelated guide: [How to create a Cardholder](/docs/issuing/cards#create-cardholder)\n", - "section_tag": "issuing_cardholders", - "subsection_summaries": [ - { "anchor": "issuing_cardholder_object", "curl_definition": null }, - { - "anchor": "create_issuing_cardholder", - "curl_definition": "POST /v1/issuing/cardholders" - }, - { - "anchor": "retrieve_issuing_cardholder", - "curl_definition": "GET /v1/issuing/cardholders/:id" - }, - { - "anchor": "update_issuing_cardholder", - "curl_definition": "POST /v1/issuing/cardholders/:id" - }, - { "anchor": "list_issuing_cardholders", "curl_definition": "GET /v1/issuing/cardholders" } - ] - } - }, - "issuing_cardholder_object": { - "title": "The Cardholder object", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_cardholder_object", - "section_anchor": "issuing_cardholders", - "subsection_anchors": null, - "path": "/issuing/cardholders/object", - "gate": false, - "display_on_load": false - }, - "create_issuing_cardholder": { - "title": "Create a cardholder", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "create_issuing_cardholder", - "section_anchor": "issuing_cardholders", - "subsection_anchors": null, - "path": "/issuing/cardholders/create", - "gate": false, - "display_on_load": false - }, - "retrieve_issuing_cardholder": { - "title": "Retrieve a cardholder", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "retrieve_issuing_cardholder", - "section_anchor": "issuing_cardholders", - "subsection_anchors": null, - "path": "/issuing/cardholders/retrieve", - "gate": false, - "display_on_load": false - }, - "update_issuing_cardholder": { - "title": "Update a cardholder", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "update_issuing_cardholder", - "section_anchor": "issuing_cardholders", - "subsection_anchors": null, - "path": "/issuing/cardholders/update", - "gate": false, - "display_on_load": false - }, - "list_issuing_cardholders": { - "title": "List all cardholders", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "list_issuing_cardholders", - "section_anchor": "issuing_cardholders", - "subsection_anchors": null, - "path": "/issuing/cardholders/list", - "gate": false, - "display_on_load": false - }, - "issuing_cards": { - "title": "Cards", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_cards", - "section_anchor": "issuing_cards", - "subsection_anchors": [ - "issuing_card_object", - "create_issuing_card", - "retrieve_issuing_card", - "update_issuing_card", - "list_issuing_cards", - "test_mode_ship_physical_card", - "test_mode_deliver_physical_card", - "test_mode_return_physical_card", - "test_mode_fail_physical_card" - ], - "path": "/issuing/cards", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Cards", - "description": "You can [create physical or virtual cards](/docs/issuing/cards) that are issued to cardholders.", - "section_tag": "issuing_cards", - "subsection_summaries": [ - { "anchor": "issuing_card_object", "curl_definition": null }, - { "anchor": "create_issuing_card", "curl_definition": "POST /v1/issuing/cards" }, - { "anchor": "retrieve_issuing_card", "curl_definition": "GET /v1/issuing/cards/:id" }, - { "anchor": "update_issuing_card", "curl_definition": "POST /v1/issuing/cards/:id" }, - { "anchor": "list_issuing_cards", "curl_definition": "GET /v1/issuing/cards" }, - { - "anchor": "test_mode_ship_physical_card", - "curl_definition": "POST /v1/test_helpers/issuing/cards/{:card}/shipping/ship" - }, - { - "anchor": "test_mode_deliver_physical_card", - "curl_definition": "POST /v1/test_helpers/issuing/cards/{:card}/shipping/deliver" - }, - { - "anchor": "test_mode_return_physical_card", - "curl_definition": "POST /v1/test_helpers/issuing/cards/{:card}/shipping/return" - }, - { - "anchor": "test_mode_fail_physical_card", - "curl_definition": "POST /v1/test_helpers/issuing/cards/{:card}/shipping/fail" - } - ] - } - }, - "issuing_card_object": { - "title": "The Card object", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_card_object", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/object", - "gate": false, - "display_on_load": false - }, - "create_issuing_card": { - "title": "Create a card", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "create_issuing_card", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/create", - "gate": false, - "display_on_load": false - }, - "retrieve_issuing_card": { - "title": "Retrieve a card", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "retrieve_issuing_card", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/retrieve", - "gate": false, - "display_on_load": false - }, - "update_issuing_card": { - "title": "Update a card", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "update_issuing_card", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/update", - "gate": false, - "display_on_load": false - }, - "list_issuing_cards": { - "title": "List all cards", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "list_issuing_cards", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/list", - "gate": false, - "display_on_load": false - }, - "test_mode_ship_physical_card": { - "title": "Ship a testmode card", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "test_mode_ship_physical_card", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/test_mode_ship", - "gate": false, - "display_on_load": false - }, - "test_mode_deliver_physical_card": { - "title": "Deliver a testmode card", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "test_mode_deliver_physical_card", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/test_mode_deliver", - "gate": false, - "display_on_load": false - }, - "test_mode_return_physical_card": { - "title": "Return a testmode card", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "test_mode_return_physical_card", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/test_mode_return", - "gate": false, - "display_on_load": false - }, - "test_mode_fail_physical_card": { - "title": "Fail a testmode card", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "test_mode_fail_physical_card", - "section_anchor": "issuing_cards", - "subsection_anchors": null, - "path": "/issuing/cards/test_mode_fail", - "gate": false, - "display_on_load": false - }, - "issuing_disputes": { - "title": "Disputes", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_disputes", - "section_anchor": "issuing_disputes", - "subsection_anchors": [ - "issuing_dispute_object", - "create_issuing_dispute", - "submit_issuing_dispute", - "retrieve_issuing_dispute", - "update_issuing_dispute", - "list_issuing_disputes" - ], - "path": "/issuing/disputes", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Disputes", - "description": "As a [card issuer](/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Disputing Transactions](/docs/issuing/purchases/disputes)\n", - "section_tag": "issuing_disputes", - "subsection_summaries": [ - { "anchor": "issuing_dispute_object", "curl_definition": null }, - { "anchor": "create_issuing_dispute", "curl_definition": "POST /v1/issuing/disputes" }, - { - "anchor": "submit_issuing_dispute", - "curl_definition": "POST /v1/issuing/disputes/:id/submit" - }, - { "anchor": "retrieve_issuing_dispute", "curl_definition": "GET /v1/issuing/disputes/:id" }, - { "anchor": "update_issuing_dispute", "curl_definition": "POST /v1/issuing/disputes/:id" }, - { "anchor": "list_issuing_disputes", "curl_definition": "GET /v1/issuing/disputes" } - ] - } - }, - "issuing_dispute_object": { - "title": "The Dispute object", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_dispute_object", - "section_anchor": "issuing_disputes", - "subsection_anchors": null, - "path": "/issuing/disputes/object", - "gate": false, - "display_on_load": false - }, - "create_issuing_dispute": { - "title": "Create a dispute", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "create_issuing_dispute", - "section_anchor": "issuing_disputes", - "subsection_anchors": null, - "path": "/issuing/disputes/create", - "gate": false, - "display_on_load": false - }, - "submit_issuing_dispute": { - "title": "Submit a dispute", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "submit_issuing_dispute", - "section_anchor": "issuing_disputes", - "subsection_anchors": null, - "path": "/issuing/dispute/submit", - "gate": false, - "display_on_load": false - }, - "retrieve_issuing_dispute": { - "title": "Retrieve a dispute", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "retrieve_issuing_dispute", - "section_anchor": "issuing_disputes", - "subsection_anchors": null, - "path": "/issuing/disputes/retrieve", - "gate": false, - "display_on_load": false - }, - "update_issuing_dispute": { - "title": "Update a dispute", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "update_issuing_dispute", - "section_anchor": "issuing_disputes", - "subsection_anchors": null, - "path": "/issuing/disputes/update", - "gate": false, - "display_on_load": false - }, - "list_issuing_disputes": { - "title": "List all disputes", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "list_issuing_disputes", - "section_anchor": "issuing_disputes", - "subsection_anchors": null, - "path": "/issuing/disputes/list", - "gate": false, - "display_on_load": false - }, - "issuing_funding_instructions": { - "title": "Funding Instructions", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_funding_instructions", - "section_anchor": "issuing_funding_instructions", - "subsection_anchors": [ - "issuing_funding_instructions_object", - "create_issuing_funding_instructions", - "list_issuing_funding_instructions", - "fund_issuing_funding_instruction" - ], - "path": "/issuing/funding_instructions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Funding Instructions", - "description": "Funding Instructions contain reusable bank account and routing information. Push funds\nto these addresses via bank transfer to [top up Issuing Balances](/docs/issuing/funding/balance).\n", - "section_tag": "issuing_funding_instructions", - "subsection_summaries": [ - { "anchor": "issuing_funding_instructions_object", "curl_definition": null }, - { - "anchor": "create_issuing_funding_instructions", - "curl_definition": "POST /v1/issuing/funding_instructions" - }, - { - "anchor": "list_issuing_funding_instructions", - "curl_definition": "GET /v1/issuing/funding_instructions" - }, - { - "anchor": "fund_issuing_funding_instruction", - "curl_definition": "POST /v1/test_helpers/issuing/fund_balance" - } - ] - } - }, - "issuing_funding_instructions_object": { - "title": "The FundingInstruction object", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_funding_instructions_object", - "section_anchor": "issuing_funding_instructions", - "subsection_anchors": null, - "path": "/issuing/funding_instructions/object", - "gate": false, - "display_on_load": false - }, - "create_issuing_funding_instructions": { - "title": "Create funding instructions", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "create_issuing_funding_instructions", - "section_anchor": "issuing_funding_instructions", - "subsection_anchors": null, - "path": "/issuing/funding_instructions/create", - "gate": false, - "display_on_load": false - }, - "list_issuing_funding_instructions": { - "title": "List all funding instructions", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "list_issuing_funding_instructions", - "section_anchor": "issuing_funding_instructions", - "subsection_anchors": null, - "path": "/issuing/funding_instructions/list", - "gate": false, - "display_on_load": false - }, - "fund_issuing_funding_instruction": { - "title": "Simulate a top up", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "fund_issuing_funding_instruction", - "section_anchor": "issuing_funding_instructions", - "subsection_anchors": null, - "path": "/issuing/funding_instructions/fund", - "gate": false, - "display_on_load": false - }, - "issuing_transactions": { - "title": "Transactions", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_transactions", - "section_anchor": "issuing_transactions", - "subsection_anchors": [ - "issuing_transaction_object", - "retrieve_issuing_transaction", - "update_issuing_transaction", - "list_issuing_transactions" - ], - "path": "/issuing/transactions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Transactions", - "description": "Any use of an [issued card](/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued Card Transactions](/docs/issuing/purchases/transactions).\n", - "section_tag": "issuing_transactions", - "subsection_summaries": [ - { "anchor": "issuing_transaction_object", "curl_definition": null }, - { - "anchor": "retrieve_issuing_transaction", - "curl_definition": "GET /v1/issuing/transactions/:id" - }, - { - "anchor": "update_issuing_transaction", - "curl_definition": "POST /v1/issuing/transactions/:id" - }, - { "anchor": "list_issuing_transactions", "curl_definition": "GET /v1/issuing/transactions" } - ] - } - }, - "issuing_transaction_object": { - "title": "The Transaction object", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "issuing_transaction_object", - "section_anchor": "issuing_transactions", - "subsection_anchors": null, - "path": "/issuing/transactions/object", - "gate": false, - "display_on_load": false - }, - "retrieve_issuing_transaction": { - "title": "Retrieve a transaction", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "retrieve_issuing_transaction", - "section_anchor": "issuing_transactions", - "subsection_anchors": null, - "path": "/issuing/transactions/retrieve", - "gate": false, - "display_on_load": false - }, - "update_issuing_transaction": { - "title": "Update a transaction", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "update_issuing_transaction", - "section_anchor": "issuing_transactions", - "subsection_anchors": null, - "path": "/issuing/transactions/update", - "gate": false, - "display_on_load": false - }, - "list_issuing_transactions": { - "title": "List all transactions", - "group_title": "Issuing", - "group_anchor": "issuing", - "anchor": "list_issuing_transactions", - "section_anchor": "issuing_transactions", - "subsection_anchors": null, - "path": "/issuing/transactions/list", - "gate": false, - "display_on_load": false - }, - "terminal_connection_tokens": { - "title": "Connection Tokens", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_connection_tokens", - "section_anchor": "terminal_connection_tokens", - "subsection_anchors": ["terminal_connection_token_object", "create_terminal_connection_token"], - "path": "/terminal/connection_tokens", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Connection Token", - "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet Management](/docs/terminal/fleet/locations).\n", - "section_tag": "terminal_connection_tokens", - "subsection_summaries": [ - { "anchor": "terminal_connection_token_object", "curl_definition": null }, - { - "anchor": "create_terminal_connection_token", - "curl_definition": "POST /v1/terminal/connection_tokens" - } - ] - } - }, - "terminal_connection_token_object": { - "title": "The connection token object", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_connection_token_object", - "section_anchor": "terminal_connection_tokens", - "subsection_anchors": null, - "path": "/terminal/connection_tokens/object", - "gate": false, - "display_on_load": false - }, - "create_terminal_connection_token": { - "title": "Create a Connection Token", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "create_terminal_connection_token", - "section_anchor": "terminal_connection_tokens", - "subsection_anchors": null, - "path": "/terminal/connection_tokens/create", - "gate": false, - "display_on_load": false - }, - "terminal_locations": { - "title": "Locations", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_locations", - "section_anchor": "terminal_locations", - "subsection_anchors": [ - "terminal_location_object", - "create_terminal_location", - "retrieve_terminal_location", - "update_terminal_location", - "delete_terminal_location", - "list_terminal_locations" - ], - "path": "/terminal/locations", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Location", - "description": "A Location represents a grouping of readers.\n\nRelated guide: [Fleet Management](/docs/terminal/fleet/locations).\n", - "section_tag": "terminal_locations", - "subsection_summaries": [ - { "anchor": "terminal_location_object", "curl_definition": null }, - { "anchor": "create_terminal_location", "curl_definition": "POST /v1/terminal/locations" }, - { - "anchor": "retrieve_terminal_location", - "curl_definition": "GET /v1/terminal/locations/:id" - }, - { - "anchor": "update_terminal_location", - "curl_definition": "POST /v1/terminal/locations/:id" - }, - { - "anchor": "delete_terminal_location", - "curl_definition": "DELETE /v1/terminal/locations/:id" - }, - { "anchor": "list_terminal_locations", "curl_definition": "GET /v1/terminal/locations" } - ] - } - }, - "terminal_location_object": { - "title": "The location object", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_location_object", - "section_anchor": "terminal_locations", - "subsection_anchors": null, - "path": "/terminal/locations/object", - "gate": false, - "display_on_load": false - }, - "create_terminal_location": { - "title": "Create a Location", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "create_terminal_location", - "section_anchor": "terminal_locations", - "subsection_anchors": null, - "path": "/terminal/locations/create", - "gate": false, - "display_on_load": false - }, - "retrieve_terminal_location": { - "title": "Retrieve a Location", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "retrieve_terminal_location", - "section_anchor": "terminal_locations", - "subsection_anchors": null, - "path": "/terminal/locations/retrieve", - "gate": false, - "display_on_load": false - }, - "update_terminal_location": { - "title": "Update a Location", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "update_terminal_location", - "section_anchor": "terminal_locations", - "subsection_anchors": null, - "path": "/terminal/locations/update", - "gate": false, - "display_on_load": false - }, - "delete_terminal_location": { - "title": "Delete a Location", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "delete_terminal_location", - "section_anchor": "terminal_locations", - "subsection_anchors": null, - "path": "/terminal/locations/delete", - "gate": false, - "display_on_load": false - }, - "list_terminal_locations": { - "title": "List all Locations", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "list_terminal_locations", - "section_anchor": "terminal_locations", - "subsection_anchors": null, - "path": "/terminal/locations/list", - "gate": false, - "display_on_load": false - }, - "terminal_readers": { - "title": "Readers", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_readers", - "section_anchor": "terminal_readers", - "subsection_anchors": [ - "terminal_reader_object", - "create_terminal_reader", - "retrieve_terminal_reader", - "update_terminal_reader", - "delete_terminal_reader", - "list_terminal_reader", - "process_payment_intent", - "process_setup_intent", - "set_reader_display", - "cancel_action", - "present_payment_method" - ], - "path": "/terminal/readers", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Reader", - "description": "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a Reader](/docs/terminal/payments/connect-reader).\n", - "section_tag": "terminal_readers", - "subsection_summaries": [ - { "anchor": "terminal_reader_object", "curl_definition": null }, - { "anchor": "create_terminal_reader", "curl_definition": "POST /v1/terminal/readers" }, - { "anchor": "retrieve_terminal_reader", "curl_definition": "GET /v1/terminal/readers/:id" }, - { "anchor": "update_terminal_reader", "curl_definition": "POST /v1/terminal/readers/:id" }, - { - "anchor": "delete_terminal_reader", - "curl_definition": "DELETE /v1/terminal/readers/:id" - }, - { "anchor": "list_terminal_reader", "curl_definition": "GET /v1/terminal/readers" }, - { - "anchor": "process_payment_intent", - "curl_definition": "POST /v1/terminal/readers/:id/process_payment_intent" - }, - { - "anchor": "process_setup_intent", - "curl_definition": "POST /v1/terminal/readers/:id/process_setup_intent" - }, - { - "anchor": "set_reader_display", - "curl_definition": "POST /v1/terminal/readers/:id/set_reader_display" - }, - { - "anchor": "cancel_action", - "curl_definition": "POST /v1/terminal/readers/:id/cancel_action" - }, - { - "anchor": "present_payment_method", - "curl_definition": "POST /v1/test_helpers/terminal/readers/:id/present_payment_method" - } - ] - } - }, - "terminal_reader_object": { - "title": "The reader object", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_reader_object", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/object", - "gate": false, - "display_on_load": false - }, - "create_terminal_reader": { - "title": "Create a Reader", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "create_terminal_reader", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/create", - "gate": false, - "display_on_load": false - }, - "retrieve_terminal_reader": { - "title": "Retrieve a Reader", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "retrieve_terminal_reader", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/retrieve", - "gate": false, - "display_on_load": false - }, - "update_terminal_reader": { - "title": "Update a Reader", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "update_terminal_reader", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/update", - "gate": false, - "display_on_load": false - }, - "delete_terminal_reader": { - "title": "Delete a Reader", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "delete_terminal_reader", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/delete", - "gate": false, - "display_on_load": false - }, - "list_terminal_reader": { - "title": "List all Readers", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "list_terminal_reader", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/list", - "gate": false, - "display_on_load": false - }, - "process_payment_intent": { - "title": "Hand-off a PaymentIntent to a Reader", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "process_payment_intent", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/process_payment_intent", - "gate": false, - "display_on_load": false - }, - "process_setup_intent": { - "title": "Hand-off a SetupIntent to a Reader", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "process_setup_intent", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/process_setup_intent", - "gate": false, - "display_on_load": false - }, - "set_reader_display": { - "title": "Set reader display", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "set_reader_display", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/set_reader_display", - "gate": false, - "display_on_load": false - }, - "cancel_action": { - "title": "Cancel the current reader action", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "cancel_action", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/cancel_action", - "gate": false, - "display_on_load": false - }, - "present_payment_method": { - "title": "Simulate presenting a payment method", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "present_payment_method", - "section_anchor": "terminal_readers", - "subsection_anchors": null, - "path": "/terminal/readers/present_payment_method", - "gate": false, - "display_on_load": false - }, - "terminal_hardware_products": { - "title": "Hardware Products", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_hardware_products", - "section_anchor": "terminal_hardware_products", - "subsection_anchors": [ - "terminal_hardware_product_object", - "retrieve_terminal_hardware_product", - "list_terminal_hardware_product" - ], - "path": "/terminal/hardware_products", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "TerminalHardwareProduct", - "description": "A TerminalHardwareProduct is a category of hardware devices that are generally similar, but may have variations depending on the country it’s shipped to.\n\nTerminalHardwareSKUs represent variations within the same Product (for example, a country specific device). For example, WisePOS E is a TerminalHardwareProduct and a WisePOS E - US and WisePOS E - UK are TerminalHardwareSKUs.\n", - "section_tag": "terminal_hardware_products", - "subsection_summaries": [ - { "anchor": "terminal_hardware_product_object", "curl_definition": null }, - { - "anchor": "retrieve_terminal_hardware_product", - "curl_definition": "GET /v1/terminal/hardware_products/:id" - }, - { - "anchor": "list_terminal_hardware_product", - "curl_definition": "GET /v1/terminal/hardware_products" - } - ] - } - }, - "terminal_hardware_product_object": { - "title": "The Terminal Hardware Product object", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_hardware_product_object", - "section_anchor": "terminal_hardware_products", - "subsection_anchors": null, - "path": "/terminal/hardware_products/object", - "gate": false, - "display_on_load": false - }, - "retrieve_terminal_hardware_product": { - "title": "Retrieve a Terminal Hardware Product", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "retrieve_terminal_hardware_product", - "section_anchor": "terminal_hardware_products", - "subsection_anchors": null, - "path": "/terminal/hardware_products/retrieve", - "gate": false, - "display_on_load": false - }, - "list_terminal_hardware_product": { - "title": "List all Terminal Hardware Products", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "list_terminal_hardware_product", - "section_anchor": "terminal_hardware_products", - "subsection_anchors": null, - "path": "/terminal/hardware_products/list", - "gate": false, - "display_on_load": false - }, - "terminal_hardware_shipping_methods": { - "title": "Hardware Shipping Methods", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_hardware_shipping_methods", - "section_anchor": "terminal_hardware_shipping_methods", - "subsection_anchors": [ - "terminal_hardware_shipping_method_object", - "retrieve_terminal_hardware_shipping_method", - "list_terminal_hardware_shipping_method" - ], - "path": "/terminal/hardware_shipping_methods", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "TerminalHardwareShippingMethod", - "description": "A TerminalHardwareShipping represents a Shipping Method for Terminal hardware. A Shipping Method is a country-specific representation of a way to ship hardware, containing information such as the country, name, and expected delivery date.\n", - "section_tag": "terminal_hardware_shipping_methods", - "subsection_summaries": [ - { "anchor": "terminal_hardware_shipping_method_object", "curl_definition": null }, - { - "anchor": "retrieve_terminal_hardware_shipping_method", - "curl_definition": "GET /v1/terminal/hardware_shipping_methods/:id" - }, - { - "anchor": "list_terminal_hardware_shipping_method", - "curl_definition": "GET /v1/terminal/hardware_shipping_methods" - } - ] - } - }, - "terminal_hardware_shipping_method_object": { - "title": "The Terminal Hardware Shipping Method object", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_hardware_shipping_method_object", - "section_anchor": "terminal_hardware_shipping_methods", - "subsection_anchors": null, - "path": "/terminal/hardware_shipping_methods/object", - "gate": false, - "display_on_load": false - }, - "retrieve_terminal_hardware_shipping_method": { - "title": "Retrieve a Terminal Hardware Shipping Method", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "retrieve_terminal_hardware_shipping_method", - "section_anchor": "terminal_hardware_shipping_methods", - "subsection_anchors": null, - "path": "/terminal/hardware_shipping_methods/retrieve", - "gate": false, - "display_on_load": false - }, - "list_terminal_hardware_shipping_method": { - "title": "List all Terminal Hardware Shipping Methods", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "list_terminal_hardware_shipping_method", - "section_anchor": "terminal_hardware_shipping_methods", - "subsection_anchors": null, - "path": "/terminal/hardware_shipping_methods/list", - "gate": false, - "display_on_load": false - }, - "terminal_configuration": { - "title": "Configurations", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_configuration", - "section_anchor": "terminal_configuration", - "subsection_anchors": [ - "terminal_configuration_object", - "create_configuration", - "retrieve_configuration", - "update_configuration", - "delete_configuration", - "list_configuration" - ], - "path": "/terminal/configuration", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Configuration", - "description": "A Configurations object represents how features should be configured for terminal readers.\n", - "section_tag": "terminal_configuration", - "subsection_summaries": [ - { "anchor": "terminal_configuration_object", "curl_definition": null }, - { "anchor": "create_configuration", "curl_definition": "POST /v1/terminal/configurations" }, - { - "anchor": "retrieve_configuration", - "curl_definition": "GET /v1/terminal/configurations/:id" - }, - { - "anchor": "update_configuration", - "curl_definition": "POST /v1/terminal/configurations/:id" - }, - { - "anchor": "delete_configuration", - "curl_definition": "DELETE /v1/terminal/configurations/:id" - }, - { "anchor": "list_configuration", "curl_definition": "GET /v1/terminal/configurations" } - ] - } - }, - "terminal_configuration_object": { - "title": "The Configuration object", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "terminal_configuration_object", - "section_anchor": "terminal_configuration", - "subsection_anchors": null, - "path": "/terminal/configuration/object", - "gate": false, - "display_on_load": false - }, - "create_configuration": { - "title": "Create a Configuration", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "create_configuration", - "section_anchor": "terminal_configuration", - "subsection_anchors": null, - "path": "/terminal/configuration/create", - "gate": false, - "display_on_load": false - }, - "retrieve_configuration": { - "title": "Retrieve a Configuration", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "retrieve_configuration", - "section_anchor": "terminal_configuration", - "subsection_anchors": null, - "path": "/terminal/configuration/retrieve", - "gate": false, - "display_on_load": false - }, - "update_configuration": { - "title": "Update a Configuration", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "update_configuration", - "section_anchor": "terminal_configuration", - "subsection_anchors": null, - "path": "/terminal/configuration/update", - "gate": false, - "display_on_load": false - }, - "delete_configuration": { - "title": "Delete a Configuration", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "delete_configuration", - "section_anchor": "terminal_configuration", - "subsection_anchors": null, - "path": "/terminal/configuration/delete", - "gate": false, - "display_on_load": false - }, - "list_configuration": { - "title": "List all Configurations", - "group_title": "Terminal", - "group_anchor": "terminal", - "anchor": "list_configuration", - "section_anchor": "terminal_configuration", - "subsection_anchors": null, - "path": "/terminal/configuration/list", - "gate": false, - "display_on_load": false - }, - "financial_accounts": { - "title": "FinancialAccounts", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "financial_accounts", - "section_anchor": "financial_accounts", - "subsection_anchors": [ - "financial_account_object", - "create_financial_account", - "update_financial_account", - "retrieve_financial_account", - "list_financial_account" - ], - "path": "/treasury/financial_accounts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "FinancialAccounts", - "description": "Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs.\n", - "section_tag": "financial_accounts", - "subsection_summaries": [ - { "anchor": "financial_account_object", "curl_definition": null }, - { - "anchor": "create_financial_account", - "curl_definition": "POST /v1/treasury/financial_accounts" - }, - { - "anchor": "update_financial_account", - "curl_definition": "POST /v1/treasury/financial_accounts/:id" - }, - { - "anchor": "retrieve_financial_account", - "curl_definition": "GET /v1/treasury/financial_accounts/:id" - }, - { - "anchor": "list_financial_account", - "curl_definition": "GET /v1/treasury/financial_accounts" - } - ] - } - }, - "financial_account_object": { - "title": "The FinancialAccount object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "financial_account_object", - "section_anchor": "financial_accounts", - "subsection_anchors": null, - "path": "/treasury/financial_accounts/object", - "gate": false, - "display_on_load": false - }, - "create_financial_account": { - "title": "Create a FinancialAccount", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "create_financial_account", - "section_anchor": "financial_accounts", - "subsection_anchors": null, - "path": "/treasury/financial_accounts/create", - "gate": false, - "display_on_load": false - }, - "update_financial_account": { - "title": "Update a FinancialAccount", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "update_financial_account", - "section_anchor": "financial_accounts", - "subsection_anchors": null, - "path": "/treasury/financial_accounts/update", - "gate": false, - "display_on_load": false - }, - "retrieve_financial_account": { - "title": "Retrieve a FinancialAccount", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_financial_account", - "section_anchor": "financial_accounts", - "subsection_anchors": null, - "path": "/treasury/financial_accounts/retrieve", - "gate": false, - "display_on_load": false - }, - "list_financial_account": { - "title": "List all FinancialAccounts", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_financial_account", - "section_anchor": "financial_accounts", - "subsection_anchors": null, - "path": "/treasury/financial_accounts/list", - "gate": false, - "display_on_load": false - }, - "financial_account_features": { - "title": "FinancialAccount Features", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "financial_account_features", - "section_anchor": "financial_account_features", - "subsection_anchors": [ - "financial_account_features_object", - "update_financial_acccount_features", - "retrieve_financial_account_features" - ], - "path": "/treasury/financial_account_features", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "FinancialAccount Features", - "description": "Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field.\n", - "section_tag": "financial_account_features", - "subsection_summaries": [ - { "anchor": "financial_account_features_object", "curl_definition": null }, - { - "anchor": "update_financial_acccount_features", - "curl_definition": "POST /v1/treasury/financial_accounts/:id/features" - }, - { - "anchor": "retrieve_financial_account_features", - "curl_definition": "GET /v1/treasury/financial_accounts/:id/features" - } - ] - } - }, - "financial_account_features_object": { - "title": "The FinancialAccount Feature object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "financial_account_features_object", - "section_anchor": "financial_account_features", - "subsection_anchors": null, - "path": "/treasury/financial_account_features/object", - "gate": false, - "display_on_load": false - }, - "update_financial_acccount_features": { - "title": "Update FinancialAccount Features", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "update_financial_acccount_features", - "section_anchor": "financial_account_features", - "subsection_anchors": null, - "path": "/treasury/financial_account_features/update", - "gate": false, - "display_on_load": false - }, - "retrieve_financial_account_features": { - "title": "Retrieve FinancialAccount Features", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_financial_account_features", - "section_anchor": "financial_account_features", - "subsection_anchors": null, - "path": "/treasury/financial_account_features/retrieve", - "gate": false, - "display_on_load": false - }, - "transactions": { - "title": "Transactions", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "transactions", - "section_anchor": "transactions", - "subsection_anchors": ["transaction_object", "retrieve_transaction", "list_transactions"], - "path": "/treasury/transactions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Transactions", - "description": "Transactions represent changes to a [FinancialAccount's](#financial_accounts) balance.\n", - "section_tag": "transactions", - "subsection_summaries": [ - { "anchor": "transaction_object", "curl_definition": null }, - { - "anchor": "retrieve_transaction", - "curl_definition": "GET /v1/treasury/transactions/:id" - }, - { "anchor": "list_transactions", "curl_definition": "GET /v1/treasury/transactions" } - ] - } - }, - "transaction_object": { - "title": "The Transaction object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "transaction_object", - "section_anchor": "transactions", - "subsection_anchors": null, - "path": "/treasury/transactions/object", - "gate": false, - "display_on_load": false - }, - "retrieve_transaction": { - "title": "Retrieve a Transaction", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_transaction", - "section_anchor": "transactions", - "subsection_anchors": null, - "path": "/treasury/transactions/retrieve", - "gate": false, - "display_on_load": false - }, - "list_transactions": { - "title": "List all Transactions", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_transactions", - "section_anchor": "transactions", - "subsection_anchors": null, - "path": "/treasury/transactions/list", - "gate": false, - "display_on_load": false - }, - "transaction_entries": { - "title": "TransactionEntries", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "transaction_entries", - "section_anchor": "transaction_entries", - "subsection_anchors": [ - "transaction_entry_object", - "retrieve_transaction_entry", - "list_transaction_entries" - ], - "path": "/treasury/transaction_entries", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "TransactionEntries", - "description": "TransactionEntries represent individual units of money movements within a single [Transaction](#transactions).\n", - "section_tag": "transaction_entries", - "subsection_summaries": [ - { "anchor": "transaction_entry_object", "curl_definition": null }, - { - "anchor": "retrieve_transaction_entry", - "curl_definition": "GET /v1/treasury/transaction_entries/:id" - }, - { - "anchor": "list_transaction_entries", - "curl_definition": "GET /v1/treasury/transaction_entries" - } - ] - } - }, - "transaction_entry_object": { - "title": "The TransactionEntry object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "transaction_entry_object", - "section_anchor": "transaction_entries", - "subsection_anchors": null, - "path": "/treasury/transaction_entries/object", - "gate": false, - "display_on_load": false - }, - "retrieve_transaction_entry": { - "title": "Retrieve a TransactionEntry", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_transaction_entry", - "section_anchor": "transaction_entries", - "subsection_anchors": null, - "path": "/treasury/transaction_entries/retrieve", - "gate": false, - "display_on_load": false - }, - "list_transaction_entries": { - "title": "List all TransactionEntries", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_transaction_entries", - "section_anchor": "transaction_entries", - "subsection_anchors": null, - "path": "/treasury/transaction_entries/list", - "gate": false, - "display_on_load": false - }, - "outbound_transfers": { - "title": "OutboundTransfers", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "outbound_transfers", - "section_anchor": "outbound_transfers", - "subsection_anchors": [ - "outbound_transfer_object", - "create_outbound_transfer", - "cancel_outbound_transfer", - "retrieve_outbound_transfer", - "list_outbound_transfers", - "test_mode_post_outbound_transfer", - "test_mode_return_outbound_transfer", - "test_mode_fail_outbound_transfer" - ], - "path": "/treasury/outbound_transfers", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "OutboundTransfers", - "description": "Use OutboundTransfers to transfer funds from a [FinancialAccount](#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n", - "section_tag": "outbound_transfers", - "subsection_summaries": [ - { "anchor": "outbound_transfer_object", "curl_definition": null }, - { - "anchor": "create_outbound_transfer", - "curl_definition": "POST /v1/treasury/outbound_transfers" - }, - { - "anchor": "cancel_outbound_transfer", - "curl_definition": "POST /v1/treasury/outbound_transfers/:id/cancel" - }, - { - "anchor": "retrieve_outbound_transfer", - "curl_definition": "GET /v1/treasury/outbound_transfers/:id" - }, - { - "anchor": "list_outbound_transfers", - "curl_definition": "GET /v1/treasury/outbound_transfers" - }, - { - "anchor": "test_mode_post_outbound_transfer", - "curl_definition": "POST /v1/test_helpers/treasury/outbound_transfers/:id/post" - }, - { - "anchor": "test_mode_return_outbound_transfer", - "curl_definition": "POST /v1/test_helpers/treasury/outbound_transfers/:id/return" - }, - { - "anchor": "test_mode_fail_outbound_transfer", - "curl_definition": "POST /v1/test_helpers/treasury/outbound_transfers/:id/fail" - } - ] - } - }, - "outbound_transfer_object": { - "title": "The OutboundTransfer object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "outbound_transfer_object", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/object", - "gate": false, - "display_on_load": false - }, - "create_outbound_transfer": { - "title": "Create an OutboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "create_outbound_transfer", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/create", - "gate": false, - "display_on_load": false - }, - "cancel_outbound_transfer": { - "title": "Cancel an OutboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "cancel_outbound_transfer", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/cancel", - "gate": false, - "display_on_load": false - }, - "retrieve_outbound_transfer": { - "title": "Retrieve an OutboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_outbound_transfer", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/retrieve", - "gate": false, - "display_on_load": false - }, - "list_outbound_transfers": { - "title": "List all OutboundTransfers", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_outbound_transfers", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/list", - "gate": false, - "display_on_load": false - }, - "test_mode_post_outbound_transfer": { - "title": "Test mode: Post an OutboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_post_outbound_transfer", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/test_mode_post", - "gate": false, - "display_on_load": false - }, - "test_mode_return_outbound_transfer": { - "title": "Test mode: Return an OutboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_return_outbound_transfer", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/test_mode_return", - "gate": false, - "display_on_load": false - }, - "test_mode_fail_outbound_transfer": { - "title": "Test mode: Fail an OutboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_fail_outbound_transfer", - "section_anchor": "outbound_transfers", - "subsection_anchors": null, - "path": "/treasury/outbound_transfers/test_mode_fail", - "gate": false, - "display_on_load": false - }, - "outbound_payments": { - "title": "OutboundPayments", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "outbound_payments", - "section_anchor": "outbound_payments", - "subsection_anchors": [ - "outbound_payment_object", - "create_outbound_payment", - "cancel_outbound_payment", - "retrieve_outbound_payment", - "list_outbound_payment", - "test_mode_outbound_payment_post", - "test_mode_outbound_payment_return", - "test_mode_outbound_payment_fail" - ], - "path": "/treasury/outbound_payments", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Outbound Payments", - "description": "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n", - "section_tag": "outbound_payments", - "subsection_summaries": [ - { "anchor": "outbound_payment_object", "curl_definition": null }, - { - "anchor": "create_outbound_payment", - "curl_definition": "POST /v1/treasury/outbound_payments" - }, - { - "anchor": "cancel_outbound_payment", - "curl_definition": "POST /v1/treasury/outbound_payments/:id/cancel" - }, - { - "anchor": "retrieve_outbound_payment", - "curl_definition": "GET /v1/treasury/outbound_payments/:id" - }, - { - "anchor": "list_outbound_payment", - "curl_definition": "GET /v1/treasury/outbound_payments" - }, - { - "anchor": "test_mode_outbound_payment_post", - "curl_definition": "POST /v1/test_helpers/treasury/outbound_payments/:id/post" - }, - { - "anchor": "test_mode_outbound_payment_return", - "curl_definition": "POST /v1/test_helpers/treasury/outbound_payments/:id/return" - }, - { - "anchor": "test_mode_outbound_payment_fail", - "curl_definition": "POST /v1/test_helpers/treasury/outbound_payments/:id/fail" - } - ] - } - }, - "outbound_payment_object": { - "title": "The OutboundPayment object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "outbound_payment_object", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/object", - "gate": false, - "display_on_load": false - }, - "create_outbound_payment": { - "title": "Create an OutboundPayment", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "create_outbound_payment", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/create", - "gate": false, - "display_on_load": false - }, - "cancel_outbound_payment": { - "title": "Cancel an OutboundPayment", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "cancel_outbound_payment", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/cancel", - "gate": false, - "display_on_load": false - }, - "retrieve_outbound_payment": { - "title": "Retrieve an OutboundPayment", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_outbound_payment", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/retrieve", - "gate": false, - "display_on_load": false - }, - "list_outbound_payment": { - "title": "List all OutboundPayments", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_outbound_payment", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/list", - "gate": false, - "display_on_load": false - }, - "test_mode_outbound_payment_post": { - "title": "Test mode: Post an OutboundPayment", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_outbound_payment_post", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/test_mode_post", - "gate": false, - "display_on_load": false - }, - "test_mode_outbound_payment_return": { - "title": "Test mode: Return an OutboundPayment", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_outbound_payment_return", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/test_mode_return", - "gate": false, - "display_on_load": false - }, - "test_mode_outbound_payment_fail": { - "title": "Test mode: Fail an OutboundPayment", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_outbound_payment_fail", - "section_anchor": "outbound_payments", - "subsection_anchors": null, - "path": "/treasury/outbound_payments/test_mode_fail", - "gate": false, - "display_on_load": false - }, - "inbound_transfers": { - "title": "InboundTransfers", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "inbound_transfers", - "section_anchor": "inbound_transfers", - "subsection_anchors": [ - "inbound_transfer_object", - "create_inbound_transfer", - "cancel_inbound_transfer", - "retrieve_inbound_transfer", - "list_inbound_transfer", - "test_mode_inbound_transfer_fail", - "test_mode_inbound_transfer_return", - "test_mode_inbound_transfer_succeed" - ], - "path": "/treasury/inbound_transfers", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "InboundTransfers", - "description": "Use [InboundTransfers](/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n", - "section_tag": "inbound_transfers", - "subsection_summaries": [ - { "anchor": "inbound_transfer_object", "curl_definition": null }, - { - "anchor": "create_inbound_transfer", - "curl_definition": "POST /v1/treasury/inbound_transfers" - }, - { - "anchor": "cancel_inbound_transfer", - "curl_definition": "POST /v1/treasury/inbound_transfers/:id/cancel" - }, - { - "anchor": "retrieve_inbound_transfer", - "curl_definition": "GET /v1/treasury/inbound_transfers/:id" - }, - { - "anchor": "list_inbound_transfer", - "curl_definition": "GET /v1/treasury/inbound_transfers" - }, - { - "anchor": "test_mode_inbound_transfer_fail", - "curl_definition": "POST /v1/test_helpers/treasury/inbound_transfers/:id/fail" - }, - { - "anchor": "test_mode_inbound_transfer_return", - "curl_definition": "POST /v1/test_helpers/treasury/inbound_transfers/:id/return" - }, - { - "anchor": "test_mode_inbound_transfer_succeed", - "curl_definition": "POST /v1/test_helpers/treasury/inbound_transfers/:id/succeed" - } - ] - } - }, - "inbound_transfer_object": { - "title": "The InboundTransfer object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "inbound_transfer_object", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/object", - "gate": false, - "display_on_load": false - }, - "create_inbound_transfer": { - "title": "Create an InboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "create_inbound_transfer", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/create", - "gate": false, - "display_on_load": false - }, - "cancel_inbound_transfer": { - "title": "Cancel an InboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "cancel_inbound_transfer", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/cancel", - "gate": false, - "display_on_load": false - }, - "retrieve_inbound_transfer": { - "title": "Retrieve an InboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_inbound_transfer", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/retrieve", - "gate": false, - "display_on_load": false - }, - "list_inbound_transfer": { - "title": "List all InboundTransfers", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_inbound_transfer", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/list", - "gate": false, - "display_on_load": false - }, - "test_mode_inbound_transfer_fail": { - "title": "Test mode: Fail an InboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_inbound_transfer_fail", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/test_mode_fail", - "gate": false, - "display_on_load": false - }, - "test_mode_inbound_transfer_return": { - "title": "Test mode: Return an InboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_inbound_transfer_return", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/test_mode_return", - "gate": false, - "display_on_load": false - }, - "test_mode_inbound_transfer_succeed": { - "title": "Test mode: Succeed an InboundTransfer", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_inbound_transfer_succeed", - "section_anchor": "inbound_transfers", - "subsection_anchors": null, - "path": "/treasury/inbound_transfers/test_mode_succeed", - "gate": false, - "display_on_load": false - }, - "received_credits": { - "title": "ReceivedCredits", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "received_credits", - "section_anchor": "received_credits", - "subsection_anchors": [ - "received_credit_object", - "retrieve_received_credit", - "list_received_credit", - "test_mode_create_received_credit" - ], - "path": "/treasury/received_credits", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "ReceivedCredits", - "description": "ReceivedCredits represent funds sent to a [FinancialAccount](#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.\n", - "section_tag": "received_credits", - "subsection_summaries": [ - { "anchor": "received_credit_object", "curl_definition": null }, - { - "anchor": "retrieve_received_credit", - "curl_definition": "GET /v1/treasury/received_credits/:id" - }, - { - "anchor": "list_received_credit", - "curl_definition": "GET /v1/treasury/received_credits" - }, - { - "anchor": "test_mode_create_received_credit", - "curl_definition": "POST /v1/test_helpers/treasury/received_credits" - } - ] - } - }, - "received_credit_object": { - "title": "The ReceivedCredit object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "received_credit_object", - "section_anchor": "received_credits", - "subsection_anchors": null, - "path": "/treasury/received_credits/object", - "gate": false, - "display_on_load": false - }, - "retrieve_received_credit": { - "title": "Retrieve a ReceivedCredit", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_received_credit", - "section_anchor": "received_credits", - "subsection_anchors": null, - "path": "/treasury/received_credits/retrieve", - "gate": false, - "display_on_load": false - }, - "list_received_credit": { - "title": "List all ReceivedCredits", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_received_credit", - "section_anchor": "received_credits", - "subsection_anchors": null, - "path": "/treasury/received_credits/list", - "gate": false, - "display_on_load": false - }, - "test_mode_create_received_credit": { - "title": "Test mode: Create a ReceivedCredit", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_create_received_credit", - "section_anchor": "received_credits", - "subsection_anchors": null, - "path": "/treasury/received_credits/test_mode_create", - "gate": false, - "display_on_load": false - }, - "received_debits": { - "title": "ReceivedDebits", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "received_debits", - "section_anchor": "received_debits", - "subsection_anchors": [ - "received_debit_object", - "retrieve_received_debit", - "list_received_debit", - "test_mode_create_received_debit" - ], - "path": "/treasury/received_debits", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "ReceivedDebits", - "description": "ReceivedDebits represent funds pulled from a [FinancialAccount](#financial_accounts). These are not initiated from the FinancialAccount.\n", - "section_tag": "received_debits", - "subsection_summaries": [ - { "anchor": "received_debit_object", "curl_definition": null }, - { - "anchor": "retrieve_received_debit", - "curl_definition": "GET /v1/treasury/received_debits/:id" - }, - { "anchor": "list_received_debit", "curl_definition": "GET /v1/treasury/received_debits" }, - { - "anchor": "test_mode_create_received_debit", - "curl_definition": "POST /v1/test_helpers/treasury/received_debits" - } - ] - } - }, - "received_debit_object": { - "title": "The ReceivedDebit object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "received_debit_object", - "section_anchor": "received_debits", - "subsection_anchors": null, - "path": "/treasury/received_debits/object", - "gate": false, - "display_on_load": false - }, - "retrieve_received_debit": { - "title": "Retrieve a ReceivedDebit", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_received_debit", - "section_anchor": "received_debits", - "subsection_anchors": null, - "path": "/treasury/received_debits/retrieve", - "gate": false, - "display_on_load": false - }, - "list_received_debit": { - "title": "List all ReceivedDebits", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_received_debit", - "section_anchor": "received_debits", - "subsection_anchors": null, - "path": "/treasury/received_debits/list", - "gate": false, - "display_on_load": false - }, - "test_mode_create_received_debit": { - "title": "Test mode: Create a ReceivedDebit", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "test_mode_create_received_debit", - "section_anchor": "received_debits", - "subsection_anchors": null, - "path": "/treasury/received_debits/test_mode_create", - "gate": false, - "display_on_load": false - }, - "credit_reversals": { - "title": "CreditReversals", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "credit_reversals", - "section_anchor": "credit_reversals", - "subsection_anchors": [ - "credit_reversal_object", - "create_credit_reversal", - "retrieve_credit_reversal", - "list_credit_reversal" - ], - "path": "/treasury/credit_reversals", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "CreditReversals", - "description": "You can reverse some [ReceivedCredits](#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.\n", - "section_tag": "credit_reversals", - "subsection_summaries": [ - { "anchor": "credit_reversal_object", "curl_definition": null }, - { - "anchor": "create_credit_reversal", - "curl_definition": "POST /v1/treasury/credit_reversals" - }, - { - "anchor": "retrieve_credit_reversal", - "curl_definition": "GET /v1/treasury/credit_reversals/:id" - }, - { "anchor": "list_credit_reversal", "curl_definition": "GET /v1/treasury/credit_reversals" } - ] - } - }, - "credit_reversal_object": { - "title": "The CreditReversal object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "credit_reversal_object", - "section_anchor": "credit_reversals", - "subsection_anchors": null, - "path": "/treasury/credit_reversals/object", - "gate": false, - "display_on_load": false - }, - "create_credit_reversal": { - "title": "Create a CreditReversal", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "create_credit_reversal", - "section_anchor": "credit_reversals", - "subsection_anchors": null, - "path": "/treasury/credit_reversals/create", - "gate": false, - "display_on_load": false - }, - "retrieve_credit_reversal": { - "title": "Retrieve a CreditReversal", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_credit_reversal", - "section_anchor": "credit_reversals", - "subsection_anchors": null, - "path": "/treasury/credit_reversals/retrieve", - "gate": false, - "display_on_load": false - }, - "list_credit_reversal": { - "title": "List all CreditReversals", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_credit_reversal", - "section_anchor": "credit_reversals", - "subsection_anchors": null, - "path": "/treasury/credit_reversals/list", - "gate": false, - "display_on_load": false - }, - "debit_reversals": { - "title": "DebitReversals", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "debit_reversals", - "section_anchor": "debit_reversals", - "subsection_anchors": [ - "debit_reversal_object", - "create_debit_reversal", - "retrieve_debit_reversal", - "list_debit_reversal" - ], - "path": "/treasury/debit_reversals", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "DebitReversals", - "description": "You can reverse some [ReceivedDebits](#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.\n", - "section_tag": "debit_reversals", - "subsection_summaries": [ - { "anchor": "debit_reversal_object", "curl_definition": null }, - { - "anchor": "create_debit_reversal", - "curl_definition": "POST /v1/treasury/debit_reversals" - }, - { - "anchor": "retrieve_debit_reversal", - "curl_definition": "GET /v1/treasury/debit_reversals/:id" - }, - { "anchor": "list_debit_reversal", "curl_definition": "GET /v1/treasury/debit_reversals" } - ] - } - }, - "debit_reversal_object": { - "title": "The DebitReversal object", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "debit_reversal_object", - "section_anchor": "debit_reversals", - "subsection_anchors": null, - "path": "/treasury/debit_reversals/object", - "gate": false, - "display_on_load": false - }, - "create_debit_reversal": { - "title": "Create a DebitReversal", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "create_debit_reversal", - "section_anchor": "debit_reversals", - "subsection_anchors": null, - "path": "/treasury/debit_reversals/create", - "gate": false, - "display_on_load": false - }, - "retrieve_debit_reversal": { - "title": "Retrieve a DebitReversal", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "retrieve_debit_reversal", - "section_anchor": "debit_reversals", - "subsection_anchors": null, - "path": "/treasury/debit_reversals/retrieve", - "gate": false, - "display_on_load": false - }, - "list_debit_reversal": { - "title": "List all DebitReversals", - "group_title": "Treasury", - "group_anchor": "treasury", - "anchor": "list_debit_reversal", - "section_anchor": "debit_reversals", - "subsection_anchors": null, - "path": "/treasury/debit_reversals/list", - "gate": false, - "display_on_load": false - }, - "scheduled_queries": { - "title": "Scheduled Queries", - "group_title": "Sigma", - "group_anchor": "sigma", - "anchor": "scheduled_queries", - "section_anchor": "scheduled_queries", - "subsection_anchors": [ - "scheduled_query_run_object", - "retrieve_scheduled_query_run", - "list_scheduled_query_run" - ], - "path": "/sigma/scheduled_queries", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Scheduled Queries", - "description": "If you have [scheduled a Sigma query](/docs/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results.\n", - "section_tag": "scheduled_queries", - "subsection_summaries": [ - { "anchor": "scheduled_query_run_object", "curl_definition": null }, - { - "anchor": "retrieve_scheduled_query_run", - "curl_definition": "GET /v1/sigma/scheduled_query_runs/:id" - }, - { - "anchor": "list_scheduled_query_run", - "curl_definition": "GET /v1/sigma/scheduled_query_runs" - } - ] - } - }, - "scheduled_query_run_object": { - "title": "The scheduled query run object", - "group_title": "Sigma", - "group_anchor": "sigma", - "anchor": "scheduled_query_run_object", - "section_anchor": "scheduled_queries", - "subsection_anchors": null, - "path": "/sigma/scheduled_queries/object", - "gate": false, - "display_on_load": false - }, - "retrieve_scheduled_query_run": { - "title": "Retrieve a scheduled query run", - "group_title": "Sigma", - "group_anchor": "sigma", - "anchor": "retrieve_scheduled_query_run", - "section_anchor": "scheduled_queries", - "subsection_anchors": null, - "path": "/sigma/scheduled_queries/retrieve", - "gate": false, - "display_on_load": false - }, - "list_scheduled_query_run": { - "title": "List all scheduled query runs", - "group_title": "Sigma", - "group_anchor": "sigma", - "anchor": "list_scheduled_query_run", - "section_anchor": "scheduled_queries", - "subsection_anchors": null, - "path": "/sigma/scheduled_queries/list", - "gate": false, - "display_on_load": false - }, - "reporting_report_run": { - "title": "Report Runs", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "reporting_report_run", - "section_anchor": "reporting_report_run", - "subsection_anchors": [ - "reporting_report_run_object", - "create_reporting_report_run", - "retrieve_reporting_report_run", - "list_reporting_report_run" - ], - "path": "/reporting/report_run", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Report Runs", - "description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](/docs/keys#test-live-modes).\n", - "section_tag": "reporting_report_run", - "subsection_summaries": [ - { "anchor": "reporting_report_run_object", "curl_definition": null }, - { - "anchor": "create_reporting_report_run", - "curl_definition": "POST /v1/reporting/report_runs" - }, - { - "anchor": "retrieve_reporting_report_run", - "curl_definition": "GET /v1/reporting/report_runs/:id" - }, - { - "anchor": "list_reporting_report_run", - "curl_definition": "GET /v1/reporting/report_runs" - } - ] - } - }, - "reporting_report_run_object": { - "title": "The Report Run object", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "reporting_report_run_object", - "section_anchor": "reporting_report_run", - "subsection_anchors": null, - "path": "/reporting/report_run/object", - "gate": false, - "display_on_load": false - }, - "create_reporting_report_run": { - "title": "Create a Report Run", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "create_reporting_report_run", - "section_anchor": "reporting_report_run", - "subsection_anchors": null, - "path": "/reporting/report_run/create", - "gate": false, - "display_on_load": false - }, - "retrieve_reporting_report_run": { - "title": "Retrieve a Report Run", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "retrieve_reporting_report_run", - "section_anchor": "reporting_report_run", - "subsection_anchors": null, - "path": "/reporting/report_run/retrieve", - "gate": false, - "display_on_load": false - }, - "list_reporting_report_run": { - "title": "List all Report Runs", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "list_reporting_report_run", - "section_anchor": "reporting_report_run", - "subsection_anchors": null, - "path": "/reporting/report_run/list", - "gate": false, - "display_on_load": false - }, - "reporting_report_type": { - "title": "Report Types", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "reporting_report_type", - "section_anchor": "reporting_report_type", - "subsection_anchors": [ - "reporting_report_type_object", - "retrieve_reporting_report_type", - "list_reporting_report_type" - ], - "path": "/reporting/report_type", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Report Types", - "description": "The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](/docs/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](/docs/keys#test-live-modes).\n", - "section_tag": "reporting_report_type", - "subsection_summaries": [ - { "anchor": "reporting_report_type_object", "curl_definition": null }, - { - "anchor": "retrieve_reporting_report_type", - "curl_definition": "GET /v1/reporting/report_types/:id" - }, - { - "anchor": "list_reporting_report_type", - "curl_definition": "GET /v1/reporting/report_types" - } - ] - } - }, - "reporting_report_type_object": { - "title": "The Report Type object", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "reporting_report_type_object", - "section_anchor": "reporting_report_type", - "subsection_anchors": null, - "path": "/reporting/report_type/object", - "gate": false, - "display_on_load": false - }, - "retrieve_reporting_report_type": { - "title": "Retrieve a Report Type", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "retrieve_reporting_report_type", - "section_anchor": "reporting_report_type", - "subsection_anchors": null, - "path": "/reporting/report_type/retrieve", - "gate": false, - "display_on_load": false - }, - "list_reporting_report_type": { - "title": "List all Report Types", - "group_title": "Reporting", - "group_anchor": "reporting", - "anchor": "list_reporting_report_type", - "section_anchor": "reporting_report_type", - "subsection_anchors": null, - "path": "/reporting/report_type/list", - "gate": false, - "display_on_load": false - }, - "financial_connections_accounts": { - "title": "Accounts", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_accounts", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": [ - "financial_connections_account_object", - "financial_connections_retrieve_account", - "financial_connections_refresh_account", - "financial_connections_subscribe_account", - "financial_connections_unsubscribe_account", - "financial_connections_disconnect_account", - "financial_connections_list_accounts" - ], - "path": "/financial_connections/accounts", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Accounts", - "description": "A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.\n", - "section_tag": "financial_connections_accounts", - "subsection_summaries": [ - { "anchor": "financial_connections_account_object", "curl_definition": null }, - { - "anchor": "financial_connections_retrieve_account", - "curl_definition": "GET /v1/financial_connections/accounts/:id" - }, - { - "anchor": "financial_connections_refresh_account", - "curl_definition": "POST /v1/financial_connections/accounts/:id/refresh" - }, - { - "anchor": "financial_connections_subscribe_account", - "curl_definition": "POST /v1/financial_connections/accounts/:id/subscribe" - }, - { - "anchor": "financial_connections_unsubscribe_account", - "curl_definition": "POST /v1/financial_connections/accounts/:id/unsubscribe" - }, - { - "anchor": "financial_connections_disconnect_account", - "curl_definition": "POST /v1/financial_connections/accounts/:id/disconnect" - }, - { - "anchor": "financial_connections_list_accounts", - "curl_definition": "GET /v1/financial_connections/accounts" - } - ] - } - }, - "financial_connections_account_object": { - "title": "The Account object", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_account_object", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": null, - "path": "/financial_connections/accounts/object", - "gate": false, - "display_on_load": false - }, - "financial_connections_retrieve_account": { - "title": "Retrieve an Account", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_retrieve_account", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": null, - "path": "/financial_connections/accounts/retrieve", - "gate": false, - "display_on_load": false - }, - "financial_connections_refresh_account": { - "title": "Refresh Account data", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_refresh_account", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": null, - "path": "/financial_connections/accounts/refresh", - "gate": false, - "display_on_load": false - }, - "financial_connections_subscribe_account": { - "title": "Subscribe to data refreshes for an Account", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_subscribe_account", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": null, - "path": "/financial_connections/accounts/subscribe", - "gate": false, - "display_on_load": false - }, - "financial_connections_unsubscribe_account": { - "title": "Unsubscribe from data refreshes for an Account", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_unsubscribe_account", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": null, - "path": "/financial_connections/accounts/unsubscribe", - "gate": false, - "display_on_load": false - }, - "financial_connections_disconnect_account": { - "title": "Disconnect an Account", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_disconnect_account", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": null, - "path": "/financial_connections/accounts/disconnect", - "gate": false, - "display_on_load": false - }, - "financial_connections_list_accounts": { - "title": "List Accounts", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_list_accounts", - "section_anchor": "financial_connections_accounts", - "subsection_anchors": null, - "path": "/financial_connections/accounts/list", - "gate": false, - "display_on_load": false - }, - "financial_connections_ownership": { - "title": "Account Ownership", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_ownership", - "section_anchor": "financial_connections_ownership", - "subsection_anchors": [ - "financial_connections_ownership_object", - "financial_connections_owner_object", - "financial_connections_list_account_owners" - ], - "path": "/financial_connections/ownership", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Account Ownership", - "description": "Describes a snapshot of the owners of an account at a particular point in time.", - "section_tag": "financial_connections_ownership", - "subsection_summaries": [ - { "anchor": "financial_connections_ownership_object", "curl_definition": null }, - { "anchor": "financial_connections_owner_object", "curl_definition": null }, - { - "anchor": "financial_connections_list_account_owners", - "curl_definition": "GET /v1/financial_connections/accounts/:id/owners?ownership=:ownership_id" - } - ] - } - }, - "financial_connections_ownership_object": { - "title": "The Account Ownership object", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_ownership_object", - "section_anchor": "financial_connections_ownership", - "subsection_anchors": null, - "path": "/financial_connections/ownership/object", - "gate": false, - "display_on_load": false - }, - "financial_connections_owner_object": { - "title": "The Account Owner object", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_owner_object", - "section_anchor": "financial_connections_ownership", - "subsection_anchors": null, - "path": "/financial_connections/ownership/owner-object", - "gate": false, - "display_on_load": false - }, - "financial_connections_list_account_owners": { - "title": "List Account Owners", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_list_account_owners", - "section_anchor": "financial_connections_ownership", - "subsection_anchors": null, - "path": "/financial_connections/ownership/list", - "gate": false, - "display_on_load": false - }, - "financial_connections_session": { - "title": "Sessions", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_session", - "section_anchor": "financial_connections_session", - "subsection_anchors": [ - "financial_connections_session_object", - "financial_connections_create_session", - "financial_connections_retrieve_session" - ], - "path": "/financial_connections/session", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Session", - "description": "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.\n", - "section_tag": "financial_connections_session", - "subsection_summaries": [ - { "anchor": "financial_connections_session_object", "curl_definition": null }, - { - "anchor": "financial_connections_create_session", - "curl_definition": "POST /v1/financial_connections/sessions" - }, - { - "anchor": "financial_connections_retrieve_session", - "curl_definition": "GET /v1/financial_connections/sessions/:id" - } - ] - } - }, - "financial_connections_session_object": { - "title": "The Session object", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_session_object", - "section_anchor": "financial_connections_session", - "subsection_anchors": null, - "path": "/financial_connections/sessions/object", - "gate": false, - "display_on_load": false - }, - "financial_connections_create_session": { - "title": "Create a Session", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_create_session", - "section_anchor": "financial_connections_session", - "subsection_anchors": null, - "path": "/financial_connections/sessions/create", - "gate": false, - "display_on_load": false - }, - "financial_connections_retrieve_session": { - "title": "Retrieve a Session", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_retrieve_session", - "section_anchor": "financial_connections_session", - "subsection_anchors": null, - "path": "/financial_connections/sessions/retrieve", - "gate": false, - "display_on_load": false - }, - "financial_connections_transaction": { - "title": "Transactions", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_transaction", - "section_anchor": "financial_connections_transaction", - "subsection_anchors": [ - "financial_connections_transaction_object", - "financial_connections_list_transactions" - ], - "path": "/financial_connections/transaction", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Transactions", - "description": "A Transaction represents a real transaction that affects a Financial Connections Account balance.\n", - "section_tag": "financial_connections_transaction", - "subsection_summaries": [ - { "anchor": "financial_connections_transaction_object", "curl_definition": null }, - { - "anchor": "financial_connections_list_transactions", - "curl_definition": "GET /v1/financial_connections/transactions" - } - ] - } - }, - "financial_connections_transaction_object": { - "title": "The Transaction object", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_transaction_object", - "section_anchor": "financial_connections_transaction", - "subsection_anchors": null, - "path": "/financial_connections/transactions/object", - "gate": false, - "display_on_load": false - }, - "financial_connections_list_transactions": { - "title": "List Transactions", - "group_title": "Financial Connections", - "group_anchor": "financial_connections", - "anchor": "financial_connections_list_transactions", - "section_anchor": "financial_connections_transaction", - "subsection_anchors": null, - "path": "/financial_connections/transactions/list", - "gate": false, - "display_on_load": false - }, - "identity_verification_sessions": { - "title": "VerificationSessions", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "identity_verification_sessions", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": [ - "identity_verification_session_object", - "create_identity_verification_session", - "list_identity_verification_session", - "retrieve_identity_verification_session", - "update_identity_verification_session", - "cancel_identity_verification_session", - "redact_identity_verification_session" - ], - "path": "/identity/verification_sessions", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "VerificationSession", - "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](/docs/identity/verification-sessions)\n", - "section_tag": "identity_verification_sessions", - "subsection_summaries": [ - { "anchor": "identity_verification_session_object", "curl_definition": null }, - { - "anchor": "create_identity_verification_session", - "curl_definition": "POST /v1/identity/verification_sessions" - }, - { - "anchor": "list_identity_verification_session", - "curl_definition": "GET /v1/identity/verification_sessions" - }, - { - "anchor": "retrieve_identity_verification_session", - "curl_definition": "GET /v1/identity/verification_sessions/:id" - }, - { - "anchor": "update_identity_verification_session", - "curl_definition": "POST /v1/identity/verification_sessions/:id" - }, - { - "anchor": "cancel_identity_verification_session", - "curl_definition": "POST /v1/identity/verification_sessions/:id/cancel" - }, - { - "anchor": "redact_identity_verification_session", - "curl_definition": "POST /v1/identity/verification_sessions/:id/redact" - } - ] - } - }, - "identity_verification_session_object": { - "title": "The VerificationSession object", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "identity_verification_session_object", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": null, - "path": "/identity/verification_sessions/object", - "gate": false, - "display_on_load": false - }, - "create_identity_verification_session": { - "title": "Create a VerificationSession", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "create_identity_verification_session", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": null, - "path": "/identity/verification_sessions/create", - "gate": false, - "display_on_load": false - }, - "list_identity_verification_session": { - "title": "List VerificationSessions", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "list_identity_verification_session", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": null, - "path": "/identity/verification_sessions/list", - "gate": false, - "display_on_load": false - }, - "retrieve_identity_verification_session": { - "title": "Retrieve a VerificationSession", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "retrieve_identity_verification_session", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": null, - "path": "/identity/verification_sessions/retrieve", - "gate": false, - "display_on_load": false - }, - "update_identity_verification_session": { - "title": "Update a VerificationSession", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "update_identity_verification_session", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": null, - "path": "/identity/verification_sessions/update", - "gate": false, - "display_on_load": false - }, - "cancel_identity_verification_session": { - "title": "Cancel a VerificationSession", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "cancel_identity_verification_session", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": null, - "path": "/identity/verification_sessions/cancel", - "gate": false, - "display_on_load": false - }, - "redact_identity_verification_session": { - "title": "Redact a VerificationSession", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "redact_identity_verification_session", - "section_anchor": "identity_verification_sessions", - "subsection_anchors": null, - "path": "/identity/verification_sessions/redact", - "gate": false, - "display_on_load": false - }, - "identity_verification_reports": { - "title": "VerificationReports", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "identity_verification_reports", - "section_anchor": "identity_verification_reports", - "subsection_anchors": [ - "identity_verification_report_object", - "retrieve_identity_verification_report", - "list_identity_verification_report" - ], - "path": "/identity/verification_reports", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "VerificationReport", - "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](/docs/identity/verification-sessions#results).\n", - "section_tag": "identity_verification_reports", - "subsection_summaries": [ - { "anchor": "identity_verification_report_object", "curl_definition": null }, - { - "anchor": "retrieve_identity_verification_report", - "curl_definition": "GET /v1/identity/verification_reports/:id" - }, - { - "anchor": "list_identity_verification_report", - "curl_definition": "GET /v1/identity/verification_reports" - } - ] - } - }, - "identity_verification_report_object": { - "title": "The VerificationReport object", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "identity_verification_report_object", - "section_anchor": "identity_verification_reports", - "subsection_anchors": null, - "path": "/identity/verification_reports/object", - "gate": false, - "display_on_load": false - }, - "retrieve_identity_verification_report": { - "title": "Retrieve a VerificationReport", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "retrieve_identity_verification_report", - "section_anchor": "identity_verification_reports", - "subsection_anchors": null, - "path": "/identity/verification_reports/retrieve", - "gate": false, - "display_on_load": false - }, - "list_identity_verification_report": { - "title": "List VerificationReports", - "group_title": "Identity", - "group_anchor": "identity", - "anchor": "list_identity_verification_report", - "section_anchor": "identity_verification_reports", - "subsection_anchors": null, - "path": "/identity/verification_reports/list", - "gate": false, - "display_on_load": false - }, - "webhook_endpoints": { - "title": "Webhook Endpoints", - "group_title": "Webhooks", - "group_anchor": "webhooks", - "anchor": "webhook_endpoints", - "section_anchor": "webhook_endpoints", - "subsection_anchors": [ - "webhook_endpoint_object", - "create_webhook_endpoint", - "retrieve_webhook_endpoint", - "update_webhook_endpoint", - "list_webhook_endpoints", - "delete_webhook_endpoints" - ], - "path": "/webhook_endpoints", - "gate": false, - "display_on_load": false, - "data": { - "section_type": "resource", - "title": "Webhook Endpoints", - "description": "You can configure [webhook endpoints](/docs/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up Webhooks](/docs/webhooks/configure).\n", - "section_tag": "webhook_endpoints", - "subsection_summaries": [ - { "anchor": "webhook_endpoint_object", "curl_definition": null }, - { "anchor": "create_webhook_endpoint", "curl_definition": "POST /v1/webhook_endpoints" }, - { - "anchor": "retrieve_webhook_endpoint", - "curl_definition": "GET /v1/webhook_endpoints/:id" - }, - { - "anchor": "update_webhook_endpoint", - "curl_definition": "POST /v1/webhook_endpoints/:id" - }, - { "anchor": "list_webhook_endpoints", "curl_definition": "GET /v1/webhook_endpoints" }, - { - "anchor": "delete_webhook_endpoints", - "curl_definition": "DELETE /v1/webhook_endpoints/:id" - } - ] - } - }, - "webhook_endpoint_object": { - "title": "The webhook endpoint object", - "group_title": "Webhooks", - "group_anchor": "webhooks", - "anchor": "webhook_endpoint_object", - "section_anchor": "webhook_endpoints", - "subsection_anchors": null, - "path": "/webhook_endpoints/object", - "gate": false, - "display_on_load": false - }, - "create_webhook_endpoint": { - "title": "Create a webhook endpoint", - "group_title": "Webhooks", - "group_anchor": "webhooks", - "anchor": "create_webhook_endpoint", - "section_anchor": "webhook_endpoints", - "subsection_anchors": null, - "path": "/webhook_endpoints/create", - "gate": false, - "display_on_load": false - }, - "retrieve_webhook_endpoint": { - "title": "Retrieve a webhook endpoint", - "group_title": "Webhooks", - "group_anchor": "webhooks", - "anchor": "retrieve_webhook_endpoint", - "section_anchor": "webhook_endpoints", - "subsection_anchors": null, - "path": "/webhook_endpoints/retrieve", - "gate": false, - "display_on_load": false - }, - "update_webhook_endpoint": { - "title": "Update a webhook endpoint", - "group_title": "Webhooks", - "group_anchor": "webhooks", - "anchor": "update_webhook_endpoint", - "section_anchor": "webhook_endpoints", - "subsection_anchors": null, - "path": "/webhook_endpoints/update", - "gate": false, - "display_on_load": false - }, - "list_webhook_endpoints": { - "title": "List all webhook endpoints", - "group_title": "Webhooks", - "group_anchor": "webhooks", - "anchor": "list_webhook_endpoints", - "section_anchor": "webhook_endpoints", - "subsection_anchors": null, - "path": "/webhook_endpoints/list", - "gate": false, - "display_on_load": false - }, - "delete_webhook_endpoints": { - "title": "Delete a webhook endpoint", - "group_title": "Webhooks", - "group_anchor": "webhooks", - "anchor": "delete_webhook_endpoints", - "section_anchor": "webhook_endpoints", - "subsection_anchors": null, - "path": "/webhook_endpoints/delete", - "gate": false, - "display_on_load": false - } -}