72,81c72
< "anyOf": [
< {
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< }
< ],
< "title": "Polymorphic",
< "x-stripeBypassValidation": true
---
> "$ref": "#/components/schemas/external_account"
187c178,269
< "x-resourceId": "account"
---
> "x-resourceId": "account",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/account"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/accounts/{account}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/accounts/{account}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/accounts"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/accounts"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/accounts/{account}"
> },
> {
> "method_name": "reject",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/accounts/{account}/reject"
> },
> {
> "method_name": "persons",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/accounts/{account}/persons"
> },
> {
> "method_name": "capabilities",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/accounts/{account}/capabilities"
> }
> ],
> "x-stripeResource": {
> "class_name": "Account",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "account_branding_settings",
> "account_business_profile",
> "account_capabilities",
> "account_card_payments_settings",
> "account_dashboard_settings",
> "account_decline_charge_on",
> "account_future_requirements",
> "account_payments_settings",
> "account_payout_settings",
> "account_requirements",
> "account_settings",
> "account_tos_acceptance",
> "account_unification_account_controller",
> "legal_entity_company",
> "transfer_schedule"
> ],
> "polymorphic_groups": [
> "deleted_payment_source",
> "payment_source"
> ]
> }
200c282,286
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebitPayments",
> "in_class": "account_settings"
> }
257a344,349
> "required": [
> "icon",
> "logo",
> "primary_color",
> "secondary_color"
> ],
263c355,359
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SettingsBranding",
> "in_class": "account"
> }
319a416,424
> "required": [
> "mcc",
> "name",
> "support_address",
> "support_email",
> "support_phone",
> "support_url",
> "url"
> ],
324c429,433
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BusinessProfile",
> "in_class": "account"
> }
629c738,742
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Capabilities",
> "in_class": "account"
> }
694a808,809
> "alternatives",
> "current_deadline",
695a811
> "disabled_reason",
706c822,826
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FutureRequirements",
> "in_class": "capability"
> }
771a892,893
> "alternatives",
> "current_deadline",
772a895
> "disabled_reason",
783c906,910
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Requirements",
> "in_class": "capability"
> }
796c923,930
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SettingsCardIssuing",
> "in_class": "account_settings",
> "inner_classes": [
> "card_issuing_account_terms_of_service"
> ]
> }
822a957,961
> "required": [
> "statement_descriptor_prefix",
> "statement_descriptor_prefix_kana",
> "statement_descriptor_prefix_kanji"
> ],
827c966,970
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SettingsCardPayments",
> "in_class": "account"
> }
844a988,991
> "required": [
> "display_name",
> "timezone"
> ],
847c994,998
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SettingsDashboard",
> "in_class": "account"
> }
867c1018,1022
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DeclineChargeOn",
> "in_class": "account"
> }
936a1092,1101
> "required": [
> "alternatives",
> "current_deadline",
> "currently_due",
> "disabled_reason",
> "errors",
> "eventually_due",
> "past_due",
> "pending_verification"
> ],
942c1107,1111
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FutureRequirements",
> "in_class": "account"
> }
979c1148,1161
< "x-resourceId": "account_link"
---
> "x-resourceId": "account_link",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/account_links"
> }
> ],
> "x-stripeResource": {
> "class_name": "AccountLink",
> "in_package": ""
> }
1014a1197,1203
> "required": [
> "statement_descriptor",
> "statement_descriptor_kana",
> "statement_descriptor_kanji",
> "statement_descriptor_prefix_kana",
> "statement_descriptor_prefix_kanji"
> ],
1017c1206,1210
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SettingsPayments",
> "in_class": "account"
> }
1038c1231,1232
< "schedule"
---
> "schedule",
> "statement_descriptor"
1044c1238,1242
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SettingsPayouts",
> "in_class": "account"
> }
1113a1312,1321
> "required": [
> "alternatives",
> "current_deadline",
> "currently_due",
> "disabled_reason",
> "errors",
> "eventually_due",
> "past_due",
> "pending_verification"
> ],
1119c1327,1335
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Requirements",
> "in_class": "account",
> "inner_classes": [
> "account_requirements_alternative",
> "account_requirements_error"
> ]
> }
1147c1363,1367
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Alternative",
> "in_class": "account_requirements"
> }
1226c1446,1450
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Errors",
> "in_class": "account_requirements"
> }
1239c1463,1467
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebitPayments",
> "in_class": "account_settings"
> }
1290c1518,1528
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Settings",
> "in_class": "account",
> "inner_classes": [
> "account_bacs_debit_payments_settings",
> "account_card_issuing_settings",
> "account_sepa_debit_payments_settings",
> "account_treasury_settings"
> ]
> }
1311a1550,1553
> "required": [
> "date",
> "ip"
> ],
1314c1556,1560
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TosAcceptance",
> "in_class": "account_treasury_settings"
> }
1345c1591,1595
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TosAcceptance",
> "in_class": "account"
> }
1358c1608,1615
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SettingsTreasury",
> "in_class": "account_settings",
> "inner_classes": [
> "account_terms_of_service"
> ]
> }
1381c1638,1642
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Controller",
> "in_class": "account"
> }
1422a1684,1691
> "required": [
> "city",
> "country",
> "line1",
> "line2",
> "postal_code",
> "state"
> ],
1425c1694,1720
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Address",
> "in_package": ""
> }
> },
> "alternate_statement_descriptors": {
> "description": "",
> "properties": {
> "kana": {
> "description": "The Kana variation of the descriptor.",
> "maxLength": 5000,
> "type": "string"
> },
> "kanji": {
> "description": "The Kanji variation of the descriptor.",
> "maxLength": 5000,
> "type": "string"
> }
> },
> "title": "AlternateStatementDescriptors",
> "type": "object",
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AlternateStatementDescriptors",
> "in_class": "charge"
> }
1480,1491c1775
< "anyOf": [
< {
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
< }
< ],
< "description": "The source object for errors returned on a request involving a source."
---
> "$ref": "#/components/schemas/payment_source"
1514c1798,1802
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "StripeError",
> "in_package": ""
> }
1555c1843,1878
< "x-resourceId": "apple_pay_domain"
---
> "x-resourceId": "apple_pay_domain",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/apple_pay/domains"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/apple_pay/domains"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/apple_pay/domains/{domain}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/apple_pay/domains/{domain}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ApplePayDomain",
> "has_collection_class": true,
> "in_package": ""
> }
1580a1904
> "name",
1585c1909,1913
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Application",
> "in_package": ""
> }
1768a2097
> "balance_transaction",
1774a2104
> "originating_transaction",
1788c2118,2142
< "x-resourceId": "application_fee"
---
> "x-resourceId": "application_fee",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/application_fees"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/application_fees/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ApplicationFee",
> "has_collection_class": true,
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
1840a2195
> "expires_at",
1844a2200
> "payload",
1852c2208,2246
< "x-resourceId": "apps.secret"
---
> "x-resourceId": "apps.secret",
> "x-stripeOperations": [
> {
> "method_name": "find",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/apps/secrets/find"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/apps/secrets"
> },
> {
> "method_name": "delete_where",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/apps/secrets/delete"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/apps/secrets"
> }
> ],
> "x-stripeResource": {
> "class_name": "Secret",
> "has_collection_class": true,
> "in_package": "Apps",
> "inner_classes": [
> "secret_service_resource_scope"
> ]
> }
1873c2267,2268
< "enabled"
---
> "enabled",
> "status"
1877c2272,2276
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "invoice"
> }
1940c2339,2356
< "x-resourceId": "balance"
---
> "x-resourceId": "balance",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/balance"
> }
> ],
> "x-stripeResource": {
> "class_name": "Balance",
> "in_package": "",
> "inner_classes": [
> "balance_amount",
> "balance_detail"
> ]
> }
1965c2381,2388
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Money",
> "in_class": "balance",
> "inner_classes": [
> "balance_amount_by_source_type"
> ]
> }
1985c2408,2412
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SourceTypes",
> "in_class": "balance_amount"
> }
2005c2432,2436
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Details",
> "in_class": "balance"
> }
2078,2123c2509
< "$ref": "#/components/schemas/application_fee"
< },
< {
< "$ref": "#/components/schemas/charge"
< },
< {
< "$ref": "#/components/schemas/connect_collection_transfer"
< },
< {
< "$ref": "#/components/schemas/dispute"
< },
< {
< "$ref": "#/components/schemas/fee_refund"
< },
< {
< "$ref": "#/components/schemas/issuing.authorization"
< },
< {
< "$ref": "#/components/schemas/issuing.dispute"
< },
< {
< "$ref": "#/components/schemas/issuing.transaction"
< },
< {
< "$ref": "#/components/schemas/payout"
< },
< {
< "$ref": "#/components/schemas/platform_tax_fee"
< },
< {
< "$ref": "#/components/schemas/refund"
< },
< {
< "$ref": "#/components/schemas/reserve_transaction"
< },
< {
< "$ref": "#/components/schemas/tax_deducted_at_source"
< },
< {
< "$ref": "#/components/schemas/topup"
< },
< {
< "$ref": "#/components/schemas/transfer"
< },
< {
< "$ref": "#/components/schemas/transfer_reversal"
---
> "$ref": "#/components/schemas/balance_transaction_source"
2131,2176c2517
< "$ref": "#/components/schemas/application_fee"
< },
< {
< "$ref": "#/components/schemas/charge"
< },
< {
< "$ref": "#/components/schemas/connect_collection_transfer"
< },
< {
< "$ref": "#/components/schemas/dispute"
< },
< {
< "$ref": "#/components/schemas/fee_refund"
< },
< {
< "$ref": "#/components/schemas/issuing.authorization"
< },
< {
< "$ref": "#/components/schemas/issuing.dispute"
< },
< {
< "$ref": "#/components/schemas/issuing.transaction"
< },
< {
< "$ref": "#/components/schemas/payout"
< },
< {
< "$ref": "#/components/schemas/platform_tax_fee"
< },
< {
< "$ref": "#/components/schemas/refund"
< },
< {
< "$ref": "#/components/schemas/reserve_transaction"
< },
< {
< "$ref": "#/components/schemas/tax_deducted_at_source"
< },
< {
< "$ref": "#/components/schemas/topup"
< },
< {
< "$ref": "#/components/schemas/transfer"
< },
< {
< "$ref": "#/components/schemas/transfer_reversal"
---
> "$ref": "#/components/schemas/balance_transaction_source"
2179,2180c2520
< },
< "x-stripeBypassValidation": true
---
> }
2230a2571,2572
> "description",
> "exchange_rate",
2236a2579
> "source",
2246c2589,2670
< "x-resourceId": "balance_transaction"
---
> "x-resourceId": "balance_transaction",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/balance_transactions"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/balance_transactions/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "BalanceTransaction",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "fee"
> ]
> }
> },
> "balance_transaction_source": {
> "anyOf": [
> {
> "$ref": "#/components/schemas/application_fee"
> },
> {
> "$ref": "#/components/schemas/charge"
> },
> {
> "$ref": "#/components/schemas/connect_collection_transfer"
> },
> {
> "$ref": "#/components/schemas/dispute"
> },
> {
> "$ref": "#/components/schemas/fee_refund"
> },
> {
> "$ref": "#/components/schemas/issuing.authorization"
> },
> {
> "$ref": "#/components/schemas/issuing.dispute"
> },
> {
> "$ref": "#/components/schemas/issuing.transaction"
> },
> {
> "$ref": "#/components/schemas/payout"
> },
> {
> "$ref": "#/components/schemas/platform_tax_fee"
> },
> {
> "$ref": "#/components/schemas/refund"
> },
> {
> "$ref": "#/components/schemas/reserve_transaction"
> },
> {
> "$ref": "#/components/schemas/tax_deducted_at_source"
> },
> {
> "$ref": "#/components/schemas/topup"
> },
> {
> "$ref": "#/components/schemas/transfer"
> },
> {
> "$ref": "#/components/schemas/transfer_reversal"
> }
> ],
> "title": "Polymorphic",
> "x-stripeBypassValidation": true,
> "x-stripeResource": {
> "class_name": "BalanceTransactionSource"
> }
2391a2816,2819
> "account_holder_name",
> "account_holder_type",
> "account_type",
> "bank_name",
2393a2822
> "fingerprint",
2396a2826
> "routing_number",
2405c2835,2882
< "x-resourceId": "bank_account"
---
> "x-resourceId": "bank_account",
> "x-stripeOperations": [
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/customers/{customer}/sources/{id}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/customers/{customer}/sources/{id}"
> },
> {
> "method_name": "verify",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/customers/{customer}/sources/{id}/verify"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "BankAccount",
> "in_package": "",
> "polymorphic_groups": [
> "deleted_external_account",
> "deleted_payment_source",
> "external_account",
> "payment_source"
> ]
> }
2465c2942,2946
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AccountHolder",
> "in_class": "financial_connections.account"
> }
2507c2988,2996
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Balance",
> "in_class": "financial_connections.account",
> "inner_classes": [
> "bank_connections_resource_balance_api_resource_cash_balance",
> "bank_connections_resource_balance_api_resource_credit_balance"
> ]
> }
2520a3010,3012
> "required": [
> "available"
> ],
2523c3015,3019
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CashBalance",
> "in_class": "bank_connections_resource_balance"
> }
2536a3033,3035
> "required": [
> "used"
> ],
2539c3038,3042
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CreditBalance",
> "in_class": "bank_connections_resource_balance"
> }
2565c3068,3072
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BalanceRefresh",
> "in_class": "financial_connections.account"
> }
2579a3087,3089
> "required": [
> "countries"
> ],
2582c3092,3096
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Filters",
> "in_class": "financial_connections.session"
> }
2608c3122,3126
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "OwnershipRefresh",
> "in_class": "financial_connections.account"
> }
2640a3159,3164
> "required": [
> "address",
> "email",
> "name",
> "phone"
> ],
2645c3169,3173
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BillingDetails",
> "in_class": "payment_method"
> }
2736a3265
> "application",
2738a3268
> "default_return_url",
2743a3274
> "metadata",
2755c3286,3326
< "x-resourceId": "billing_portal.configuration"
---
> "x-resourceId": "billing_portal.configuration",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/billing_portal/configurations"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/billing_portal/configurations"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/billing_portal/configurations/{configuration}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/billing_portal/configurations/{configuration}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Configuration",
> "has_collection_class": true,
> "in_package": "BillingPortal",
> "inner_classes": [
> "portal_business_profile",
> "portal_features",
> "portal_login_page"
> ]
> }
2882a3454
> "locale",
2883a3456,3457
> "on_behalf_of",
> "return_url",
2891c3465,3478
< "x-resourceId": "billing_portal.session"
---
> "x-resourceId": "billing_portal.session",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/billing_portal/sessions"
> }
> ],
> "x-stripeResource": {
> "class_name": "Session",
> "in_package": "BillingPortal"
> }
2959a3547
> "requested_at",
2969c3557,3603
< "x-resourceId": "capability"
---
> "x-resourceId": "capability",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/accounts/{account}/capabilities"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/accounts/{account}/capabilities"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/accounts/{account}/capabilities/{capability}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/accounts/{account}/capabilities/{capability}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/accounts/{account}/capabilities/{capability}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Capability",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "account_capability_future_requirements",
> "account_capability_requirements"
> ]
> }
3106a3741,3745
> "description": {
> "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "type": "string"
> },
3136a3776,3785
> "iin": {
> "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "type": "string"
> },
> "issuer": {
> "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "type": "string"
> },
3177a3827,3834
> "address_city",
> "address_country",
> "address_line1",
> "address_line1_check",
> "address_line2",
> "address_state",
> "address_zip",
> "address_zip_check",
3178a3836,3838
> "country",
> "cvc_check",
> "dynamic_last4",
3184c3844,3847
< "object"
---
> "metadata",
> "name",
> "object",
> "tokenization_method"
3192,3213c3855,3895
< "x-resourceId": "card"
< },
< "card_generated_from_payment_method_details": {
< "description": "",
< "properties": {
< "card_present": {
< "$ref": "#/components/schemas/payment_method_details_card_present"
< },
< "type": {
< "description": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.",
< "maxLength": 5000,
< "type": "string"
< }
< },
< "required": [
< "type"
< ],
< "title": "card_generated_from_payment_method_details",
< "type": "object",
< "x-expandableFields": [
< "card_present"
< ]
---
> "x-resourceId": "card",
> "x-stripeOperations": [
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/customers/{customer}/sources/{id}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/customers/{customer}/sources/{id}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_package": "",
> "polymorphic_groups": [
> "deleted_external_account",
> "deleted_payment_source",
> "external_account",
> "payment_source"
> ]
> }
3234a3917,3920
> "required": [
> "date",
> "ip"
> ],
3237c3923,3927
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TosAcceptance",
> "in_class": "account_card_issuing_settings"
> }
3244c3934,3938
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "mandate_payment_method_details"
> }
3277a3972
> "available",
3288c3983,4006
< "x-resourceId": "cash_balance"
---
> "x-resourceId": "cash_balance",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/cash_balance"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/customers/{customer}/cash_balance"
> }
> ],
> "x-stripeResource": {
> "class_name": "CashBalance",
> "in_package": "",
> "inner_classes": [
> "customer_balance_customer_balance_settings"
> ]
> }
3292a4011,4013
> "alternate_statement_descriptors": {
> "$ref": "#/components/schemas/alternate_statement_descriptors"
> },
3349a4071,4075
> "authorization_code": {
> "description": "Authorization code on the charge.",
> "maxLength": 5000,
> "type": "string"
> },
3423a4150,4189
> "destination": {
> "anyOf": [
> {
> "maxLength": 5000,
> "type": "string"
> },
> {
> "$ref": "#/components/schemas/account"
> }
> ],
> "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.",
> "nullable": true,
> "x-expansionResources": {
> "oneOf": [
> {
> "$ref": "#/components/schemas/account"
> }
> ]
> }
> },
> "dispute": {
> "anyOf": [
> {
> "maxLength": 5000,
> "type": "string"
> },
> {
> "$ref": "#/components/schemas/dispute"
> }
> ],
> "description": "Details about the dispute if the charge has been disputed.",
> "nullable": true,
> "x-expansionResources": {
> "oneOf": [
> {
> "$ref": "#/components/schemas/dispute"
> }
> ]
> }
> },
3493a4260,4262
> "level3": {
> "$ref": "#/components/schemas/level3"
> },
3673a4443,4451
> "source": {
> "anyOf": [
> {
> "$ref": "#/components/schemas/payment_source"
> }
> ],
> "description": "This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.",
> "nullable": true
> },
3753a4532,4535
> "application",
> "application_fee",
> "application_fee_amount",
> "balance_transaction",
3754a4537
> "calculated_statement_descriptor",
3757a4541,4544
> "customer",
> "description",
> "destination",
> "dispute",
3758a4546,4549
> "failure_balance_transaction",
> "failure_code",
> "failure_message",
> "fraud_details",
3759a4551
> "invoice",
3762a4555,4556
> "on_behalf_of",
> "outcome",
3763a4558,4563
> "payment_intent",
> "payment_method",
> "payment_method_details",
> "receipt_email",
> "receipt_number",
> "receipt_url",
3765c4565,4573
< "status"
---
> "review",
> "shipping",
> "source",
> "source_transfer",
> "statement_descriptor",
> "statement_descriptor_suffix",
> "status",
> "transfer_data",
> "transfer_group"
3769a4578
> "alternate_statement_descriptors",
3774a4584,4585
> "destination",
> "dispute",
3777a4589
> "level3",
3785a4598
> "source",
3790c4603,4665
< "x-resourceId": "charge"
---
> "x-resourceId": "charge",
> "x-stripeOperations": [
> {
> "method_name": "search",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/charges/search"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/charges"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/charges"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/charges/{charge}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/charges/{charge}"
> },
> {
> "method_name": "capture",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/charges/{charge}/capture"
> }
> ],
> "x-stripeResource": {
> "class_name": "Charge",
> "has_collection_class": true,
> "has_search_result_class": true,
> "in_package": "",
> "inner_classes": [
> "alternate_statement_descriptors",
> "charge_fraud_details",
> "charge_outcome",
> "charge_transfer_data",
> "level3",
> "payment_method_details",
> "radar_radar_options"
> ],
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
3808c4683,4687
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "FraudDetails",
> "in_class": "charge"
> }
3865a4745,4747
> "network_status",
> "reason",
> "seller_message",
3872c4754,4758
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Outcome",
> "in_class": "charge"
> }
3902a4789
> "amount",
3909c4796,4800
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TransferData",
> "in_class": "charge"
> }
4369a5261,5264
> "after_expiration",
> "allow_promotion_codes",
> "amount_subtotal",
> "amount_total",
4370a5266
> "billing_address_collection",
4371a5268,5270
> "client_reference_id",
> "consent",
> "consent_collection",
4372a5272,5276
> "currency",
> "customer",
> "customer_creation",
> "customer_details",
> "customer_email",
4375a5280,5281
> "locale",
> "metadata",
4377a5284,5287
> "payment_intent",
> "payment_link",
> "payment_method_collection",
> "payment_method_options",
4379a5290,5294
> "recovered_from",
> "setup_intent",
> "shipping_address_collection",
> "shipping_cost",
> "shipping_details",
4381c5296,5301
< "success_url"
---
> "status",
> "submit_type",
> "subscription",
> "success_url",
> "total_details",
> "url"
4406c5326,5382
< "x-resourceId": "checkout.session"
---
> "x-resourceId": "checkout.session",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/checkout/sessions"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/checkout/sessions/{session}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/checkout/sessions"
> },
> {
> "method_name": "list_line_items",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/checkout/sessions/{session}/line_items"
> },
> {
> "method_name": "expire",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/checkout/sessions/{session}/expire"
> }
> ],
> "x-stripeResource": {
> "class_name": "Session",
> "has_collection_class": true,
> "in_package": "Checkout",
> "inner_classes": [
> "checkout_session_payment_method_options",
> "payment_pages_checkout_session_after_expiration",
> "payment_pages_checkout_session_automatic_tax",
> "payment_pages_checkout_session_consent",
> "payment_pages_checkout_session_consent_collection",
> "payment_pages_checkout_session_customer_details",
> "payment_pages_checkout_session_phone_number_collection",
> "payment_pages_checkout_session_shipping_address_collection",
> "payment_pages_checkout_session_shipping_cost",
> "payment_pages_checkout_session_shipping_option",
> "payment_pages_checkout_session_tax_id_collection",
> "payment_pages_checkout_session_total_details"
> ]
> }
4452a5429,5433
> "required": [
> "interval_description",
> "payment_schedule",
> "transaction_type"
> ],
4455c5436,5440
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MandateOptions",
> "in_class": "checkout_acss_debit_payment_method_options"
> }
4495c5480,5487
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "checkout_session_payment_method_options",
> "inner_classes": [
> "checkout_acss_debit_mandate_options"
> ]
> }
4510c5502,5506
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Affirm",
> "in_class": "checkout_session_payment_method_options"
> }
4525c5521,5525
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AfterpayClearpay",
> "in_class": "checkout_session_payment_method_options"
> }
4540c5540,5544
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Alipay",
> "in_class": "checkout_session_payment_method_options"
> }
4555c5559,5563
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AuBecsDebit",
> "in_class": "checkout_session_payment_method_options"
> }
4572c5580,5584
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebit",
> "in_class": "checkout_session_payment_method_options"
> }
4587c5599,5603
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Bancontact",
> "in_class": "checkout_session_payment_method_options"
> }
4611c5627,5631
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Boleto",
> "in_class": "checkout_session_payment_method_options"
> }
4623c5643,5647
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Installments",
> "in_class": "checkout_card_payment_method_options"
> }
4655c5679,5686
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "checkout_session_payment_method_options",
> "inner_classes": [
> "checkout_card_installments_options"
> ]
> }
4690a5722,5724
> "required": [
> "type"
> ],
4695c5729,5733
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BankTransfer",
> "in_class": "checkout_session_payment_method_options"
> }
4718a5757,5759
> "required": [
> "funding_type"
> ],
4723c5764,5768
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CustomerBalance",
> "in_class": "checkout_session_payment_method_options"
> }
4738c5783,5787
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Eps",
> "in_class": "checkout_session_payment_method_options"
> }
4753c5802,5806
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Fpx",
> "in_class": "checkout_session_payment_method_options"
> }
4768c5821,5825
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Giropay",
> "in_class": "checkout_session_payment_method_options"
> }
4783c5840,5844
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "GrabPay",
> "in_class": "checkout_session_payment_method_options"
> }
4798c5859,5863
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Ideal",
> "in_class": "checkout_session_payment_method_options"
> }
4815c5880,5884
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Klarna",
> "in_class": "checkout_session_payment_method_options"
> }
4832a5902,5904
> "required": [
> "expires_after_days"
> ],
4835c5907,5911
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Konbini",
> "in_class": "checkout_session_payment_method_options"
> }
4857c5933,5937
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Oxxo",
> "in_class": "checkout_session_payment_method_options"
> }
4872c5952,5956
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "P24",
> "in_class": "checkout_session_payment_method_options"
> }
4887c5971,5975
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Paynow",
> "in_class": "checkout_session_payment_method_options"
> }
4897a5986,5988
> "required": [
> "expires_after_seconds"
> ],
4900c5991,5995
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Pix",
> "in_class": "checkout_session_payment_method_options"
> }
4917c6012,6016
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "checkout_session_payment_method_options"
> }
5022c6121,6152
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodOptions",
> "in_class": "checkout.session",
> "inner_classes": [
> "checkout_acss_debit_payment_method_options",
> "checkout_affirm_payment_method_options",
> "checkout_afterpay_clearpay_payment_method_options",
> "checkout_alipay_payment_method_options",
> "checkout_au_becs_debit_payment_method_options",
> "checkout_bacs_debit_payment_method_options",
> "checkout_bancontact_payment_method_options",
> "checkout_boleto_payment_method_options",
> "checkout_card_payment_method_options",
> "checkout_customer_balance_bank_transfer_payment_method_options",
> "checkout_customer_balance_payment_method_options",
> "checkout_eps_payment_method_options",
> "checkout_fpx_payment_method_options",
> "checkout_giropay_payment_method_options",
> "checkout_grab_pay_payment_method_options",
> "checkout_ideal_payment_method_options",
> "checkout_klarna_payment_method_options",
> "checkout_konbini_payment_method_options",
> "checkout_oxxo_payment_method_options",
> "checkout_p24_payment_method_options",
> "checkout_paynow_payment_method_options",
> "checkout_pix_payment_method_options",
> "checkout_sepa_debit_payment_method_options",
> "checkout_sofort_payment_method_options",
> "checkout_us_bank_account_payment_method_options"
> ]
> }
5037c6167,6171
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Sofort",
> "in_class": "checkout_session_payment_method_options"
> }
5068c6202,6206
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "checkout_session_payment_method_options"
> }
5129c6267,6274
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ConnectCollectionTransfer",
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
5205c6350,6374
< "x-resourceId": "country_spec"
---
> "x-resourceId": "country_spec",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/country_specs"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/country_specs/{country}"
> }
> ],
> "x-stripeResource": {
> "class_name": "CountrySpec",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "country_spec_verification_fields"
> ]
> }
5233c6402,6406
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Details",
> "in_class": "country_spec_verification_fields"
> }
5254c6427,6434
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "VerificationFields",
> "in_class": "country_spec",
> "inner_classes": [
> "country_spec_verification_field_details"
> ]
> }
5355a6536
> "amount_off",
5356a6538
> "currency",
5357a6540
> "duration_in_months",
5359a6543,6545
> "max_redemptions",
> "metadata",
> "name",
5360a6547,6548
> "percent_off",
> "redeem_by",
5370c6558,6604
< "x-resourceId": "coupon"
---
> "x-resourceId": "coupon",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/coupons"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/coupons"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/coupons/{coupon}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/coupons/{coupon}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/coupons/{coupon}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Coupon",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "coupon_applies_to",
> "coupon_currency_option"
> ]
> }
5389c6623,6627
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AppliesTo",
> "in_class": "coupon"
> }
5404c6642,6646
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CurrencyOption",
> "in_class": "coupon"
> }
5665a6908
> "customer_balance_transaction",
5671a6915,6916
> "memo",
> "metadata",
5673a6919
> "out_of_band_amount",
5674a6921,6922
> "reason",
> "refund",
5676a6925
> "subtotal_excluding_tax",
5679c6928,6930
< "type"
---
> "total_excluding_tax",
> "type",
> "voided_at"
5692c6943,7002
< "x-resourceId": "credit_note"
---
> "x-resourceId": "credit_note",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/credit_notes"
> },
> {
> "method_name": "preview",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/credit_notes/preview"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/credit_notes/{id}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/credit_notes"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/credit_notes/{id}"
> },
> {
> "method_name": "void_credit_note",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/credit_notes/{id}/void"
> },
> {
> "method_name": "preview_lines",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/credit_notes/preview/lines"
> }
> ],
> "x-stripeResource": {
> "class_name": "CreditNote",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "credit_note_tax_amount"
> ]
> }
5790a7101,7102
> "amount_excluding_tax",
> "description",
5795a7108
> "quantity",
5798c7111,7114
< "type"
---
> "type",
> "unit_amount",
> "unit_amount_decimal",
> "unit_amount_excluding_tax"
5807c7123,7144
< "x-resourceId": "credit_note_line_item"
---
> "x-resourceId": "credit_note_line_item",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/credit_notes/{credit_note}/lines"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/credit_notes/{credit_note}/lines"
> }
> ],
> "x-stripeResource": {
> "class_name": "CreditNoteLineItem",
> "has_collection_class": true,
> "in_package": ""
> }
5849c7186,7190
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TaxAmount",
> "in_class": "credit_note"
> }
5891a7233,7238
> "required": [
> "custom_unit_amount",
> "tax_behavior",
> "unit_amount",
> "unit_amount_decimal"
> ],
5897c7244,7248
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CurrencyOption",
> "in_class": "price"
> }
5917a7269,7273
> "required": [
> "maximum",
> "minimum",
> "preset"
> ],
5920c7276,7280
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CustomUnitAmount",
> "in_class": "price"
> }
5965,5971c7325
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
---
> "$ref": "#/components/schemas/payment_source"
5979,5985c7333
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
---
> "$ref": "#/components/schemas/payment_source"
5988,5989c7336
< },
< "x-stripeBypassValidation": true
---
> }
6097,6109c7444
< "anyOf": [
< {
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
< }
< ],
< "title": "Polymorphic",
< "x-stripeBypassValidation": true
---
> "$ref": "#/components/schemas/payment_source"
6255a7591,7593
> "default_source",
> "description",
> "email",
6258c7596,7597
< "object"
---
> "object",
> "shipping"
6275c7614,7710
< "x-resourceId": "customer"
---
> "x-resourceId": "customer",
> "x-stripeOperations": [
> {
> "method_name": "search",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/customers/search"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/customers"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/customers/{customer}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/customers/{customer}"
> },
> {
> "method_name": "list_payment_methods",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/customers/{customer}/payment_methods"
> },
> {
> "method_name": "retrieve_payment_method",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/customers/{customer}/payment_methods/{payment_method}"
> },
> {
> "method_name": "balance_transactions",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/customers/{customer}/balance_transactions"
> },
> {
> "method_name": "fund_cash_balance",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/customers/{customer}/fund_cash_balance"
> },
> {
> "method_name": "create_funding_instructions",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/customers/{customer}/funding_instructions"
> },
> {
> "method_name": "delete_discount",
> "method_on": "service",
> "method_type": "custom",
> "operation": "delete",
> "path": "/v1/customers/{customer}/discount"
> }
> ],
> "x-stripeResource": {
> "class_name": "Customer",
> "has_collection_class": true,
> "has_search_result_class": true,
> "in_package": "",
> "inner_classes": [
> "customer_tax",
> "invoice_setting_customer_setting"
> ]
> }
6301a7737
> "accepted_at",
6309c7745,7753
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CustomerAcceptance",
> "in_class": "mandate",
> "inner_classes": [
> "offline_acceptance",
> "online_acceptance"
> ]
> }
6328c7772,7776
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BalanceSettings",
> "in_class": "cash_balance"
> }
6360c7808,7812
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AppliedToPayment",
> "in_class": "customer_cash_balance_transaction"
> }
6376c7828,7835
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Funded",
> "in_class": "customer_cash_balance_transaction",
> "inner_classes": [
> "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
> ]
> }
6402a7862
> "reference",
6409c7869,7876
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BankTransfer",
> "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction",
> "inner_classes": [
> "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer"
> ]
> }
6432a7900,7904
> "required": [
> "bic",
> "iban_last4",
> "sender_name"
> ],
6435c7907,7911
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EuBankTransfer",
> "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
> }
6467c7943,7947
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "RefundedFromPayment",
> "in_class": "customer_cash_balance_transaction"
> }
6499c7979,7983
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "UnappliedFromPayment",
> "in_class": "customer_cash_balance_transaction"
> }
6629a8114
> "credit_note",
6631a8117
> "description",
6633a8120
> "invoice",
6634a8122
> "metadata",
6645c8133,8189
< "x-resourceId": "customer_balance_transaction"
---
> "x-resourceId": "customer_balance_transaction",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/balance_transactions/{transaction}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/balance_transactions/{transaction}"
> },
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/balance_transactions"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/balance_transactions"
> },
> {
> "method_name": "create",
> "method_on": "collection",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/customers/{customer}/balance_transactions"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/customers/{customer}/balance_transactions"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/customers/{customer}/balance_transactions/{transaction}"
> }
> ],
> "x-stripeResource": {
> "class_name": "CustomerBalanceTransaction",
> "has_collection_class": true,
> "in_package": ""
> }
6748c8292,8333
< "x-resourceId": "customer_cash_balance_transaction"
---
> "x-resourceId": "customer_cash_balance_transaction",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}"
> },
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/cash_balance_transactions"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/cash_balance_transactions"
> }
> ],
> "x-stripeResource": {
> "class_name": "CustomerCashBalanceTransaction",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction",
> "customer_balance_resource_cash_balance_transaction_resource_funded_transaction",
> "customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction",
> "customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"
> ]
> }
6780c8365,8367
< "automatic_tax"
---
> "automatic_tax",
> "ip_address",
> "location"
6786c8373,8380
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Tax",
> "in_class": "customer",
> "inner_classes": [
> "customer_tax_location"
> ]
> }
6815c8409,8410
< "source"
---
> "source",
> "state"
6819c8414,8418
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Location",
> "in_class": "customer_tax"
> }
6852c8451,8455
< "x-resourceId": "deleted_account"
---
> "x-resourceId": "deleted_account",
> "x-stripeResource": {
> "class_name": "DeletedAccount",
> "in_package": ""
> }
6885c8488,8492
< "x-resourceId": "deleted_apple_pay_domain"
---
> "x-resourceId": "deleted_apple_pay_domain",
> "x-stripeResource": {
> "class_name": "DeletedApplePayDomain",
> "in_package": ""
> }
6918a8526
> "name",
6923c8531,8535
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DeletedApplication",
> "in_package": ""
> }
6961c8573,8577
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DeletedBankAccount",
> "in_package": ""
> }
6999c8615,8619
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DeletedCard",
> "in_package": ""
> }
7032c8652,8656
< "x-resourceId": "deleted_coupon"
---
> "x-resourceId": "deleted_coupon",
> "x-stripeResource": {
> "class_name": "DeletedCoupon",
> "in_package": ""
> }
7065c8689,8693
< "x-resourceId": "deleted_customer"
---
> "x-resourceId": "deleted_customer",
> "x-stripeResource": {
> "class_name": "DeletedCustomer",
> "in_package": ""
> }
7168a8797
> "checkout_session",
7169a8799
> "customer",
7171a8802,8803
> "invoice",
> "invoice_item",
7173c8805,8807
< "start"
---
> "promotion_code",
> "start",
> "subscription"
7182c8816,8820
< "x-resourceId": "deleted_discount"
---
> "x-resourceId": "deleted_discount",
> "x-stripeResource": {
> "class_name": "DeletedDiscount",
> "in_package": ""
> }
7195c8833,8836
< "x-stripeBypassValidation": true
---
> "x-stripeBypassValidation": true,
> "x-stripeResource": {
> "class_name": "DeletedExternalAccount"
> }
7228c8869,8873
< "x-resourceId": "deleted_invoice"
---
> "x-resourceId": "deleted_invoice",
> "x-stripeResource": {
> "class_name": "DeletedInvoice",
> "in_package": ""
> }
7261c8906,8910
< "x-resourceId": "deleted_invoiceitem"
---
> "x-resourceId": "deleted_invoiceitem",
> "x-stripeResource": {
> "class_name": "DeletedInvoiceItem",
> "in_package": ""
> }
7274c8923,8926
< "x-stripeBypassValidation": true
---
> "x-stripeBypassValidation": true,
> "x-stripeResource": {
> "class_name": "DeletedPaymentSource"
> }
7307c8959,8963
< "x-resourceId": "deleted_person"
---
> "x-resourceId": "deleted_person",
> "x-stripeResource": {
> "class_name": "DeletedPerson",
> "in_package": ""
> }
7340c8996,9000
< "x-resourceId": "deleted_plan"
---
> "x-resourceId": "deleted_plan",
> "x-stripeResource": {
> "class_name": "DeletedPlan",
> "in_package": ""
> }
7372c9032,9036
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DeletedPrice",
> "in_package": ""
> }
7405c9069,9073
< "x-resourceId": "deleted_product"
---
> "x-resourceId": "deleted_product",
> "x-stripeResource": {
> "class_name": "DeletedProduct",
> "in_package": ""
> }
7438c9106,9110
< "x-resourceId": "deleted_radar.value_list"
---
> "x-resourceId": "deleted_radar.value_list",
> "x-stripeResource": {
> "class_name": "DeletedValueList",
> "in_package": "Radar"
> }
7471c9143,9147
< "x-resourceId": "deleted_radar.value_list_item"
---
> "x-resourceId": "deleted_radar.value_list_item",
> "x-stripeResource": {
> "class_name": "DeletedValueListItem",
> "in_package": "Radar"
> }
7504c9180,9184
< "x-resourceId": "deleted_sku"
---
> "x-resourceId": "deleted_sku",
> "x-stripeResource": {
> "class_name": "DeletedSku",
> "in_package": ""
> }
7537c9217,9221
< "x-resourceId": "deleted_subscription_item"
---
> "x-resourceId": "deleted_subscription_item",
> "x-stripeResource": {
> "class_name": "DeletedSubscriptionItem",
> "in_package": ""
> }
7570c9254,9258
< "x-resourceId": "deleted_tax_id"
---
> "x-resourceId": "deleted_tax_id",
> "x-stripeResource": {
> "class_name": "DeletedTaxId",
> "in_package": ""
> }
7603c9291,9295
< "x-resourceId": "deleted_terminal.configuration"
---
> "x-resourceId": "deleted_terminal.configuration",
> "x-stripeResource": {
> "class_name": "DeletedConfiguration",
> "in_package": "Terminal"
> }
7636c9328,9332
< "x-resourceId": "deleted_terminal.location"
---
> "x-resourceId": "deleted_terminal.location",
> "x-stripeResource": {
> "class_name": "DeletedLocation",
> "in_package": "Terminal"
> }
7669c9365,9369
< "x-resourceId": "deleted_terminal.reader"
---
> "x-resourceId": "deleted_terminal.reader",
> "x-stripeResource": {
> "class_name": "DeletedReader",
> "in_package": "Terminal"
> }
7702c9402,9406
< "x-resourceId": "deleted_test_helpers.test_clock"
---
> "x-resourceId": "deleted_test_helpers.test_clock",
> "x-stripeResource": {
> "class_name": "DeletedTestClock",
> "in_package": "TestHelpers"
> }
7735c9439,9443
< "x-resourceId": "deleted_webhook_endpoint"
---
> "x-resourceId": "deleted_webhook_endpoint",
> "x-stripeResource": {
> "class_name": "DeletedWebhookEndpoint",
> "in_package": ""
> }
7837a9546
> "checkout_session",
7838a9548,9549
> "customer",
> "end",
7839a9551,9552
> "invoice",
> "invoice_item",
7841c9554,9556
< "start"
---
> "promotion_code",
> "start",
> "subscription"
7850c9565,9568
< "x-resourceId": "discount"
---
> "x-stripeResource": {
> "class_name": "Discount",
> "in_package": ""
> }
7893c9611,9615
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "DiscountAmount",
> "in_package": ""
> }
7963a9686,9691
> "network_reason_code": {
> "description": "Network-dependent reason code for the dispute.",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
8023a9752
> "payment_intent",
8036c9765,9807
< "x-resourceId": "dispute"
---
> "x-resourceId": "dispute",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/disputes"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/disputes/{dispute}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/disputes/{dispute}"
> },
> {
> "method_name": "close",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/disputes/{dispute}/close"
> }
> ],
> "x-stripeResource": {
> "class_name": "Dispute",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "dispute_evidence",
> "dispute_evidence_details"
> ],
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
8329a10101,10129
> "required": [
> "access_activity_log",
> "billing_address",
> "cancellation_policy",
> "cancellation_policy_disclosure",
> "cancellation_rebuttal",
> "customer_communication",
> "customer_email_address",
> "customer_name",
> "customer_purchase_ip",
> "customer_signature",
> "duplicate_charge_documentation",
> "duplicate_charge_explanation",
> "duplicate_charge_id",
> "product_description",
> "receipt",
> "refund_policy",
> "refund_policy_disclosure",
> "refund_refusal_explanation",
> "service_date",
> "service_documentation",
> "shipping_address",
> "shipping_carrier",
> "shipping_date",
> "shipping_documentation",
> "shipping_tracking_number",
> "uncategorized_file",
> "uncategorized_text"
> ],
8342c10142,10146
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Evidence",
> "in_class": "dispute"
> }
8366a10171
> "due_by",
8373c10178,10182
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EvidenceDetails",
> "in_class": "dispute"
> }
8395c10204,10208
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EmailSent",
> "in_class": "refund_next_action_display_details"
> }
8442c10255,10275
< "x-resourceId": "ephemeral_key"
---
> "x-resourceId": "ephemeral_key",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/ephemeral_keys"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/ephemeral_keys/{key}"
> }
> ],
> "x-stripeResource": {
> "class_name": "EphemeralKey",
> "in_package": ""
> }
8454c10287,10291
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "StripeErrorResponse",
> "in_package": ""
> }
8513a10351
> "api_version",
8519a10358
> "request",
8528c10367,10388
< "x-resourceId": "event"
---
> "x-resourceId": "event",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/events"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/events/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Event",
> "has_collection_class": true,
> "in_package": ""
> }
8561c10421,10442
< "x-resourceId": "exchange_rate"
---
> "x-resourceId": "exchange_rate",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/exchange_rates"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/exchange_rates/{rate_id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ExchangeRate",
> "has_collection_class": true,
> "in_package": ""
> }
8574c10455,10517
< "x-stripeBypassValidation": true
---
> "x-stripeBypassValidation": true,
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/accounts/{account}/external_accounts"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/accounts/{account}/external_accounts"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> },
> {
> "method_name": "create",
> "method_on": "collection",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/accounts/{account}/external_accounts"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/accounts/{account}/external_accounts"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/accounts/{account}/external_accounts/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ExternalAccount",
> "has_collection_class": true
> }
8606a10550
> "application",
8607a10552
> "description",
8612c10557,10561
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Fee",
> "in_class": "balance_transaction"
> }
8692a10642
> "balance_transaction",
8696a10647
> "metadata",
8705c10656,10715
< "x-resourceId": "fee_refund"
---
> "x-resourceId": "fee_refund",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "collection",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/application_fees/{id}/refunds"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/application_fees/{id}/refunds"
> },
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/application_fees/{id}/refunds"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/application_fees/{id}/refunds"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/application_fees/{fee}/refunds/{id}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/application_fees/{fee}/refunds/{id}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/application_fees/{fee}/refunds/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "FeeRefund",
> "has_collection_class": true,
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
8826a10837,10838
> "expires_at",
> "filename",
8830c10842,10845
< "size"
---
> "size",
> "title",
> "type",
> "url"
8837c10852,10880
< "x-resourceId": "file"
---
> "x-resourceId": "file",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/files"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/files/{file}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/files"
> }
> ],
> "x-stripeResource": {
> "class_name": "File",
> "has_collection_class": true,
> "in_package": ""
> }
8909a10953
> "expires_at",
8914c10958,10959
< "object"
---
> "object",
> "url"
8921c10966,11001
< "x-resourceId": "file_link"
---
> "x-resourceId": "file_link",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/file_links/{link}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/file_links"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/file_links/{link}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/file_links"
> }
> ],
> "x-stripeResource": {
> "class_name": "FileLink",
> "has_collection_class": true,
> "in_package": ""
> }
9077a11158,11160
> "account_holder",
> "balance",
> "balance_refresh",
9079a11163
> "display_name",
9081a11166
> "last4",
9083a11169,11171
> "ownership",
> "ownership_refresh",
> "permissions",
9097c11185,11233
< "x-resourceId": "financial_connections.account"
---
> "x-resourceId": "financial_connections.account",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/financial_connections/accounts"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/financial_connections/accounts/{account}"
> },
> {
> "method_name": "list_owners",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/financial_connections/accounts/{account}/owners"
> },
> {
> "method_name": "refresh",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/financial_connections/accounts/{account}/refresh"
> },
> {
> "method_name": "disconnect",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/financial_connections/accounts/{account}/disconnect"
> }
> ],
> "x-stripeResource": {
> "class_name": "Account",
> "has_collection_class": true,
> "in_package": "FinancialConnections",
> "inner_classes": [
> "bank_connections_resource_accountholder",
> "bank_connections_resource_balance",
> "bank_connections_resource_balance_refresh",
> "bank_connections_resource_ownership_refresh"
> ]
> }
9149a11286
> "email",
9153c11290,11293
< "ownership"
---
> "ownership",
> "phone",
> "raw_address",
> "refreshed_at"
9158c11298,11303
< "x-resourceId": "financial_connections.account_owner"
---
> "x-resourceId": "financial_connections.account_owner",
> "x-stripeResource": {
> "class_name": "AccountOwner",
> "has_collection_class": true,
> "in_package": "FinancialConnections"
> }
9230c11375,11379
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AccountOwnership",
> "in_package": "FinancialConnections"
> }
9328a11478
> "account_holder",
9343c11493,11516
< "x-resourceId": "financial_connections.session"
---
> "x-resourceId": "financial_connections.session",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/financial_connections/sessions"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/financial_connections/sessions/{session}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Session",
> "in_package": "FinancialConnections",
> "inner_classes": [
> "bank_connections_resource_link_account_session_filters"
> ]
> }
9393c11566,11570
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Parameters",
> "in_class": "reporting.report_run"
> }
9437c11614,11621
< "x-resourceId": "funding_instructions"
---
> "x-resourceId": "funding_instructions",
> "x-stripeResource": {
> "class_name": "FundingInstructions",
> "in_package": "",
> "inner_classes": [
> "funding_instructions_bank_transfer"
> ]
> }
9473c11657,11664
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BankTransfer",
> "in_class": "funding_instructions",
> "inner_classes": [
> "funding_instructions_bank_transfer_financial_address"
> ]
> }
9527c11718,11728
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FinancialAddress",
> "in_class": "funding_instructions_bank_transfer",
> "inner_classes": [
> "funding_instructions_bank_transfer_iban_record",
> "funding_instructions_bank_transfer_sort_code_record",
> "funding_instructions_bank_transfer_spei_record",
> "funding_instructions_bank_transfer_zengin_record"
> ]
> }
9561c11762,11766
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Iban",
> "in_class": "funding_instructions_bank_transfer_financial_address"
> }
9589c11794,11798
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SortCode",
> "in_class": "funding_instructions_bank_transfer_financial_address"
> }
9617c11826,11830
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Spei",
> "in_class": "funding_instructions_bank_transfer_financial_address"
> }
9664a11878,11886
> "required": [
> "account_holder_name",
> "account_number",
> "account_type",
> "bank_code",
> "bank_name",
> "branch_code",
> "branch_name"
> ],
9667c11889,11893
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Zengin",
> "in_class": "funding_instructions_bank_transfer_financial_address"
> }
9687a11914,11918
> "required": [
> "day",
> "month",
> "year"
> ],
9690c11921,11925
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DateOfBirth",
> "in_class": "gelato_document_report"
> }
9710a11946,11950
> "required": [
> "day",
> "month",
> "year"
> ],
9713c11953,11957
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ExpirationDate",
> "in_class": "gelato_document_report"
> }
9733a11978,11982
> "required": [
> "day",
> "month",
> "year"
> ],
9736c11985,11989
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "IssuedDate",
> "in_class": "gelato_document_report"
> }
9756a12010,12014
> "required": [
> "day",
> "month",
> "year"
> ],
9759c12017,12021
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DateOfBirth",
> "in_class": "gelato_id_number_report"
> }
9779a12042,12046
> "required": [
> "day",
> "month",
> "year"
> ],
9782c12049,12053
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DateOfBirth",
> "in_class": "gelato_verified_outputs"
> }
9886c12157,12168
< "status"
---
> "address",
> "dob",
> "error",
> "expiration_date",
> "files",
> "first_name",
> "issued_date",
> "issuing_country",
> "last_name",
> "number",
> "status",
> "type"
9896c12178,12188
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Document",
> "in_class": "identity.verification_report",
> "inner_classes": [
> "gelato_data_document_report_date_of_birth",
> "gelato_data_document_report_expiration_date",
> "gelato_data_document_report_issued_date",
> "gelato_document_report_error"
> ]
> }
9917a12210,12213
> "required": [
> "code",
> "reason"
> ],
9920c12216,12220
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DocumentCheckError",
> "in_class": "gelato_document_report"
> }
9981a12282,12287
> "dob",
> "error",
> "first_name",
> "id_number",
> "id_number_type",
> "last_name",
9989c12295,12303
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "IdNumber",
> "in_class": "identity.verification_report",
> "inner_classes": [
> "gelato_data_id_number_report_date",
> "gelato_id_number_report_error"
> ]
> }
10010a12325,12328
> "required": [
> "code",
> "reason"
> ],
10013c12331,12335
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "IdNumberCheckError",
> "in_class": "gelato_id_number_report"
> }
10045c12367,12371
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Document",
> "in_class": "gelato_verification_report_options"
> }
10052c12378,12382
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "IdNumber",
> "in_class": "gelato_verification_report_options"
> }
10088a12419,12421
> "document",
> "error",
> "selfie",
10095c12428,12435
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Selfie",
> "in_class": "identity.verification_report",
> "inner_classes": [
> "gelato_selfie_report_error"
> ]
> }
10117a12458,12461
> "required": [
> "code",
> "reason"
> ],
10120c12464,12468
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SelfieCheckError",
> "in_class": "gelato_selfie_report"
> }
10152c12500,12504
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Document",
> "in_class": "gelato_verification_session_options"
> }
10159c12511,12515
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "IdNumber",
> "in_class": "gelato_verification_session_options"
> }
10193a12550,12553
> "required": [
> "code",
> "reason"
> ],
10196c12556,12560
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "LastError",
> "in_class": "identity.verification_session"
> }
10213c12577,12585
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Options",
> "in_class": "identity.verification_report",
> "inner_classes": [
> "gelato_report_document_options",
> "gelato_report_id_number_options"
> ]
> }
10230c12602,12610
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Options",
> "in_class": "identity.verification_session",
> "inner_classes": [
> "gelato_session_document_options",
> "gelato_session_id_number_options"
> ]
> }
10281a12662,12669
> "required": [
> "address",
> "dob",
> "first_name",
> "id_number",
> "id_number_type",
> "last_name"
> ],
10287c12675,12682
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "VerifiedOutputs",
> "in_class": "identity.verification_session",
> "inner_classes": [
> "gelato_data_verified_outputs_date"
> ]
> }
10347c12742,12743
< "type"
---
> "type",
> "verification_session"
10357c12753,12780
< "x-resourceId": "identity.verification_report"
---
> "x-resourceId": "identity.verification_report",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/identity/verification_reports/{report}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/identity/verification_reports"
> }
> ],
> "x-stripeResource": {
> "class_name": "VerificationReport",
> "has_collection_class": true,
> "in_package": "Identity",
> "inner_classes": [
> "gelato_document_report",
> "gelato_id_number_report",
> "gelato_selfie_report",
> "gelato_verification_report_options"
> ]
> }
10473a12897
> "client_secret",
10475a12900,12901
> "last_error",
> "last_verification_report",
10479a12906
> "redaction",
10481c12908,12910
< "type"
---
> "type",
> "url",
> "verified_outputs"
10492c12921,12976
< "x-resourceId": "identity.verification_session"
---
> "x-resourceId": "identity.verification_session",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/identity/verification_sessions"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/identity/verification_sessions/{session}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/identity/verification_sessions"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/identity/verification_sessions/{session}/cancel"
> },
> {
> "method_name": "redact",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/identity/verification_sessions/{session}/redact"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/identity/verification_sessions/{session}"
> }
> ],
> "x-stripeResource": {
> "class_name": "VerificationSession",
> "has_collection_class": true,
> "in_package": "Identity",
> "inner_classes": [
> "gelato_session_last_error",
> "gelato_verification_session_options",
> "gelato_verified_outputs",
> "verification_session_redaction"
> ]
> }
10521c13005,13012
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "OriginPaymentMethodDetails",
> "in_class": "treasury.inbound_transfer",
> "inner_classes": [
> "inbound_transfers_payment_method_details_us_bank_account"
> ]
> }
10577c13068,13074
< "network"
---
> "account_holder_type",
> "account_type",
> "bank_name",
> "fingerprint",
> "last4",
> "network",
> "routing_number"
10581c13078,13082
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "inbound_transfers"
> }
10853,10859c13354
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
---
> "$ref": "#/components/schemas/payment_source"
10867,10873c13362
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
---
> "$ref": "#/components/schemas/payment_source"
10876,10877c13365
< },
< "x-stripeBypassValidation": true
---
> }
11304a13793,13795
> "account_country",
> "account_name",
> "account_tax_ids",
11307a13799,13800
> "application",
> "application_fee_amount",
11310a13804,13805
> "billing_reason",
> "charge",
11313a13809,13818
> "custom_fields",
> "customer",
> "customer_address",
> "customer_email",
> "customer_name",
> "customer_phone",
> "customer_shipping",
> "customer_tax_exempt",
> "default_payment_method",
> "default_source",
11314a13820,13828
> "description",
> "discount",
> "discounts",
> "due_date",
> "ending_balance",
> "footer",
> "from_invoice",
> "last_finalization_error",
> "latest_revision",
11316a13831,13833
> "metadata",
> "next_payment_attempt",
> "number",
11317a13835
> "on_behalf_of",
11319a13838
> "payment_intent",
11324a13844,13846
> "quote",
> "receipt_number",
> "rendering_options",
11325a13848,13849
> "statement_descriptor",
> "status",
11326a13851
> "subscription",
11327a13853,13855
> "subtotal_excluding_tax",
> "tax",
> "test_clock",
11329c13857,13861
< "total_tax_amounts"
---
> "total_discount_amounts",
> "total_excluding_tax",
> "total_tax_amounts",
> "transfer_data",
> "webhooks_delivered_at"
11365c13897,14010
< "x-resourceId": "invoice"
---
> "x-resourceId": "invoice",
> "x-stripeOperations": [
> {
> "method_name": "search",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/invoices/search"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/invoices"
> },
> {
> "method_name": "upcoming",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/invoices/upcoming"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/invoices"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/invoices/{invoice}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/invoices/{invoice}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/invoices/{invoice}"
> },
> {
> "method_name": "pay",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/invoices/{invoice}/pay"
> },
> {
> "method_name": "finalize_invoice",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/invoices/{invoice}/finalize"
> },
> {
> "method_name": "upcomingLines",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/invoices/upcoming/lines"
> },
> {
> "method_name": "send_invoice",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/invoices/{invoice}/send"
> },
> {
> "method_name": "mark_uncollectible",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/invoices/{invoice}/mark_uncollectible"
> },
> {
> "method_name": "void_invoice",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/invoices/{invoice}/void"
> }
> ],
> "x-stripeResource": {
> "class_name": "Invoice",
> "has_collection_class": true,
> "has_search_result_class": true,
> "in_package": "",
> "inner_classes": [
> "automatic_tax",
> "invoice_item_threshold_reason",
> "invoice_setting_custom_field",
> "invoice_setting_rendering_options",
> "invoice_tax_amount",
> "invoice_threshold_reason",
> "invoice_transfer_data",
> "invoices_from_invoice",
> "invoices_payment_method_options",
> "invoices_payment_settings",
> "invoices_resource_invoice_tax_id",
> "invoices_status_transitions"
> ]
> }
11375a14021,14023
> "required": [
> "enabled"
> ],
11378c14026,14030
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Installments",
> "in_class": "invoice_payment_method_options_card"
> }
11402c14054,14058
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ThresholdItemReason",
> "in_class": "invoice"
> }
11424c14080,14084
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "InvoiceLineItemPeriod",
> "in_package": ""
> }
11449a14110,14114
> "required": [
> "amount",
> "amount_type",
> "description"
> ],
11452c14117,14121
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MandateOptions",
> "in_class": "subscription_payment_method_options_card"
> }
11475c14144,14151
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "invoices_payment_method_options",
> "inner_classes": [
> "invoice_payment_method_options_acss_debit_mandate_options"
> ]
> }
11489a14166,14168
> "required": [
> "transaction_type"
> ],
11492c14171,14175
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MandateOptions",
> "in_class": "invoice_payment_method_options_acss_debit"
> }
11513c14196,14200
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Bancontact",
> "in_class": "invoices_payment_method_options"
> }
11530a14218,14220
> "required": [
> "request_three_d_secure"
> ],
11535c14225,14232
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "invoices_payment_method_options",
> "inner_classes": [
> "invoice_installments_card"
> ]
> }
11551a14249,14251
> "required": [
> "funding_type"
> ],
11556c14256,14263
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CustomerBalance",
> "in_class": "invoices_payment_method_options",
> "inner_classes": [
> "invoice_payment_method_options_customer_balance_bank_transfer"
> ]
> }
11569a14277,14279
> "required": [
> "type"
> ],
11574c14284,14291
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BankTransfer",
> "in_class": "invoice_payment_method_options_customer_balance",
> "inner_classes": [
> "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"
> ]
> }
11596c14313,14317
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EuBankTransfer",
> "in_class": "invoice_payment_method_options_customer_balance_bank_transfer"
> }
11603c14324,14328
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Konbini",
> "in_class": "invoices_payment_method_options"
> }
11626c14351,14358
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "invoices_payment_method_options",
> "inner_classes": [
> "invoice_payment_method_options_us_bank_account_linked_account_options"
> ]
> }
11647c14379,14383
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "FinancialConnections",
> "in_class": "invoice_payment_method_options_us_bank_account"
> }
11669c14405,14409
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CustomField",
> "in_class": "invoice"
> }
11717a14458,14463
> "required": [
> "custom_fields",
> "default_payment_method",
> "footer",
> "rendering_options"
> ],
11724c14470,14474
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "InvoiceSettings",
> "in_class": "customer"
> }
11734a14485,14487
> "required": [
> "days_until_due"
> ],
11737c14490,14494
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "InvoiceSettings",
> "in_class": "quote"
> }
11748a14506,14508
> "required": [
> "amount_tax_display"
> ],
11751c14511,14515
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "RenderingOptions",
> "in_class": "invoice"
> }
11761a14526,14528
> "required": [
> "days_until_due"
> ],
11764c14531,14535
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "InvoiceSettings",
> "in_class": "subscription_schedule"
> }
11806c14577,14581
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TaxAmount",
> "in_class": "invoice"
> }
11824a14600
> "amount_gte",
11831c14607,14611
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ThresholdReason",
> "in_class": "invoice"
> }
11861a14642
> "amount",
11868c14649,14653
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TransferData",
> "in_class": "invoice"
> }
11991a14777,14785
> "plan": {
> "anyOf": [
> {
> "$ref": "#/components/schemas/plan"
> }
> ],
> "description": "If the invoice item is a proration, the plan of the subscription that the proration was computed for.",
> "nullable": true
> },
12078a14873
> "description",
12079a14875
> "discounts",
12080a14877
> "invoice",
12081a14879
> "metadata",
12083a14882,14883
> "plan",
> "price",
12085c14885,14890
< "quantity"
---
> "quantity",
> "subscription",
> "tax_rates",
> "test_clock",
> "unit_amount",
> "unit_amount_decimal"
12093a14899
> "plan",
12099c14905,14947
< "x-resourceId": "invoiceitem"
---
> "x-resourceId": "invoiceitem",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/invoiceitems"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/invoiceitems"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/invoiceitems/{invoiceitem}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/invoiceitems/{invoiceitem}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/invoiceitems/{invoiceitem}"
> }
> ],
> "x-stripeResource": {
> "class_name": "InvoiceItem",
> "has_collection_class": true,
> "in_package": ""
> }
12137c14985,14989
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FromInvoice",
> "in_class": "invoice"
> }
12162c15014,15018
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CreditedItems",
> "in_package": ""
> }
12176a15033,15035
> "required": [
> "credited_items"
> ],
12181c15040,15044
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ProrationDetails",
> "in_package": ""
> }
12240a15104,15111
> "required": [
> "acss_debit",
> "bancontact",
> "card",
> "customer_balance",
> "konbini",
> "us_bank_account"
> ],
12250c15121,15133
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodOptions",
> "in_class": "invoice",
> "inner_classes": [
> "invoice_payment_method_options_acss_debit",
> "invoice_payment_method_options_bancontact",
> "invoice_payment_method_options_card",
> "invoice_payment_method_options_customer_balance",
> "invoice_payment_method_options_konbini",
> "invoice_payment_method_options_us_bank_account"
> ]
> }
12290a15174
> "sepa_credit_transfer",
12302a15187,15191
> "required": [
> "default_mandate",
> "payment_method_options",
> "payment_method_types"
> ],
12307c15196,15200
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentSettings",
> "in_class": "invoice"
> }
12378c15271,15272
< "type"
---
> "type",
> "value"
12382c15276,15280
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CustomerTaxId",
> "in_class": "invoice"
> }
12411a15310,15315
> "required": [
> "finalized_at",
> "marked_uncollectible_at",
> "paid_at",
> "voided_at"
> ],
12414c15318,15322
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "invoice"
> }
12582a15491
> "amount_details",
12586a15496
> "cardholder",
12594a15505
> "network_data",
12595a15507
> "pending_request",
12599c15511,15512
< "verification_data"
---
> "verification_data",
> "wallet"
12616c15529,15583
< "x-resourceId": "issuing.authorization"
---
> "x-resourceId": "issuing.authorization",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/issuing/authorizations"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/issuing/authorizations/{authorization}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/issuing/authorizations/{authorization}"
> },
> {
> "method_name": "approve",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/issuing/authorizations/{authorization}/approve"
> },
> {
> "method_name": "decline",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/issuing/authorizations/{authorization}/decline"
> }
> ],
> "x-stripeResource": {
> "class_name": "Authorization",
> "has_collection_class": true,
> "in_package": "Issuing",
> "inner_classes": [
> "issuing_authorization_amount_details",
> "issuing_authorization_merchant_data",
> "issuing_authorization_network_data",
> "issuing_authorization_pending_request",
> "issuing_authorization_request",
> "issuing_authorization_treasury",
> "issuing_authorization_verification_data"
> ],
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
12794a15762
> "cancellation_reason",
12804a15773,15776
> "replaced_by",
> "replacement_for",
> "replacement_reason",
> "shipping",
12807c15779,15780
< "type"
---
> "type",
> "wallets"
12819c15792,15860
< "x-resourceId": "issuing.card"
---
> "x-resourceId": "issuing.card",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/issuing/cards"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/issuing/cards"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/issuing/cards/{card}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/issuing/cards/{card}"
> },
> {
> "method_name": "deliver_card",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/issuing/cards/{card}/shipping/deliver"
> },
> {
> "method_name": "ship_card",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/issuing/cards/{card}/shipping/ship"
> },
> {
> "method_name": "return_card",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/issuing/cards/{card}/shipping/return"
> },
> {
> "method_name": "fail_card",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/issuing/cards/{card}/shipping/fail"
> }
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "has_collection_class": true,
> "in_package": "Issuing",
> "inner_classes": [
> "issuing_card_authorization_controls",
> "issuing_card_shipping",
> "issuing_card_wallets"
> ]
> }
12923a15965
> "company",
12924a15967
> "email",
12925a15969
> "individual",
12929a15974
> "phone_number",
12930a15976
> "spending_controls",
12943c15989,16031
< "x-resourceId": "issuing.cardholder"
---
> "x-resourceId": "issuing.cardholder",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/issuing/cardholders"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/issuing/cardholders"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/issuing/cardholders/{cardholder}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/issuing/cardholders/{cardholder}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Cardholder",
> "has_collection_class": true,
> "in_package": "Issuing",
> "inner_classes": [
> "issuing_cardholder_address",
> "issuing_cardholder_authorization_controls",
> "issuing_cardholder_company",
> "issuing_cardholder_individual",
> "issuing_cardholder_requirements"
> ]
> }
13037a16126
> "balance_transactions",
13056,13162c16145,16194
< "x-resourceId": "issuing.dispute"
< },
< "issuing.settlement": {
< "description": "When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.",
< "properties": {
< "bin": {
< "description": "The Bank Identification Number reflecting this settlement record.",
< "maxLength": 5000,
< "type": "string"
< },
< "clearing_date": {
< "description": "The date that the transactions are cleared and posted to user's accounts.",
< "type": "integer"
< },
< "created": {
< "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
< "format": "unix-time",
< "type": "integer"
< },
< "currency": {
< "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
< "type": "string"
< },
< "id": {
< "description": "Unique identifier for the object.",
< "maxLength": 5000,
< "type": "string"
< },
< "interchange_fees": {
< "description": "The total interchange received as reimbursement for the transactions.",
< "type": "integer"
< },
< "livemode": {
< "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
< "type": "boolean"
< },
< "metadata": {
< "additionalProperties": {
< "maxLength": 500,
< "type": "string"
< },
< "description": "Set of [key-value pairs](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.",
< "type": "object"
< },
< "net_total": {
< "description": "The total net amount required to settle with the network.",
< "type": "integer"
< },
< "network": {
< "description": "The card network for this settlement report. One of [\"visa\"]",
< "enum": [
< "visa"
< ],
< "type": "string"
< },
< "network_fees": {
< "description": "The total amount of fees owed to the network.",
< "type": "integer"
< },
< "network_settlement_identifier": {
< "description": "The Settlement Identification Number assigned by the network.",
< "maxLength": 5000,
< "type": "string"
< },
< "object": {
< "description": "String representing the object's type. Objects of the same type share the same value.",
< "enum": [
< "issuing.settlement"
< ],
< "type": "string"
< },
< "settlement_service": {
< "description": "One of `international` or `uk_national_net`.",
< "maxLength": 5000,
< "type": "string"
< },
< "transaction_count": {
< "description": "The total number of transactions reflected in this settlement.",
< "type": "integer"
< },
< "transaction_volume": {
< "description": "The total transaction amount reflected in this settlement.",
< "type": "integer"
< }
< },
< "required": [
< "bin",
< "clearing_date",
< "created",
< "currency",
< "id",
< "interchange_fees",
< "livemode",
< "metadata",
< "net_total",
< "network",
< "network_fees",
< "network_settlement_identifier",
< "object",
< "settlement_service",
< "transaction_count",
< "transaction_volume"
< ],
< "title": "IssuingSettlement",
< "type": "object",
< "x-expandableFields": [],
< "x-resourceId": "issuing.settlement"
---
> "x-resourceId": "issuing.dispute",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/issuing/disputes"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/issuing/disputes"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/issuing/disputes/{dispute}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/issuing/disputes/{dispute}"
> },
> {
> "method_name": "submit",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/issuing/disputes/{dispute}/submit"
> }
> ],
> "x-stripeResource": {
> "class_name": "Dispute",
> "has_collection_class": true,
> "in_package": "Issuing",
> "inner_classes": [
> "issuing_dispute_evidence",
> "issuing_dispute_treasury"
> ],
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
13362a16395,16397
> "amount_details",
> "authorization",
> "balance_transaction",
13363a16399
> "cardholder",
13365a16402
> "dispute",
13373c16410,16412
< "type"
---
> "purchase_details",
> "type",
> "wallet"
13388c16427,16463
< "x-resourceId": "issuing.transaction"
---
> "x-resourceId": "issuing.transaction",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/issuing/transactions"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/issuing/transactions/{transaction}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/issuing/transactions/{transaction}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Transaction",
> "has_collection_class": true,
> "in_package": "Issuing",
> "inner_classes": [
> "issuing_transaction_amount_details",
> "issuing_transaction_purchase_details",
> "issuing_transaction_treasury"
> ],
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
13398a16474,16476
> "required": [
> "atm_fee"
> ],
13401c16479,16483
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AmountDetails",
> "in_class": "issuing.authorization"
> }
13455c16537,16542
< "network_id"
---
> "city",
> "country",
> "name",
> "network_id",
> "postal_code",
> "state"
13459c16546,16550
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MerchantData",
> "in_class": "issuing.authorization"
> }
13470a16562,16564
> "required": [
> "acquiring_institution_id"
> ],
13473c16567,16571
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "NetworkData",
> "in_class": "issuing.authorization"
> }
13509a16608
> "amount_details",
13519c16618,16622
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PendingRequest",
> "in_class": "issuing.authorization"
> }
13589a16693
> "amount_details",
13595c16699,16700
< "reason"
---
> "reason",
> "reason_message"
13601c16706,16710
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "RequestHistory",
> "in_class": "issuing.authorization"
> }
13631c16740,16741
< "received_debits"
---
> "received_debits",
> "transaction"
13635c16745,16749
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Treasury",
> "in_class": "issuing.authorization"
> }
13685c16799,16803
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "VerificationData",
> "in_class": "issuing.authorization"
> }
13706c16824,16825
< "eligible"
---
> "eligible",
> "ineligible_reason"
13710c16829,16833
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ApplePay",
> "in_class": "issuing_card_wallets"
> }
14324a17448,17453
> "required": [
> "allowed_categories",
> "blocked_categories",
> "spending_limits",
> "spending_limits_currency"
> ],
14329c17458,17465
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SpendingControls",
> "in_class": "issuing.card",
> "inner_classes": [
> "issuing_card_spending_limit"
> ]
> }
14350c17486,17487
< "eligible"
---
> "eligible",
> "ineligible_reason"
14354c17491,17495
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "GooglePay",
> "in_class": "issuing_card_wallets"
> }
14449a17591,17593
> "carrier",
> "customs",
> "eta",
14450a17595,17596
> "phone_number",
> "require_signature",
14451a17598,17600
> "status",
> "tracking_number",
> "tracking_url",
14459c17608,17615
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Shipping",
> "in_class": "issuing.card",
> "inner_classes": [
> "issuing_card_shipping_customs"
> ]
> }
14470a17627,17629
> "required": [
> "eori_number"
> ],
14473c17632,17636
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Customs",
> "in_class": "issuing_card_shipping"
> }
14794a17958
> "categories",
14799c17963,17967
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SpendingLimit",
> "in_class": "issuing_card_authorization_controls"
> }
14819c17987,17988
< "google_pay"
---
> "google_pay",
> "primary_account_identifier"
14826c17995,18003
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Wallets",
> "in_class": "issuing.card",
> "inner_classes": [
> "issuing_card_apple_pay",
> "issuing_card_google_pay"
> ]
> }
14842c18019,18023
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Billing",
> "in_class": "issuing.cardholder"
> }
15456a18638,18643
> "required": [
> "allowed_categories",
> "blocked_categories",
> "spending_limits",
> "spending_limits_currency"
> ],
15461c18648,18655
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SpendingControls",
> "in_class": "issuing.cardholder",
> "inner_classes": [
> "issuing_cardholder_spending_limit"
> ]
> }
15476c18670,18674
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Company",
> "in_class": "issuing.cardholder"
> }
15521a18720,18723
> "required": [
> "back",
> "front"
> ],
15527c18729,18733
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Document",
> "in_class": "issuing_cardholder_verification"
> }
15561a18768
> "dob",
15563c18770,18771
< "last_name"
---
> "last_name",
> "verification"
15570c18778,18786
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Individual",
> "in_class": "issuing.cardholder",
> "inner_classes": [
> "issuing_cardholder_individual_dob",
> "issuing_cardholder_verification"
> ]
> }
15590a18807,18811
> "required": [
> "day",
> "month",
> "year"
> ],
15593c18814,18818
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DateOfBirth",
> "in_class": "issuing_cardholder_individual"
> }
15626a18852,18855
> "required": [
> "disabled_reason",
> "past_due"
> ],
15629c18858,18862
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Requirements",
> "in_class": "issuing.cardholder"
> }
15950a19184
> "categories",
15955c19189,19193
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SpendingLimit",
> "in_class": "issuing_cardholder_authorization_controls"
> }
15969a19208,19210
> "required": [
> "document"
> ],
15974c19215,19222
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Verification",
> "in_class": "issuing_cardholder_individual",
> "inner_classes": [
> "issuing_cardholder_id_document"
> ]
> }
16058a19307,19318
> "required": [
> "additional_documentation",
> "canceled_at",
> "cancellation_policy_provided",
> "cancellation_reason",
> "expected_at",
> "explanation",
> "product_description",
> "product_type",
> "return_status",
> "returned_at"
> ],
16063c19323,19327
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Canceled",
> "in_class": "issuing_dispute_evidence"
> }
16160a19425,19432
> "required": [
> "additional_documentation",
> "card_statement",
> "cash_receipt",
> "check_image",
> "explanation",
> "original_transaction"
> ],
16168c19440,19444
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Duplicate",
> "in_class": "issuing_dispute_evidence"
> }
16222c19498,19511
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Evidence",
> "in_class": "issuing.dispute",
> "inner_classes": [
> "issuing_dispute_canceled_evidence",
> "issuing_dispute_duplicate_evidence",
> "issuing_dispute_fraudulent_evidence",
> "issuing_dispute_merchandise_not_as_described_evidence",
> "issuing_dispute_not_received_evidence",
> "issuing_dispute_other_evidence",
> "issuing_dispute_service_not_as_described_evidence"
> ]
> }
16253a19543,19546
> "required": [
> "additional_documentation",
> "explanation"
> ],
16258c19551,19555
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Fraudulent",
> "in_class": "issuing_dispute_evidence"
> }
16316a19614,19621
> "required": [
> "additional_documentation",
> "explanation",
> "received_at",
> "return_description",
> "return_status",
> "returned_at"
> ],
16321c19626,19630
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "MerchandiseNotAsDescribed",
> "in_class": "issuing_dispute_evidence"
> }
16373a19683,19689
> "required": [
> "additional_documentation",
> "expected_at",
> "explanation",
> "product_description",
> "product_type"
> ],
16378c19694,19698
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "NotReceived",
> "in_class": "issuing_dispute_evidence"
> }
16424a19745,19750
> "required": [
> "additional_documentation",
> "explanation",
> "product_description",
> "product_type"
> ],
16429c19755,19759
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Other",
> "in_class": "issuing_dispute_evidence"
> }
16478a19809,19815
> "required": [
> "additional_documentation",
> "canceled_at",
> "cancellation_reason",
> "explanation",
> "received_at"
> ],
16483c19820,19824
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ServiceNotAsDescribed",
> "in_class": "issuing_dispute_evidence"
> }
16500a19842
> "debit_reversal",
16505c19847,19851
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Treasury",
> "in_class": "issuing.dispute"
> }
16515a19862,19864
> "required": [
> "atm_fee"
> ],
16518c19867,19871
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AmountDetails",
> "in_class": "issuing.transaction"
> }
16553a19907,19913
> "required": [
> "departure_at",
> "passenger_name",
> "refundable",
> "segments",
> "travel_agency"
> ],
16558c19918,19925
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Flight",
> "in_class": "issuing_transaction_purchase_details",
> "inner_classes": [
> "issuing_transaction_flight_data_leg"
> ]
> }
16598a19966,19973
> "required": [
> "arrival_airport_code",
> "carrier",
> "departure_airport_code",
> "flight_number",
> "service_class",
> "stopover_allowed"
> ],
16601c19976,19980
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Segments",
> "in_class": "issuing_transaction_flight_data"
> }
16631c20010,20011
< "unit_cost_decimal"
---
> "unit_cost_decimal",
> "volume_decimal"
16635c20015,20019
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Fuel",
> "in_class": "issuing_transaction_purchase_details"
> }
16650a20035,20038
> "required": [
> "check_in_at",
> "nights"
> ],
16653c20041,20045
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Lodging",
> "in_class": "issuing_transaction_purchase_details"
> }
16699a20092,20098
> "required": [
> "flight",
> "fuel",
> "lodging",
> "receipt",
> "reference"
> ],
16707c20106,20116
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PurchaseDetails",
> "in_class": "issuing.transaction",
> "inner_classes": [
> "issuing_transaction_flight_data",
> "issuing_transaction_fuel_data",
> "issuing_transaction_lodging_data",
> "issuing_transaction_receipt_data"
> ]
> }
16733a20143,20148
> "required": [
> "description",
> "quantity",
> "total",
> "unit_cost"
> ],
16736c20151,20155
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Receipt",
> "in_class": "issuing_transaction_purchase_details"
> }
16753a20173,20176
> "required": [
> "received_credit",
> "received_debit"
> ],
16756c20179,20183
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Treasury",
> "in_class": "issuing.transaction"
> }
16860c20287,20289
< "object"
---
> "object",
> "price",
> "quantity"
16870c20299,20308
< "x-resourceId": "item"
---
> "x-resourceId": "item",
> "x-stripeResource": {
> "class_name": "LineItem",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "line_items_discount_amount",
> "line_items_tax_amount"
> ]
> }
16999c20437,20445
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Company",
> "in_class": "account",
> "inner_classes": [
> "legal_entity_company_verification",
> "legal_entity_ubo_declaration"
> ]
> }
17015c20461,20468
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Verification",
> "in_class": "legal_entity_company",
> "inner_classes": [
> "legal_entity_company_verification_document"
> ]
> }
17072a20526,20531
> "required": [
> "back",
> "details",
> "details_code",
> "front"
> ],
17078c20537,20541
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "VerificationDocument",
> "in_class": "legal_entity_company_verification"
> }
17098a20562,20566
> "required": [
> "day",
> "month",
> "year"
> ],
17101c20569,20573
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DateOfBirth",
> "in_class": "person"
> }
17148a20621,20629
> "required": [
> "city",
> "country",
> "line1",
> "line2",
> "postal_code",
> "state",
> "town"
> ],
17151c20632,20636
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "JapanAddress",
> "in_class": "person"
> }
17194c20679,20683
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Verification",
> "in_class": "person"
> }
17251a20741,20746
> "required": [
> "back",
> "details",
> "details_code",
> "front"
> ],
17257c20752,20756
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "VerificationDocument",
> "in_class": "person"
> }
17280a20780,20784
> "required": [
> "date",
> "ip",
> "user_agent"
> ],
17283c20787,20881
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "OwnershipDeclaration",
> "in_class": "legal_entity_company"
> }
> },
> "level3": {
> "description": "",
> "properties": {
> "customer_reference": {
> "maxLength": 5000,
> "type": "string"
> },
> "line_items": {
> "items": {
> "$ref": "#/components/schemas/level3_line_items"
> },
> "type": "array"
> },
> "merchant_reference": {
> "maxLength": 5000,
> "type": "string"
> },
> "shipping_address_zip": {
> "maxLength": 5000,
> "type": "string"
> },
> "shipping_amount": {
> "type": "integer"
> },
> "shipping_from_zip": {
> "maxLength": 5000,
> "type": "string"
> }
> },
> "required": [
> "line_items",
> "merchant_reference"
> ],
> "title": "Level3",
> "type": "object",
> "x-expandableFields": [
> "line_items"
> ],
> "x-stripeResource": {
> "class_name": "Level3",
> "in_class": "charge",
> "inner_classes": [
> "level3_line_items"
> ]
> }
> },
> "level3_line_items": {
> "description": "",
> "properties": {
> "discount_amount": {
> "nullable": true,
> "type": "integer"
> },
> "product_code": {
> "maxLength": 5000,
> "type": "string"
> },
> "product_description": {
> "maxLength": 5000,
> "type": "string"
> },
> "quantity": {
> "nullable": true,
> "type": "integer"
> },
> "tax_amount": {
> "nullable": true,
> "type": "integer"
> },
> "unit_cost": {
> "nullable": true,
> "type": "integer"
> }
> },
> "required": [
> "discount_amount",
> "product_code",
> "product_description",
> "quantity",
> "tax_amount",
> "unit_cost"
> ],
> "title": "Level3LineItems",
> "type": "object",
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "LineItem",
> "in_class": "level3"
> }
17373a20972,20980
> "plan": {
> "anyOf": [
> {
> "$ref": "#/components/schemas/plan"
> }
> ],
> "description": "The plan of the subscription, if the line item is a subscription or a proration.",
> "nullable": true
> },
17442a21050
> "amount_excluding_tax",
17443a21052,21053
> "description",
> "discount_amounts",
17444a21055
> "discounts",
17449a21061,21062
> "plan",
> "price",
17451c21064,21068
< "type"
---
> "proration_details",
> "quantity",
> "subscription",
> "type",
> "unit_amount_excluding_tax"
17458a21076
> "plan",
17464c21082,21103
< "x-resourceId": "line_item"
---
> "x-resourceId": "line_item",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/invoices/{invoice}/lines"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/invoices/{invoice}/lines"
> }
> ],
> "x-stripeResource": {
> "class_name": "InvoiceLineItem",
> "has_collection_class": true,
> "in_package": ""
> }
17485c21124,21128
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Discount",
> "in_class": "item"
> }
17506c21149,21153
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Tax",
> "in_class": "item"
> }
17532c21179,21183
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "FinancialConnections",
> "in_class": "payment_intent_payment_method_options_us_bank_account"
> }
17563c21214,21227
< "x-resourceId": "login_link"
---
> "x-resourceId": "login_link",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/accounts/{account}/login_links"
> }
> ],
> "x-stripeResource": {
> "class_name": "LoginLink",
> "in_package": ""
> }
17652c21316,21337
< "x-resourceId": "mandate"
---
> "x-resourceId": "mandate",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/mandates/{mandate}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Mandate",
> "in_package": "",
> "inner_classes": [
> "customer_acceptance",
> "mandate_au_becs_debit",
> "mandate_bacs_debit",
> "mandate_multi_use",
> "mandate_payment_method_details",
> "mandate_single_use"
> ]
> }
17692a21378
> "interval_description",
17698c21384,21388
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "mandate_payment_method_details"
> }
17714c21404,21408
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AuBecsDebit",
> "in_class": "mandate"
> }
17747c21441,21445
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebit",
> "in_class": "mandate"
> }
17770a21469,21472
> "required": [
> "expires_after",
> "type"
> ],
17775c21477,21481
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Blik",
> "in_class": "mandate_payment_method_details"
> }
17782c21488,21492
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Link",
> "in_class": "mandate_payment_method_details"
> }
17789c21499,21503
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MultiUse",
> "in_class": "mandate"
> }
17821a21536,21541
> "required": [
> "amount",
> "currency",
> "interval",
> "interval_count"
> ],
17824c21544,21548
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BlikMandateOptionsOffSessionDetails",
> "in_class": "payment_intent_payment_method_options"
> }
17873c21597,21609
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodDetails",
> "in_class": "mandate",
> "inner_classes": [
> "card_mandate_payment_method_details",
> "mandate_acss_debit",
> "mandate_blik",
> "mandate_link",
> "mandate_sepa_debit",
> "mandate_us_bank_account"
> ]
> }
17895c21631,21635
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "mandate_payment_method_details"
> }
17915c21655,21659
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SingleUse",
> "in_class": "mandate"
> }
17922c21666,21670
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "mandate_payment_method_details"
> }
17943c21691,21692
< "available"
---
> "available",
> "preferred"
17947c21696,21700
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Networks",
> "in_class": "payment_method_card"
> }
17966c21719,21723
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EventData",
> "in_package": ""
> }
17983a21741,21744
> "required": [
> "id",
> "idempotency_key"
> ],
17986c21747,21751
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EventRequest",
> "in_package": ""
> }
17993c21758,21762
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Offline",
> "in_class": "customer_acceptance"
> }
18010a21780,21783
> "required": [
> "ip_address",
> "user_agent"
> ],
18013c21786,21790
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Online",
> "in_class": "customer_acceptance"
> }
18058,18066d21834
< "client_permissions": {
< "anyOf": [
< {
< "$ref": "#/components/schemas/orders_v2_resource_client_permissions"
< }
< ],
< "description": "The fields on the Order that can be updated from the client",
< "nullable": true
< },
18248a22017,22019
> "application",
> "billing_details",
> "client_secret",
18250a22022,22024
> "customer",
> "description",
> "discounts",
18251a22026
> "ip_address",
18252a22028
> "metadata",
18254a22031,22032
> "shipping_cost",
> "shipping_details",
18264d22041
< "client_permissions",
18274c22051,22123
< "x-resourceId": "order"
---
> "x-resourceId": "order",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/orders"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/orders"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/orders/{id}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/orders/{id}"
> },
> {
> "method_name": "submit",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/orders/{id}/submit"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/orders/{id}/cancel"
> },
> {
> "method_name": "reopen",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/orders/{id}/reopen"
> },
> {
> "method_name": "list_line_items",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/orders/{id}/line_items"
> }
> ],
> "x-stripeResource": {
> "class_name": "Order",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "orders_v2_resource_automatic_tax",
> "orders_v2_resource_billing_details",
> "orders_v2_resource_payment",
> "orders_v2_resource_shipping_cost",
> "orders_v2_resource_shipping_details",
> "orders_v2_resource_tax_details",
> "orders_v2_resource_total_details"
> ]
> }
18300a22150,22152
> "required": [
> "reference"
> ],
18303c22155,22159
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AfterpayClearpay",
> "in_class": "orders_v2_resource_payment_method_options"
> }
18318c22174,22178
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticPaymentMethods",
> "in_class": "orders_v2_resource_payment_settings"
> }
18339c22199,22200
< "enabled"
---
> "enabled",
> "status"
18343c22204,22208
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "order"
> }
18375a22241,22246
> "required": [
> "address",
> "email",
> "name",
> "phone"
> ],
18380c22251,22255
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BillingDetails",
> "in_class": "order"
> }
18408,18443c22283,22287
< "x-expandableFields": []
< },
< "orders_v2_resource_client_permissions": {
< "description": "",
< "properties": {
< "billing_details": {
< "description": "Allows or disallows billing details to be set on an Order with a publishable key and Order client_secret",
< "enum": [
< "allow",
< "disallow"
< ],
< "nullable": true,
< "type": "string"
< },
< "promotion_codes": {
< "description": "Allows or disallows promotion codes to be set on an Order with a publishable key and Order client_secret",
< "enum": [
< "allow",
< "disallow"
< ],
< "nullable": true,
< "type": "string"
< },
< "shipping_details": {
< "description": "Allows or disallows shipping details to be set on an Order with a publishable key and Order client_secret",
< "enum": [
< "allow",
< "disallow"
< ],
< "nullable": true,
< "type": "string"
< }
< },
< "title": "OrdersV2ResourceClientPermissions",
< "type": "object",
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "orders_v2_resource_payment_method_options"
> }
18492a22337,22341
> "required": [
> "payment_intent",
> "settings",
> "status"
> ],
18498c22347,22354
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Payment",
> "in_class": "order",
> "inner_classes": [
> "orders_v2_resource_payment_settings"
> ]
> }
18567c22423,22431
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodOptions",
> "in_class": "orders_v2_resource_payment_settings",
> "inner_classes": [
> "orders_payment_method_options_afterpay_clearpay",
> "orders_v2_resource_card_payment_method_options"
> ]
> }
18653a22518,22527
> "required": [
> "application_fee_amount",
> "automatic_payment_methods",
> "payment_method_options",
> "payment_method_types",
> "return_url",
> "statement_descriptor",
> "statement_descriptor_suffix",
> "transfer_data"
> ],
18660c22534,22543
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Settings",
> "in_class": "orders_v2_resource_payment",
> "inner_classes": [
> "orders_v2_resource_automatic_payment_methods",
> "orders_v2_resource_payment_method_options",
> "orders_v2_resource_transfer_data"
> ]
> }
18708c22591,22592
< "amount_total"
---
> "amount_total",
> "shipping_rate"
18715c22599,22603
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ShippingCost",
> "in_class": "order"
> }
18741a22630,22634
> "required": [
> "address",
> "name",
> "phone"
> ],
18746c22639,22643
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ShippingDetails",
> "in_class": "order"
> }
18776c22673,22680
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TaxDetails",
> "in_class": "order",
> "inner_classes": [
> "orders_v2_resource_tax_details_resource_tax_id"
> ]
> }
18847c22751,22752
< "type"
---
> "type",
> "value"
18851c22756,22760
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TaxID",
> "in_class": "orders_v2_resource_tax_details"
> }
18874a22784
> "amount_shipping",
18881c22791,22798
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TotalDetails",
> "in_class": "order",
> "inner_classes": [
> "orders_v2_resource_total_details_api_resource_breakdown"
> ]
> }
18910c22827,22831
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Breakdown",
> "in_class": "orders_v2_resource_total_details"
> }
18940a22862
> "amount",
18947c22869,22873
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TransferData",
> "in_class": "orders_v2_resource_payment_settings"
> }
18980c22906,22914
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "DestinationPaymentMethodDetails",
> "in_class": "treasury.outbound_payment",
> "inner_classes": [
> "outbound_payments_payment_method_details_financial_account",
> "outbound_payments_payment_method_details_us_bank_account"
> ]
> }
19004c22938,22942
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "FinancialAccount",
> "in_class": "outbound_payments_payment_method_details"
> }
19061c22999,23005
< "network"
---
> "account_holder_type",
> "account_type",
> "bank_name",
> "fingerprint",
> "last4",
> "network",
> "routing_number"
19065c23009,23013
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "outbound_payments_payment_method_details"
> }
19094c23042,23049
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "DestinationPaymentMethodDetails",
> "in_class": "treasury.outbound_transfer",
> "inner_classes": [
> "outbound_transfers_payment_method_details_us_bank_account"
> ]
> }
19151c23106,23112
< "network"
---
> "account_holder_type",
> "account_type",
> "bank_name",
> "fingerprint",
> "last4",
> "network",
> "routing_number"
19155c23116,23120
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "outbound_transfers_payment_method_details"
> }
19185c23150,23154
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PackageDimensions",
> "in_package": ""
> }
19198c23167,23174
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AmountDetails",
> "in_class": "payment_intent",
> "inner_classes": [
> "payment_flows_amount_details_resource_tip"
> ]
> }
19210c23186,23190
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Tip",
> "in_class": "payment_flows_amount_details"
> }
19225c23205,23209
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticPaymentMethodsPaymentIntent",
> "in_package": ""
> }
19244c23228,23232
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Installments",
> "in_class": "payment_intent_type_specific_payment_method_options_client"
> }
19251c23239,23243
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Alipay",
> "in_class": "payment_method"
> }
19273a23266,23269
> "required": [
> "fingerprint",
> "transaction_id"
> ],
19276c23272,23276
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Alipay",
> "in_class": "payment_method_details"
> }
19296a23297,23301
> "required": [
> "day",
> "month",
> "year"
> ],
19299c23304,23308
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DateOfBirth",
> "in_class": "payment_method_klarna"
> }
19645a23655,23680
> "source": {
> "anyOf": [
> {
> "maxLength": 5000,
> "type": "string"
> },
> {
> "$ref": "#/components/schemas/payment_source"
> },
> {
> "$ref": "#/components/schemas/deleted_payment_source"
> }
> ],
> "description": "This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.",
> "nullable": true,
> "x-expansionResources": {
> "oneOf": [
> {
> "$ref": "#/components/schemas/payment_source"
> },
> {
> "$ref": "#/components/schemas/deleted_payment_source"
> }
> ]
> }
> },
19688a23724,23730
> "amount_capturable",
> "amount_received",
> "application",
> "application_fee_amount",
> "automatic_payment_methods",
> "canceled_at",
> "cancellation_reason",
19689a23732
> "client_secret",
19692a23736,23737
> "customer",
> "description",
19693a23739,23740
> "invoice",
> "last_payment_error",
19694a23742,23743
> "metadata",
> "next_action",
19695a23745,23747
> "on_behalf_of",
> "payment_method",
> "payment_method_options",
19697c23749,23759
< "status"
---
> "processing",
> "receipt_email",
> "review",
> "setup_future_usage",
> "shipping",
> "source",
> "statement_descriptor",
> "statement_descriptor_suffix",
> "status",
> "transfer_data",
> "transfer_group"
19715a23778
> "source",
19718c23781,23880
< "x-resourceId": "payment_intent"
---
> "x-resourceId": "payment_intent",
> "x-stripeOperations": [
> {
> "method_name": "search",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/payment_intents/search"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/payment_intents"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/payment_intents"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/payment_intents/{intent}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/payment_intents/{intent}"
> },
> {
> "method_name": "confirm",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_intents/{intent}/confirm"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_intents/{intent}/cancel"
> },
> {
> "method_name": "capture",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_intents/{intent}/capture"
> },
> {
> "method_name": "increment_authorization",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_intents/{intent}/increment_authorization"
> },
> {
> "method_name": "verify_microdeposits",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_intents/{intent}/verify_microdeposits"
> },
> {
> "method_name": "apply_customer_balance",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_intents/{intent}/apply_customer_balance"
> }
> ],
> "x-stripeResource": {
> "class_name": "PaymentIntent",
> "has_collection_class": true,
> "has_search_result_class": true,
> "in_package": "",
> "inner_classes": [
> "payment_flows_amount_details",
> "payment_intent_next_action",
> "payment_intent_next_action_alipay_handle_redirect",
> "payment_intent_next_action_boleto",
> "payment_intent_next_action_card_await_notification",
> "payment_intent_next_action_display_bank_transfer_instructions",
> "payment_intent_next_action_display_oxxo_details",
> "payment_intent_next_action_konbini",
> "payment_intent_next_action_redirect_to_url",
> "payment_intent_payment_method_options",
> "payment_intent_processing",
> "transfer_data"
> ]
> }
19731c23893,23900
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "payment_intent_processing",
> "inner_classes": [
> "payment_intent_processing_customer_notification"
> ]
> }
19808c23977,23990
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "NextAction",
> "in_class": "payment_intent",
> "inner_classes": [
> "payment_intent_next_action_paynow_display_qr_code",
> "payment_intent_next_action_pix_display_qr_code",
> "payment_intent_next_action_promptpay_display_qr_code",
> "payment_intent_next_action_verify_with_microdeposits",
> "payment_intent_next_action_wechat_pay_display_qr_code",
> "payment_intent_next_action_wechat_pay_redirect_to_android_app",
> "payment_intent_next_action_wechat_pay_redirect_to_ios_app"
> ]
> }
19837a24020,24025
> "required": [
> "native_data",
> "native_url",
> "return_url",
> "url"
> ],
19840c24028,24032
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "NextActionAlipayHandleRedirect",
> "in_class": "payment_intent"
> }
19869a24062,24067
> "required": [
> "expires_at",
> "hosted_voucher_url",
> "number",
> "pdf"
> ],
19872c24070,24074
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "NextActionDisplayBoletoDetails",
> "in_class": "payment_intent"
> }
19888a24091,24094
> "required": [
> "charge_attempt_at",
> "customer_approval_required"
> ],
19891c24097,24101
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "NextActionCardAwaitNotification",
> "in_class": "payment_intent"
> }
19937a24148,24151
> "amount_remaining",
> "currency",
> "hosted_instructions_url",
> "reference",
19944c24158,24162
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "NextActionDisplayBankTransferInstructions",
> "in_class": "payment_intent"
> }
19967a24186,24190
> "required": [
> "expires_after",
> "hosted_voucher_url",
> "number"
> ],
19970c24193,24197
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "NextActionOxxoDisplayDetails",
> "in_class": "payment_intent"
> }
19991a24219
> "hosted_voucher_url",
19998c24226,24233
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "NextActionKonbiniDisplayDetails",
> "in_class": "payment_intent",
> "inner_classes": [
> "payment_intent_next_action_konbini_stores"
> ]
> }
20019c24254,24258
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Familymart",
> "in_class": "payment_intent_next_action_konbini_stores"
> }
20040c24279,24283
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Lawson",
> "in_class": "payment_intent_next_action_konbini_stores"
> }
20061c24304,24308
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Ministop",
> "in_class": "payment_intent_next_action_konbini_stores"
> }
20082c24329,24333
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Seicomart",
> "in_class": "payment_intent_next_action_konbini_stores"
> }
20123a24375,24380
> "required": [
> "familymart",
> "lawson",
> "ministop",
> "seicomart"
> ],
20131c24388,24398
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Stores",
> "in_class": "payment_intent_next_action_konbini",
> "inner_classes": [
> "payment_intent_next_action_konbini_familymart",
> "payment_intent_next_action_konbini_lawson",
> "payment_intent_next_action_konbini_ministop",
> "payment_intent_next_action_konbini_seicomart"
> ]
> }
20159c24426,24430
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PaynowDisplayQrCode",
> "in_class": "payment_intent_next_action"
> }
20191c24462,24466
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PixDisplayQrCode",
> "in_class": "payment_intent_next_action"
> }
20225c24500,24504
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PromptpayDisplayQrCode",
> "in_class": "payment_intent_next_action"
> }
20242a24522,24525
> "required": [
> "return_url",
> "url"
> ],
20245c24528,24532
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "NextActionRedirectToUrl",
> "in_class": "payment_intent"
> }
20272c24559,24560
< "hosted_verification_url"
---
> "hosted_verification_url",
> "microdeposit_type"
20276c24564,24568
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "VerifyWithMicrodeposits",
> "in_class": "payment_intent_next_action"
> }
20310c24602,24606
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "WechatPayDisplayQrCode",
> "in_class": "payment_intent_next_action"
> }
20362c24658,24662
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "WechatPayRedirectToAndroidApp",
> "in_class": "payment_intent_next_action"
> }
20378c24678,24682
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "WechatPayRedirectToIosApp",
> "in_class": "payment_intent_next_action"
> }
20384,20391c24688
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
20394,20401c24691
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_affirm"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_affirm"
20404,20411c24694
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
20414,20421c24697
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_alipay"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_alipay"
20424,20431c24700
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
20434,20441c24703
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_bacs_debit"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_bacs_debit"
20444,20451c24706
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_bancontact"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_bancontact"
20454,20461c24709
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
20464,20471c24712
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_boleto"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_boleto"
20474,20481c24715
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_card"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_card"
20484,20491c24718
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_card_present"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_card_present"
20494,20501c24721
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_customer_balance"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_customer_balance"
20504,20511c24724
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
20514,20521c24727
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_fpx"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_fpx"
20524,20531c24730
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_giropay"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_giropay"
20534,20541c24733
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_grabpay"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_grabpay"
20544,20551c24736
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_ideal"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_ideal"
20554,20561c24739
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_interac_present"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_interac_present"
20564,20571c24742
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_klarna"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_klarna"
20574,20581c24745
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_konbini"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_konbini"
20584,20591c24748
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_link"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_link"
20594,20601c24751
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_oxxo"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_oxxo"
20604,20611c24754
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_p24"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_p24"
20614,20621c24757
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_paynow"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_paynow"
20624,20631c24760
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_pix"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_pix"
20634,20641c24763
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_promptpay"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_promptpay"
20644,20651c24766
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
20654,20661c24769
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_sofort"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_sofort"
20664,20671c24772
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
20674,20681c24775
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_options_wechat_pay"
< },
< {
< "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/payment_method_options_wechat_pay"
20717c24811,24851
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodOptions",
> "in_class": "payment_intent",
> "inner_classes": [
> "mandate_options_off_session_details_blik",
> "payment_intent_payment_method_options_acss_debit",
> "payment_intent_payment_method_options_au_becs_debit",
> "payment_intent_payment_method_options_blik",
> "payment_intent_payment_method_options_card",
> "payment_intent_payment_method_options_eps",
> "payment_intent_payment_method_options_link",
> "payment_intent_payment_method_options_mandate_options_sepa_debit",
> "payment_intent_payment_method_options_sepa_debit",
> "payment_intent_payment_method_options_us_bank_account",
> "payment_method_options_affirm",
> "payment_method_options_afterpay_clearpay",
> "payment_method_options_alipay",
> "payment_method_options_bacs_debit",
> "payment_method_options_bancontact",
> "payment_method_options_boleto",
> "payment_method_options_card_present",
> "payment_method_options_customer_balance",
> "payment_method_options_customer_balance_bank_transfer",
> "payment_method_options_fpx",
> "payment_method_options_giropay",
> "payment_method_options_grabpay",
> "payment_method_options_ideal",
> "payment_method_options_interac_present",
> "payment_method_options_klarna",
> "payment_method_options_konbini",
> "payment_method_options_oxxo",
> "payment_method_options_p24",
> "payment_method_options_paynow",
> "payment_method_options_paypal",
> "payment_method_options_pix",
> "payment_method_options_promptpay",
> "payment_method_options_sofort",
> "payment_method_options_wechat_pay"
> ]
> }
20749c24883,24890
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "payment_intent_payment_method_options",
> "inner_classes": [
> "payment_intent_payment_method_options_mandate_options_acss_debit"
> ]
> }
20766c24907,24911
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AuBecsDebit",
> "in_class": "payment_intent_payment_method_options"
> }
20773c24918,24922
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Blik",
> "in_class": "payment_intent_payment_method_options"
> }
20849a24999,25004
> "required": [
> "installments",
> "mandate_options",
> "network",
> "request_three_d_secure"
> ],
20855c25010,25018
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "payment_intent_payment_method_options",
> "inner_classes": [
> "payment_method_options_card_installments",
> "payment_method_options_card_mandate_options"
> ]
> }
20870c25033,25037
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Eps",
> "in_class": "payment_intent_payment_method_options"
> }
20896a25064,25066
> "required": [
> "persistent_token"
> ],
20899c25069,25073
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Link",
> "in_class": "payment_intent_payment_method_options"
> }
20934a25109,25113
> "required": [
> "interval_description",
> "payment_schedule",
> "transaction_type"
> ],
20937c25116,25120
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MandateOptions",
> "in_class": "payment_intent_payment_method_options_acss_debit"
> }
20944c25127,25131
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebitMandateOptions",
> "in_class": "payment_intent_payment_method_options"
> }
20966c25153,25157
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "payment_intent_payment_method_options"
> }
20998c25189,25196
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "payment_intent_payment_method_options",
> "inner_classes": [
> "linked_account_options_us_bank_account"
> ]
> }
21021c25219,25226
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Processing",
> "in_class": "payment_intent",
> "inner_classes": [
> "payment_intent_card_processing"
> ]
> }
21037a25243,25246
> "required": [
> "approval_requested",
> "completes_at"
> ],
21040c25249,25253
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CustomerNotification",
> "in_class": "payment_intent_card_processing"
> }
21079c25292,25299
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
> "in_package": "",
> "inner_classes": [
> "payment_flows_installment_options"
> ]
> }
21332a25553,25554
> "application_fee_amount",
> "application_fee_percent",
21334a25557
> "consent_collection",
21340a25564,25565
> "on_behalf_of",
> "payment_intent_data",
21341a25567
> "payment_method_types",
21342a25569
> "shipping_address_collection",
21344a25572
> "subscription_data",
21345a25574
> "transfer_data",
21364c25593,25647
< "x-resourceId": "payment_link"
---
> "x-resourceId": "payment_link",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/payment_links"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/payment_links/{payment_link}"
> },
> {
> "method_name": "list_line_items",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/payment_links/{payment_link}/line_items"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/payment_links"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/payment_links/{payment_link}"
> }
> ],
> "x-stripeResource": {
> "class_name": "PaymentLink",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "payment_links_resource_after_completion",
> "payment_links_resource_automatic_tax",
> "payment_links_resource_consent_collection",
> "payment_links_resource_payment_intent_data",
> "payment_links_resource_phone_number_collection",
> "payment_links_resource_shipping_address_collection",
> "payment_links_resource_shipping_option",
> "payment_links_resource_subscription_data",
> "payment_links_resource_tax_id_collection",
> "payment_links_resource_transfer_data"
> ]
> }
21392c25675,25683
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AfterCompletion",
> "in_class": "payment_link",
> "inner_classes": [
> "payment_links_resource_completion_behavior_confirmation_page",
> "payment_links_resource_completion_behavior_redirect"
> ]
> }
21407c25698,25702
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "payment_link"
> }
21418a25714,25716
> "required": [
> "custom_message"
> ],
21421c25719,25723
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "HostedConfirmation",
> "in_class": "payment_links_resource_after_completion"
> }
21437c25739,25743
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Redirect",
> "in_class": "payment_links_resource_after_completion"
> }
21460a25767,25770
> "required": [
> "promotions",
> "terms_of_service"
> ],
21463c25773,25777
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ConsentCollection",
> "in_class": "payment_link"
> }
21486a25801,25804
> "required": [
> "capture_method",
> "setup_future_usage"
> ],
21489c25807,25811
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PaymentIntentData",
> "in_class": "payment_link"
> }
21504c25826,25830
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PhoneNumberCollection",
> "in_class": "payment_link"
> }
21761c26087,26091
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ShippingAddressCollection",
> "in_class": "payment_link"
> }
21798c26128,26132
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ShippingOption",
> "in_class": "payment_link"
> }
21814a26149,26152
> "required": [
> "description",
> "trial_period_days"
> ],
21817c26155,26159
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SubscriptionData",
> "in_class": "payment_link"
> }
21832c26174,26178
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TaxIdCollection",
> "in_class": "payment_link"
> }
21862a26209
> "amount",
21869c26216,26220
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TransferData",
> "in_class": "payment_link"
> }
22060a26412
> "customer",
22062a26415
> "metadata",
22103c26456,26538
< "x-resourceId": "payment_method"
---
> "x-resourceId": "payment_method",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/payment_methods"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/payment_methods/{payment_method}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/payment_methods/{payment_method}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/payment_methods"
> },
> {
> "method_name": "attach",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_methods/{payment_method}/attach"
> },
> {
> "method_name": "detach",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payment_methods/{payment_method}/detach"
> }
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethod",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "billing_details",
> "payment_flows_private_payment_methods_alipay",
> "payment_method_acss_debit",
> "payment_method_affirm",
> "payment_method_afterpay_clearpay",
> "payment_method_au_becs_debit",
> "payment_method_bacs_debit",
> "payment_method_bancontact",
> "payment_method_blik",
> "payment_method_boleto",
> "payment_method_card",
> "payment_method_card_present",
> "payment_method_customer_balance",
> "payment_method_eps",
> "payment_method_fpx",
> "payment_method_giropay",
> "payment_method_grabpay",
> "payment_method_ideal",
> "payment_method_interac_present",
> "payment_method_klarna",
> "payment_method_konbini",
> "payment_method_link",
> "payment_method_oxxo",
> "payment_method_p24",
> "payment_method_paynow",
> "payment_method_pix",
> "payment_method_promptpay",
> "payment_method_sepa_debit",
> "payment_method_sofort",
> "payment_method_us_bank_account",
> "payment_method_wechat_pay"
> ]
> }
22138a26574,26580
> "required": [
> "bank_name",
> "fingerprint",
> "institution_number",
> "last4",
> "transit_number"
> ],
22141c26583,26587
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "payment_method"
> }
22148c26594,26598
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Affirm",
> "in_class": "payment_method"
> }
22155c26605,26609
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AfterpayClearpay",
> "in_class": "payment_method"
> }
22178a26633,26637
> "required": [
> "bsb_number",
> "fingerprint",
> "last4"
> ],
22181c26640,26644
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AuBecsDebit",
> "in_class": "payment_method"
> }
22204a26668,26672
> "required": [
> "fingerprint",
> "last4",
> "sort_code"
> ],
22207c26675,26679
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebit",
> "in_class": "payment_method"
> }
22214c26686,26690
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Bancontact",
> "in_class": "payment_method"
> }
22221c26697,26701
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Blik",
> "in_class": "payment_method"
> }
22237c26717,26721
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Boleto",
> "in_class": "payment_method"
> }
22261a26746,26751
> "description": {
> "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
22281,22288c26771,26781
< "generated_from": {
< "anyOf": [
< {
< "$ref": "#/components/schemas/payment_method_card_generated_card"
< }
< ],
< "description": "Details of the original PaymentMethod that created this object.",
< "nullable": true
---
> "iin": {
> "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
> "issuer": {
> "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
22324a26818,26819
> "checks",
> "country",
22328c26823,26826
< "last4"
---
> "last4",
> "networks",
> "three_d_secure_usage",
> "wallet"
22334d26831
< "generated_from",
22338c26835,26845
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "payment_method",
> "inner_classes": [
> "networks",
> "payment_method_card_checks",
> "payment_method_card_wallet",
> "three_d_secure_usage"
> ]
> }
22361a26869,26873
> "required": [
> "address_line1_check",
> "address_postal_code_check",
> "cvc_check"
> ],
22364,22410c26876,26880
< "x-expandableFields": []
< },
< "payment_method_card_generated_card": {
< "description": "",
< "properties": {
< "charge": {
< "description": "The charge that created this object.",
< "maxLength": 5000,
< "nullable": true,
< "type": "string"
< },
< "payment_method_details": {
< "anyOf": [
< {
< "$ref": "#/components/schemas/card_generated_from_payment_method_details"
< }
< ],
< "description": "Transaction-specific details of the payment method used in the payment.",
< "nullable": true
< },
< "setup_attempt": {
< "anyOf": [
< {
< "maxLength": 5000,
< "type": "string"
< },
< {
< "$ref": "#/components/schemas/setup_attempt"
< }
< ],
< "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
< "nullable": true,
< "x-expansionResources": {
< "oneOf": [
< {
< "$ref": "#/components/schemas/setup_attempt"
< }
< ]
< }
< }
< },
< "title": "payment_method_card_generated_card",
< "type": "object",
< "x-expandableFields": [
< "payment_method_details",
< "setup_attempt"
< ]
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Checks",
> "in_class": "payment_method_card"
> }
22417c26887,26891
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CardPresent",
> "in_class": "payment_method"
> }
22459a26934
> "dynamic_last4",
22471c26946,26958
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Wallet",
> "in_class": "payment_method_card",
> "inner_classes": [
> "payment_method_card_wallet_amex_express_checkout",
> "payment_method_card_wallet_apple_pay",
> "payment_method_card_wallet_google_pay",
> "payment_method_card_wallet_masterpass",
> "payment_method_card_wallet_samsung_pay",
> "payment_method_card_wallet_visa_checkout"
> ]
> }
22478c26965,26969
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AmexExpressCheckout",
> "in_class": "payment_method_card_wallet"
> }
22485c26976,26980
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ApplePay",
> "in_class": "payment_method_card_wallet"
> }
22492c26987,26991
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "GooglePay",
> "in_class": "payment_method_card_wallet"
> }
22527a27027,27032
> "required": [
> "billing_address",
> "email",
> "name",
> "shipping_address"
> ],
22533c27038,27042
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Masterpass",
> "in_class": "payment_method_card_wallet"
> }
22540c27049,27053
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SamsungPay",
> "in_class": "payment_method_card_wallet"
> }
22575a27089,27094
> "required": [
> "billing_address",
> "email",
> "name",
> "shipping_address"
> ],
22581c27100,27104
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "VisaCheckout",
> "in_class": "payment_method_card_wallet"
> }
22588c27111,27115
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CustomerBalance",
> "in_class": "payment_method"
> }
22679a27207,27209
> "sepa_credit_transfer": {
> "$ref": "#/components/schemas/payment_method_details_sepa_credit_transfer"
> },
22738a27269
> "sepa_credit_transfer",
22745c27276,27319
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodDetails",
> "in_class": "charge",
> "inner_classes": [
> "payment_flows_private_payment_methods_alipay_details",
> "payment_method_details_ach_credit_transfer",
> "payment_method_details_ach_debit",
> "payment_method_details_acss_debit",
> "payment_method_details_affirm",
> "payment_method_details_afterpay_clearpay",
> "payment_method_details_au_becs_debit",
> "payment_method_details_bacs_debit",
> "payment_method_details_bancontact",
> "payment_method_details_blik",
> "payment_method_details_boleto",
> "payment_method_details_card",
> "payment_method_details_card_present",
> "payment_method_details_customer_balance",
> "payment_method_details_eps",
> "payment_method_details_fpx",
> "payment_method_details_giropay",
> "payment_method_details_grabpay",
> "payment_method_details_ideal",
> "payment_method_details_interac_present",
> "payment_method_details_klarna",
> "payment_method_details_konbini",
> "payment_method_details_konbini_store",
> "payment_method_details_link",
> "payment_method_details_multibanco",
> "payment_method_details_oxxo",
> "payment_method_details_p24",
> "payment_method_details_paynow",
> "payment_method_details_pix",
> "payment_method_details_promptpay",
> "payment_method_details_sepa_credit_transfer",
> "payment_method_details_sepa_debit",
> "payment_method_details_sofort",
> "payment_method_details_stripe_account",
> "payment_method_details_us_bank_account",
> "payment_method_details_wechat",
> "payment_method_details_wechat_pay"
> ]
> }
22774a27349,27354
> "required": [
> "account_number",
> "bank_name",
> "routing_number",
> "swift_code"
> ],
22777c27357,27361
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AchCreditTransfer",
> "in_class": "payment_method_details"
> }
22821a27406,27413
> "required": [
> "account_holder_type",
> "bank_name",
> "country",
> "fingerprint",
> "last4",
> "routing_number"
> ],
22824c27416,27420
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AchDebit",
> "in_class": "payment_method_details"
> }
22864a27461,27467
> "required": [
> "bank_name",
> "fingerprint",
> "institution_number",
> "last4",
> "transit_number"
> ],
22867c27470,27474
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "payment_method_details"
> }
22874c27481,27485
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Affirm",
> "in_class": "payment_method_details"
> }
22885a27497,27499
> "required": [
> "reference"
> ],
22888c27502,27506
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AfterpayClearpay",
> "in_class": "payment_method_details"
> }
22916a27535,27539
> "required": [
> "bsb_number",
> "fingerprint",
> "last4"
> ],
22919c27542,27546
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AuBecsDebit",
> "in_class": "payment_method_details"
> }
22948a27576,27581
> "required": [
> "fingerprint",
> "last4",
> "mandate",
> "sort_code"
> ],
22951c27584,27588
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebit",
> "in_class": "payment_method_details"
> }
23037a27675,27684
> "required": [
> "bank_code",
> "bank_name",
> "bic",
> "generated_sepa_debit",
> "generated_sepa_debit_mandate",
> "iban_last4",
> "preferred_language",
> "verified_name"
> ],
23043c27690,27694
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Bancontact",
> "in_class": "payment_method_details"
> }
23050c27701,27705
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Blik",
> "in_class": "payment_method_details"
> }
23066c27721,27725
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Boleto",
> "in_class": "payment_method_details"
> }
23091a27751,27756
> "description": {
> "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23111a27777,27782
> "iin": {
> "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23120a27792,27797
> "issuer": {
> "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23132a27810,27814
> "moto": {
> "description": "True if this payment was marked as MOTO and out of scope for SCA.",
> "nullable": true,
> "type": "boolean"
> },
23158a27841,27843
> "brand",
> "checks",
> "country",
23160c27845,27852
< "exp_year"
---
> "exp_year",
> "funding",
> "installments",
> "last4",
> "mandate",
> "network",
> "three_d_secure",
> "wallet"
23169c27861,27871
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "payment_method_details",
> "inner_classes": [
> "payment_method_details_card_checks",
> "payment_method_details_card_installments",
> "payment_method_details_card_wallet",
> "three_d_secure_details"
> ]
> }
23192a27895,27899
> "required": [
> "address_line1_check",
> "address_postal_code_check",
> "cvc_check"
> ],
23195c27902,27906
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Checks",
> "in_class": "payment_method_details_card"
> }
23209a27921,27923
> "required": [
> "plan"
> ],
23214c27928,27932
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Installments",
> "in_class": "payment_method_details_card"
> }
23240a27959,27960
> "count",
> "interval",
23245c27965,27969
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Plan",
> "in_class": "payment_method_options_card_installments"
> }
23277a28002,28007
> "description": {
> "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23309a28040,28045
> "iin": {
> "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23313a28050,28055
> "issuer": {
> "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23352a28095,28099
> "amount_authorized",
> "brand",
> "cardholder_name",
> "country",
> "emv_auth_data",
23354a28102,28104
> "fingerprint",
> "funding",
> "generated_card",
23356c28106,28110
< "overcapture_supported"
---
> "last4",
> "network",
> "overcapture_supported",
> "read_method",
> "receipt"
23362c28116,28123
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CardPresent",
> "in_class": "payment_method_details",
> "inner_classes": [
> "payment_method_details_card_present_receipt"
> ]
> }
23426a28188,28197
> "required": [
> "application_cryptogram",
> "application_preferred_name",
> "authorization_code",
> "authorization_response_code",
> "cardholder_verification_method",
> "dedicated_file_name",
> "terminal_verification_results",
> "transaction_status_information"
> ],
23429c28200,28204
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Receipt",
> "in_class": "payment_method_details_card_present"
> }
23471a28247
> "dynamic_last4",
23483c28259,28271
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Wallet",
> "in_class": "payment_method_details_card",
> "inner_classes": [
> "payment_method_details_card_wallet_amex_express_checkout",
> "payment_method_details_card_wallet_apple_pay",
> "payment_method_details_card_wallet_google_pay",
> "payment_method_details_card_wallet_masterpass",
> "payment_method_details_card_wallet_samsung_pay",
> "payment_method_details_card_wallet_visa_checkout"
> ]
> }
23490c28278,28282
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AmexExpressCheckout",
> "in_class": "payment_method_details_card_wallet"
> }
23497c28289,28293
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ApplePay",
> "in_class": "payment_method_details_card_wallet"
> }
23504c28300,28304
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "GooglePay",
> "in_class": "payment_method_details_card_wallet"
> }
23539a28340,28345
> "required": [
> "billing_address",
> "email",
> "name",
> "shipping_address"
> ],
23545c28351,28355
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Masterpass",
> "in_class": "payment_method_details_card_wallet"
> }
23552c28362,28366
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SamsungPay",
> "in_class": "payment_method_details_card_wallet"
> }
23587a28402,28407
> "required": [
> "billing_address",
> "email",
> "name",
> "shipping_address"
> ],
23593c28413,28417
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "VisaCheckout",
> "in_class": "payment_method_details_card_wallet"
> }
23600c28424,28428
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CustomerBalance",
> "in_class": "payment_method_details"
> }
23646a28475,28478
> "required": [
> "bank",
> "verified_name"
> ],
23649c28481,28485
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Eps",
> "in_class": "payment_method_details"
> }
23653a28490,28498
> "account_holder_type": {
> "description": "Account holder type, if provided. Can be one of `individual` or `company`.",
> "enum": [
> "company",
> "individual"
> ],
> "nullable": true,
> "type": "string"
> },
23690c28535,28537
< "bank"
---
> "account_holder_type",
> "bank",
> "transaction_id"
23694c28541,28545
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Fpx",
> "in_class": "payment_method_details"
> }
23723a28575,28580
> "required": [
> "bank_code",
> "bank_name",
> "bic",
> "verified_name"
> ],
23726c28583,28587
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Giropay",
> "in_class": "payment_method_details"
> }
23737a28599,28601
> "required": [
> "transaction_id"
> ],
23740c28604,28608
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Grabpay",
> "in_class": "payment_method_details"
> }
23837a28706,28713
> "required": [
> "bank",
> "bic",
> "generated_sepa_debit",
> "generated_sepa_debit_mandate",
> "iban_last4",
> "verified_name"
> ],
23843c28719,28723
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Ideal",
> "in_class": "payment_method_details"
> }
23865a28746,28751
> "description": {
> "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23897a28784,28795
> "iin": {
> "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
> "issuer": {
> "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
23941a28840,28843
> "brand",
> "cardholder_name",
> "country",
> "emv_auth_data",
23943c28845,28853
< "exp_year"
---
> "exp_year",
> "fingerprint",
> "funding",
> "generated_card",
> "last4",
> "network",
> "preferred_locales",
> "read_method",
> "receipt"
23949c28859,28866
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "InteracPresent",
> "in_class": "payment_method_details",
> "inner_classes": [
> "payment_method_details_interac_present_receipt"
> ]
> }
24012a28930,28939
> "required": [
> "application_cryptogram",
> "application_preferred_name",
> "authorization_code",
> "authorization_response_code",
> "cardholder_verification_method",
> "dedicated_file_name",
> "terminal_verification_results",
> "transaction_status_information"
> ],
24015c28942,28946
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Receipt",
> "in_class": "payment_method_details_interac_present"
> }
24032a28964,28967
> "required": [
> "payment_method_category",
> "preferred_locale"
> ],
24035c28970,28974
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Klarna",
> "in_class": "payment_method_details"
> }
24049a28989,28991
> "required": [
> "store"
> ],
24054c28996,29000
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Konbini",
> "in_class": "payment_method_details"
> }
24070a29017,29019
> "required": [
> "chain"
> ],
24073c29022,29026
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Store",
> "in_class": "payment_method_details"
> }
24080c29033,29037
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Link",
> "in_class": "payment_method_details"
> }
24097a29055,29058
> "required": [
> "entity",
> "reference"
> ],
24100c29061,29065
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Multibanco",
> "in_class": "payment_method_details"
> }
24111a29077,29079
> "required": [
> "number"
> ],
24114c29082,29086
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Oxxo",
> "in_class": "payment_method_details"
> }
24163a29136,29140
> "required": [
> "bank",
> "reference",
> "verified_name"
> ],
24166c29143,29147
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "P24",
> "in_class": "payment_method_details"
> }
24177a29159,29161
> "required": [
> "reference"
> ],
24180c29164,29168
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Paynow",
> "in_class": "payment_method_details"
> }
24194c29182,29186
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Pix",
> "in_class": "payment_method_details"
> }
24205a29198,29200
> "required": [
> "reference"
> ],
24208c29203,29242
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Promptpay",
> "in_class": "payment_method_details"
> }
> },
> "payment_method_details_sepa_credit_transfer": {
> "description": "",
> "properties": {
> "bank_name": {
> "description": "Name of the bank associated with the bank account.",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
> "bic": {
> "description": "Bank Identifier Code of the bank associated with the bank account.",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
> "iban": {
> "description": "IBAN of the bank account to transfer funds to.",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> }
> },
> "required": [
> "bank_name",
> "bic",
> "iban"
> ],
> "title": "payment_method_details_sepa_credit_transfer",
> "type": "object",
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaCreditTransfer",
> "in_class": "payment_method_details"
> }
24249a29284,29291
> "required": [
> "bank_code",
> "branch_code",
> "country",
> "fingerprint",
> "last4",
> "mandate"
> ],
24252c29294,29298
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "payment_method_details"
> }
24347a29394,29404
> "required": [
> "bank_code",
> "bank_name",
> "bic",
> "country",
> "generated_sepa_debit",
> "generated_sepa_debit_mandate",
> "iban_last4",
> "preferred_language",
> "verified_name"
> ],
24353c29410,29414
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Sofort",
> "in_class": "payment_method_details"
> }
24360c29421,29425
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StripeAccount",
> "in_class": "payment_method_details"
> }
24407a29473,29480
> "required": [
> "account_holder_type",
> "account_type",
> "bank_name",
> "fingerprint",
> "last4",
> "routing_number"
> ],
24410c29483,29487
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "payment_method_details"
> }
24417c29494,29498
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Wechat",
> "in_class": "payment_method_details"
> }
24434a29516,29519
> "required": [
> "fingerprint",
> "transaction_id"
> ],
24437c29522,29526
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "WechatPay",
> "in_class": "payment_method_details"
> }
24477a29567,29569
> "required": [
> "bank"
> ],
24480c29572,29576
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Eps",
> "in_class": "payment_method"
> }
24484a29581,29589
> "account_holder_type": {
> "description": "Account holder type, if provided. Can be one of `individual` or `company`.",
> "enum": [
> "company",
> "individual"
> ],
> "nullable": true,
> "type": "string"
> },
24514a29620
> "account_holder_type",
24519c29625,29629
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Fpx",
> "in_class": "payment_method"
> }
24526c29636,29640
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Giropay",
> "in_class": "payment_method"
> }
24533c29647,29651
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Grabpay",
> "in_class": "payment_method"
> }
24578a29697,29700
> "required": [
> "bank",
> "bic"
> ],
24581c29703,29707
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Ideal",
> "in_class": "payment_method"
> }
24588c29714,29718
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "InteracPresent",
> "in_class": "payment_method"
> }
24602a29733,29735
> "required": [
> "dob"
> ],
24607c29740,29747
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Klarna",
> "in_class": "payment_method",
> "inner_classes": [
> "payment_flows_private_payment_methods_klarna_dob"
> ]
> }
24614c29754,29758
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Konbini",
> "in_class": "payment_method"
> }
24630a29775,29777
> "required": [
> "email"
> ],
24633c29780,29784
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Link",
> "in_class": "payment_method"
> }
24655c29806,29810
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Affirm",
> "in_class": "payment_intent_payment_method_options"
> }
24681a29837,29839
> "required": [
> "reference"
> ],
24684c29842,29846
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AfterpayClearpay",
> "in_class": "payment_intent_payment_method_options"
> }
24700c29862,29866
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Alipay",
> "in_class": "payment_intent_payment_method_options"
> }
24717c29883,29887
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebit",
> "in_class": "payment_intent_payment_method_options"
> }
24746c29916,29920
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Bancontact",
> "in_class": "payment_intent_payment_method_options"
> }
24770c29944,29948
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Boleto",
> "in_class": "payment_intent_payment_method_options"
> }
24798c29976,29978
< "enabled"
---
> "available_plans",
> "enabled",
> "plan"
24805c29985,29992
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Installments",
> "in_class": "payment_intent_payment_method_options_card",
> "inner_classes": [
> "payment_method_details_card_installments_plan"
> ]
> }
24874a30062,30063
> "description",
> "end_date",
24875a30065
> "interval_count",
24877c30067,30068
< "start_date"
---
> "start_date",
> "supported_types"
24881c30072,30076
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MandateOptions",
> "in_class": "payment_intent_payment_method_options_card"
> }
24896a30092,30095
> "required": [
> "request_extended_authorization",
> "request_incremental_authorization_support"
> ],
24899c30098,30102
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CardPresent",
> "in_class": "payment_intent_payment_method_options"
> }
24922a30126,30128
> "required": [
> "funding_type"
> ],
24927c30133,30137
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CustomerBalance",
> "in_class": "payment_intent_payment_method_options"
> }
24962a30173,30175
> "required": [
> "type"
> ],
24967c30180,30187
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BankTransfer",
> "in_class": "payment_intent_payment_method_options",
> "inner_classes": [
> "payment_method_options_customer_balance_eu_bank_account"
> ]
> }
24989c30209,30213
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EuBankTransfer",
> "in_class": "payment_method_options_customer_balance_bank_transfer"
> }
25004c30228,30232
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Fpx",
> "in_class": "payment_intent_payment_method_options"
> }
25019c30247,30251
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Giropay",
> "in_class": "payment_intent_payment_method_options"
> }
25034c30266,30270
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Grabpay",
> "in_class": "payment_intent_payment_method_options"
> }
25050c30286,30290
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Ideal",
> "in_class": "payment_intent_payment_method_options"
> }
25057c30297,30301
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "InteracPresent",
> "in_class": "payment_intent_payment_method_options"
> }
25082a30327,30329
> "required": [
> "preferred_locale"
> ],
25085c30332,30336
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Klarna",
> "in_class": "payment_intent_payment_method_options"
> }
25120a30372,30377
> "required": [
> "confirmation_number",
> "expires_after_days",
> "expires_at",
> "product_description"
> ],
25123c30380,30384
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Konbini",
> "in_class": "payment_intent_payment_method_options"
> }
25145c30406,30410
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Oxxo",
> "in_class": "payment_intent_payment_method_options"
> }
25160c30425,30429
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "P24",
> "in_class": "payment_intent_payment_method_options"
> }
25175c30444,30448
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Paynow",
> "in_class": "payment_intent_payment_method_options"
> }
25193a30467,30469
> "required": [
> "preferred_locale"
> ],
25196c30472,30476
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Paypal",
> "in_class": "payment_intent_payment_method_options"
> }
25218a30499,30502
> "required": [
> "expires_after_seconds",
> "expires_at"
> ],
25221c30505,30509
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Pix",
> "in_class": "payment_intent_payment_method_options"
> }
25236c30524,30528
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Promptpay",
> "in_class": "payment_intent_payment_method_options"
> }
25263a30556,30558
> "required": [
> "preferred_language"
> ],
25266c30561,30565
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Sofort",
> "in_class": "payment_intent_payment_method_options"
> }
25295a30595,30598
> "required": [
> "app_id",
> "client"
> ],
25298c30601,30605
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "WechatPay",
> "in_class": "payment_intent_payment_method_options"
> }
25305c30612,30616
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Oxxo",
> "in_class": "payment_method"
> }
25343a30655,30657
> "required": [
> "bank"
> ],
25346c30660,30664
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "P24",
> "in_class": "payment_method"
> }
25353c30671,30675
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Paynow",
> "in_class": "payment_method"
> }
25360c30682,30686
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Pix",
> "in_class": "payment_method"
> }
25367c30693,30697
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Promptpay",
> "in_class": "payment_method"
> }
25411a30742,30749
> "required": [
> "bank_code",
> "branch_code",
> "country",
> "fingerprint",
> "generated_from",
> "last4"
> ],
25416c30754,30761
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "payment_method",
> "inner_classes": [
> "sepa_debit_generated_from"
> ]
> }
25427a30773,30775
> "required": [
> "country"
> ],
25430c30778,30782
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Sofort",
> "in_class": "payment_method"
> }
25492a30845,30853
> "required": [
> "account_holder_type",
> "account_type",
> "bank_name",
> "fingerprint",
> "last4",
> "networks",
> "routing_number"
> ],
25497c30858,30865
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "USBankAccount",
> "in_class": "payment_method",
> "inner_classes": [
> "us_bank_account_networks"
> ]
> }
25504c30872,30876
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "WechatPay",
> "in_class": "payment_method"
> }
25518a30891,30893
> "required": [
> "recovery"
> ],
25523c30898,30905
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AfterExpiration",
> "in_class": "checkout.session",
> "inner_classes": [
> "payment_pages_checkout_session_after_expiration_recovery"
> ]
> }
25551c30933,30935
< "enabled"
---
> "enabled",
> "expires_at",
> "url"
25555c30939,30943
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Recovery",
> "in_class": "payment_pages_checkout_session_after_expiration"
> }
25576c30964,30965
< "enabled"
---
> "enabled",
> "status"
25580c30969,30973
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "checkout.session"
> }
25603a30997,31000
> "required": [
> "promotions",
> "terms_of_service"
> ],
25606c31003,31007
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Consent",
> "in_class": "checkout.session"
> }
25629a31031,31034
> "required": [
> "promotions",
> "terms_of_service"
> ],
25632c31037,31041
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ConsentCollection",
> "in_class": "checkout.session"
> }
25682a31092,31099
> "required": [
> "address",
> "email",
> "name",
> "phone",
> "tax_exempt",
> "tax_ids"
> ],
25688c31105,31112
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CustomerDetails",
> "in_class": "checkout.session",
> "inner_classes": [
> "payment_pages_checkout_session_tax_id"
> ]
> }
25703c31127,31131
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PhoneNumberCollection",
> "in_class": "checkout.session"
> }
25960c31388,31392
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ShippingAddressCollection",
> "in_class": "checkout.session"
> }
26008c31440,31441
< "amount_total"
---
> "amount_total",
> "shipping_rate"
26015c31448,31452
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ShippingCost",
> "in_class": "checkout.session"
> }
26052c31489,31493
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ShippingOption",
> "in_class": "checkout.session"
> }
26123c31564,31565
< "type"
---
> "type",
> "value"
26127c31569,31573
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TaxID",
> "in_class": "payment_pages_checkout_session_customer_details"
> }
26142c31588,31592
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TaxIDCollection",
> "in_class": "checkout.session"
> }
26165a31616
> "amount_shipping",
26172c31623,31630
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TotalDetails",
> "in_class": "checkout.session",
> "inner_classes": [
> "payment_pages_checkout_session_total_details_resource_breakdown"
> ]
> }
26201c31659,31663
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Breakdown",
> "in_class": "payment_pages_checkout_session_total_details"
> }
26220c31682,31730
< "x-stripeBypassValidation": true
---
> "x-stripeBypassValidation": true,
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/sources"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/sources"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/sources/{id}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/sources/{id}"
> },
> {
> "method_name": "create",
> "method_on": "collection",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/customers/{customer}/sources"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/customers/{customer}/sources"
> }
> ],
> "x-stripeResource": {
> "class_name": "PaymentSource",
> "has_collection_class": true
> }
26280,26283c31790
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
---
> "$ref": "#/components/schemas/external_account"
26286,26289c31793
< "$ref": "#/components/schemas/deleted_bank_account"
< },
< {
< "$ref": "#/components/schemas/deleted_card"
---
> "$ref": "#/components/schemas/deleted_external_account"
26297,26303c31801
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/deleted_bank_account"
---
> "$ref": "#/components/schemas/external_account"
26306c31804
< "$ref": "#/components/schemas/deleted_card"
---
> "$ref": "#/components/schemas/deleted_external_account"
26309,26310c31807
< },
< "x-stripeBypassValidation": true
---
> }
26443a31941
> "balance_transaction",
26445a31944,31948
> "description",
> "destination",
> "failure_balance_transaction",
> "failure_code",
> "failure_message",
26447a31951
> "metadata",
26449a31954,31955
> "original_payout",
> "reversed_by",
26450a31957
> "statement_descriptor",
26463c31970,32022
< "x-resourceId": "payout"
---
> "x-resourceId": "payout",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/payouts/{payout}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/payouts"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/payouts"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/payouts/{payout}"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payouts/{payout}/cancel"
> },
> {
> "method_name": "reverse",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/payouts/{payout}/reverse"
> }
> ],
> "x-stripeResource": {
> "class_name": "Payout",
> "has_collection_class": true,
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
26480a32040,32043
> "required": [
> "end",
> "start"
> ],
26483c32046,32050
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Period",
> "in_class": "usage_record_summary"
> }
26501a32069
> "description": "The Kana variation of the person's address (Japan only).",
26509a32078
> "description": "The Kanji variation of the person's address (Japan only).",
26557a32127
> "description": "Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.",
26648a32219
> "description": "Information about the requirements for this person, including what information needs to be collected, and by when.",
26660d32230
< "account",
26678c32248,32320
< "x-resourceId": "person"
---
> "x-resourceId": "person",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/accounts/{account}/persons"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/accounts/{account}/persons"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/accounts/{account}/persons/{person}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/accounts/{account}/persons/{person}"
> },
> {
> "method_name": "create",
> "method_on": "collection",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/accounts/{account}/persons"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/accounts/{account}/persons"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/accounts/{account}/persons/{person}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/accounts/{account}/persons/{person}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Person",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "legal_entity_dob",
> "legal_entity_japan_address",
> "legal_entity_person_verification",
> "legal_entity_person_verification_document",
> "person_future_requirements",
> "person_relationship",
> "person_requirements"
> ]
> }
26731a32374
> "alternatives",
26743c32386,32390
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FutureRequirements",
> "in_class": "person"
> }
26779a32427,32434
> "required": [
> "director",
> "executive",
> "owner",
> "percent_ownership",
> "representative",
> "title"
> ],
26782c32437,32441
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Relationship",
> "in_class": "person"
> }
26835a32495
> "alternatives",
26847c32507,32511
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Requirements",
> "in_class": "person"
> }
27006a32671,32673
> "aggregate_usage",
> "amount",
> "amount_decimal",
27013a32681,32682
> "metadata",
> "nickname",
27014a32684,32687
> "product",
> "tiers_mode",
> "transform_usage",
> "trial_period_days",
27024c32697,32743
< "x-resourceId": "plan"
---
> "x-resourceId": "plan",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/plans"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/plans"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/plans/{plan}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/plans/{plan}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/plans/{plan}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Plan",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "plan_tier",
> "transform_usage"
> ]
> }
27056a32776,32782
> "required": [
> "flat_amount",
> "flat_amount_decimal",
> "unit_amount",
> "unit_amount_decimal",
> "up_to"
> ],
27059c32785,32789
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Tier",
> "in_class": "plan"
> }
27101c32831,32838
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PlatformTaxFee",
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
27124a32862,32866
> "required": [
> "headline",
> "privacy_policy_url",
> "terms_of_service_url"
> ],
27127c32869,32873
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BusinessProfile",
> "in_class": "billing_portal.configuration"
> }
27142c32888,32889
< "type": "string"
---
> "type": "string",
> "x-stripeBypassValidation": true
27157c32904,32908
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CustomerUpdate",
> "in_class": "portal_features"
> }
27198c32949,32961
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Features",
> "in_class": "billing_portal.configuration",
> "inner_classes": [
> "portal_customer_update",
> "portal_invoice_list",
> "portal_payment_method_update",
> "portal_subscription_cancel",
> "portal_subscription_pause",
> "portal_subscription_update"
> ]
> }
27213c32976,32980
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "InvoiceHistory",
> "in_class": "portal_features"
> }
27230c32997,32998
< "enabled"
---
> "enabled",
> "url"
27234c33002,33006
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "LoginPage",
> "in_class": "billing_portal.configuration"
> }
27249c33021,33025
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PaymentMethodUpdate",
> "in_class": "portal_features"
> }
27289c33065,33072
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SubscriptionCancel",
> "in_class": "portal_features",
> "inner_classes": [
> "portal_subscription_cancellation_reason"
> ]
> }
27322c33105,33109
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CancellationReason",
> "in_class": "portal_subscription_cancel"
> }
27337c33124,33128
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SubscriptionPause",
> "in_class": "portal_features"
> }
27378a33170
> "products",
27385c33177,33184
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SubscriptionUpdate",
> "in_class": "portal_features",
> "inner_classes": [
> "portal_subscription_update_product"
> ]
> }
27410c33209,33213
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Product",
> "in_class": "portal_subscription_update"
> }
27581a33385
> "custom_unit_amount",
27583a33388
> "lookup_key",
27584a33390
> "nickname",
27587c33393,33399
< "type"
---
> "recurring",
> "tax_behavior",
> "tiers_mode",
> "transform_quantity",
> "type",
> "unit_amount",
> "unit_amount_decimal"
27599c33411,33461
< "x-resourceId": "price"
---
> "x-resourceId": "price",
> "x-stripeOperations": [
> {
> "method_name": "search",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/prices/search"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/prices"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/prices"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/prices/{price}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/prices/{price}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Price",
> "has_collection_class": true,
> "has_search_result_class": true,
> "in_package": "",
> "inner_classes": [
> "currency_option",
> "custom_unit_amount",
> "price_tier",
> "recurring",
> "transform_quantity"
> ]
> }
27631a33494,33500
> "required": [
> "flat_amount",
> "flat_amount_decimal",
> "unit_amount",
> "unit_amount_decimal",
> "up_to"
> ],
27634c33503,33507
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Tier",
> "in_class": "price"
> }
27642a33516,33530
> "attributes": {
> "description": "A list of up to 5 attributes that each SKU can provide values for (e.g., `[\"color\", \"size\"]`).",
> "items": {
> "maxLength": 5000,
> "type": "string"
> },
> "nullable": true,
> "type": "array"
> },
> "caption": {
> "description": "A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of `type=good`.",
> "maxLength": 5000,
> "nullable": true,
> "type": "string"
> },
27647a33536,33543
> "deactivate_on": {
> "description": "An array of connect application identifiers that cannot purchase this product. Only applicable to products of `type=good`.",
> "items": {
> "maxLength": 5000,
> "type": "string"
> },
> "type": "array"
> },
27750a33647,33654
> "type": {
> "description": "The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.",
> "enum": [
> "good",
> "service"
> ],
> "type": "string"
> },
27770a33675
> "attributes",
27771a33677
> "description",
27778c33684,33689
< "updated"
---
> "package_dimensions",
> "shippable",
> "tax_code",
> "type",
> "updated",
> "url"
27787c33698,33748
< "x-resourceId": "product"
---
> "x-resourceId": "product",
> "x-stripeOperations": [
> {
> "method_name": "search",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/products/search"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/products"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/products/{id}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/products/{id}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/products"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/products/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Product",
> "has_collection_class": true,
> "has_search_result_class": true,
> "in_package": ""
> }
27883a33845,33846
> "customer",
> "expires_at",
27885a33849,33850
> "max_redemptions",
> "metadata",
27897c33862,33901
< "x-resourceId": "promotion_code"
---
> "x-resourceId": "promotion_code",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/promotion_codes/{promotion_code}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/promotion_codes"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/promotion_codes/{promotion_code}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/promotion_codes"
> }
> ],
> "x-stripeResource": {
> "class_name": "PromotionCode",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "promotion_code_currency_option",
> "promotion_codes_resource_restrictions"
> ]
> }
27912c33916,33920
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CurrencyOption",
> "in_class": "promotion_code"
> }
27941c33949,33951
< "first_time_transaction"
---
> "first_time_transaction",
> "minimum_amount",
> "minimum_amount_currency"
27947c33957,33961
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Restrictions",
> "in_class": "promotion_code"
> }
28338a34353,34355
> "application",
> "application_fee_amount",
> "application_fee_percent",
28342a34360,34362
> "currency",
> "customer",
> "description",
28344a34365,34367
> "footer",
> "from_quote",
> "header",
28345a34369,34370
> "invoice",
> "invoice_settings",
28347a34373
> "number",
28348a34375
> "on_behalf_of",
28350a34378
> "subscription",
28352c34380,34383
< "total_details"
---
> "subscription_schedule",
> "test_clock",
> "total_details",
> "transfer_data"
28376c34407,34496
< "x-resourceId": "quote"
---
> "x-resourceId": "quote",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/quotes/{quote}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/quotes"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/quotes/{quote}"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/quotes/{quote}/cancel"
> },
> {
> "method_name": "finalize_quote",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/quotes/{quote}/finalize"
> },
> {
> "method_name": "accept",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/quotes/{quote}/accept"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/quotes"
> },
> {
> "method_name": "list_line_items",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/quotes/{quote}/line_items"
> },
> {
> "method_name": "list_computed_upfront_line_items",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/quotes/{quote}/computed_upfront_line_items"
> },
> {
> "method_name": "pdf",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/quotes/{quote}/pdf"
> }
> ],
> "x-stripeResource": {
> "class_name": "Quote",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "invoice_setting_quote_setting",
> "quotes_resource_automatic_tax",
> "quotes_resource_computed",
> "quotes_resource_from_quote",
> "quotes_resource_recurring",
> "quotes_resource_status_transitions",
> "quotes_resource_subscription_data",
> "quotes_resource_total_details",
> "quotes_resource_transfer_data",
> "quotes_resource_upfront"
> ]
> }
28397c34517,34518
< "enabled"
---
> "enabled",
> "status"
28401c34522,34526
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "quote"
> }
28419a34545
> "recurring",
28427c34553,34557
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Computed",
> "in_class": "quote"
> }
28464c34594,34598
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FromQuote",
> "in_class": "quote"
> }
28506c34640,34644
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Recurring",
> "in_class": "quote"
> }
28529a34668,34672
> "required": [
> "accepted_at",
> "canceled_at",
> "finalized_at"
> ],
28532c34675,34679
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "quote"
> }
28554a34702,34706
> "required": [
> "description",
> "effective_date",
> "trial_period_days"
> ],
28557c34709,34713
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SubscriptionData",
> "in_class": "quote"
> }
28580a34737
> "amount_shipping",
28587c34744,34751
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TotalDetails",
> "in_class": "quote",
> "inner_classes": [
> "quotes_resource_total_details_resource_breakdown"
> ]
> }
28616c34780,34784
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Breakdown",
> "in_class": "quotes_resource_total_details"
> }
28651a34820,34821
> "amount",
> "amount_percent",
28658c34828,34832
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TransferData",
> "in_class": "quote"
> }
28724c34898,34902
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Upfront",
> "in_class": "quote"
> }
28813c34991,35012
< "x-resourceId": "radar.early_fraud_warning"
---
> "x-resourceId": "radar.early_fraud_warning",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/radar/early_fraud_warnings"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/radar/early_fraud_warnings/{early_fraud_warning}"
> }
> ],
> "x-stripeResource": {
> "class_name": "EarlyFraudWarning",
> "has_collection_class": true,
> "in_package": "Radar"
> }
28933c35132,35174
< "x-resourceId": "radar.value_list"
---
> "x-resourceId": "radar.value_list",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/radar/value_lists"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/radar/value_lists/{value_list}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/radar/value_lists"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/radar/value_lists/{value_list}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/radar/value_lists/{value_list}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ValueList",
> "has_collection_class": true,
> "in_package": "Radar"
> }
28987c35228,35263
< "x-resourceId": "radar.value_list_item"
---
> "x-resourceId": "radar.value_list_item",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/radar/value_list_items"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/radar/value_list_items/{item}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/radar/value_list_items"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/radar/value_list_items/{item}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ValueListItem",
> "has_collection_class": true,
> "in_package": "Radar"
> }
29000c35276,35280
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "RadarOptions",
> "in_class": "charge"
> }
29033a35314,35320
> "required": [
> "city",
> "country",
> "latitude",
> "longitude",
> "region"
> ],
29036c35323,35327
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Location",
> "in_class": "review"
> }
29065a35357,35362
> "required": [
> "browser",
> "device",
> "platform",
> "version"
> ],
29068c35365,35369
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Session",
> "in_class": "review"
> }
29092c35393,35397
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "FinancialAccount",
> "in_class": "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
> }
29121a35427,35431
> "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).",
> "nullable": true,
> "type": "integer"
> },
29131a35442
> "aggregate_usage",
29133a35445
> "trial_period_days",
29138c35450,35454
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Recurring",
> "in_class": "price"
> }
29340a35657,35658
> "balance_transaction",
> "charge",
29344c35662,35669
< "object"
---
> "metadata",
> "object",
> "payment_intent",
> "reason",
> "receipt_number",
> "source_transfer_reversal",
> "status",
> "transfer_reversal"
29357c35682,35752
< "x-resourceId": "refund"
---
> "x-resourceId": "refund",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/charges/{charge}/refunds"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/charges/{charge}/refunds/{refund}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/refunds"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/refunds"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/refunds/{refund}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/refunds/{refund}"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/refunds/{refund}/cancel"
> },
> {
> "method_name": "expire",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/refunds/{refund}/expire"
> }
> ],
> "x-stripeResource": {
> "class_name": "Refund",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "refund_next_action",
> "refund_next_action_display_details"
> ],
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
29377a35773
> "display_details",
29384c35780,35784
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "NextAction",
> "in_class": "refund"
> }
29406c35806,35813
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "NextActionDisplayDetails",
> "in_class": "refund",
> "inner_classes": [
> "email_sent"
> ]
> }
29468a35876
> "error",
29474c35882,35884
< "status"
---
> "result",
> "status",
> "succeeded_at"
29482c35892,35923
< "x-resourceId": "reporting.report_run"
---
> "x-resourceId": "reporting.report_run",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/reporting/report_runs/{report_run}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/reporting/report_runs"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/reporting/report_runs"
> }
> ],
> "x-stripeResource": {
> "class_name": "ReportRun",
> "has_collection_class": true,
> "in_package": "Reporting",
> "inner_classes": [
> "financial_reporting_finance_report_run_run_parameters"
> ]
> }
29539a35981
> "default_columns",
29550c35992,36013
< "x-resourceId": "reporting.report_type"
---
> "x-resourceId": "reporting.report_type",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/reporting/report_types/{report_type}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/reporting/report_types"
> }
> ],
> "x-stripeResource": {
> "class_name": "ReportType",
> "has_collection_class": true,
> "in_package": "Reporting"
> }
29583a36047
> "description",
29589c36053,36060
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ReserveTransaction",
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
29714a36186,36188
> "billing_zip",
> "charge",
> "closed_reason",
29716a36191,36192
> "ip_address",
> "ip_address_location",
29721c36197,36198
< "reason"
---
> "reason",
> "session"
29731c36208,36240
< "x-resourceId": "review"
---
> "x-resourceId": "review",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/reviews"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/reviews/{review}"
> },
> {
> "method_name": "approve",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/reviews/{review}/approve"
> }
> ],
> "x-stripeResource": {
> "class_name": "Review",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "radar_review_resource_location",
> "radar_review_resource_session"
> ]
> }
29759c36268,36272
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Rule",
> "in_package": "Radar"
> }
29825a36339
> "file",
29840c36354,36378
< "x-resourceId": "scheduled_query_run"
---
> "x-resourceId": "scheduled_query_run",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/sigma/scheduled_query_runs"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/sigma/scheduled_query_runs/{scheduled_query_run}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ScheduledQueryRun",
> "has_collection_class": true,
> "in_package": "Sigma",
> "inner_classes": [
> "sigma_scheduled_query_run_error"
> ]
> }
29855c36393,36397
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "subscription_schedule_phase_configuration"
> }
29879c36421,36425
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Scope",
> "in_class": "apps.secret"
> }
29924a36471,36474
> "required": [
> "charge",
> "setup_attempt"
> ],
29930c36480,36484
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "GeneratedFrom",
> "in_class": "payment_method_sepa_debit"
> }
30099a36654
> "application",
30100a36656,36657
> "customer",
> "flow_directions",
30103a36661
> "on_behalf_of",
30105a36664
> "setup_error",
30121c36680,36697
< "x-resourceId": "setup_attempt"
---
> "x-resourceId": "setup_attempt",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/setup_attempts"
> }
> ],
> "x-stripeResource": {
> "class_name": "SetupAttempt",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "setup_attempt_payment_method_details"
> ]
> }
30194c36770,36790
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodDetails",
> "in_class": "setup_attempt",
> "inner_classes": [
> "setup_attempt_payment_method_details_acss_debit",
> "setup_attempt_payment_method_details_au_becs_debit",
> "setup_attempt_payment_method_details_bacs_debit",
> "setup_attempt_payment_method_details_bancontact",
> "setup_attempt_payment_method_details_blik",
> "setup_attempt_payment_method_details_boleto",
> "setup_attempt_payment_method_details_card",
> "setup_attempt_payment_method_details_card_present",
> "setup_attempt_payment_method_details_ideal",
> "setup_attempt_payment_method_details_klarna",
> "setup_attempt_payment_method_details_link",
> "setup_attempt_payment_method_details_sepa_debit",
> "setup_attempt_payment_method_details_sofort",
> "setup_attempt_payment_method_details_us_bank_account"
> ]
> }
30201c36797,36801
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "setup_attempt_payment_method_details"
> }
30208c36808,36812
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AuBecsDebit",
> "in_class": "setup_attempt_payment_method_details"
> }
30215c36819,36823
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebit",
> "in_class": "setup_attempt_payment_method_details"
> }
30301a36910,36919
> "required": [
> "bank_code",
> "bank_name",
> "bic",
> "generated_sepa_debit",
> "generated_sepa_debit_mandate",
> "iban_last4",
> "preferred_language",
> "verified_name"
> ],
30307c36925,36929
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Bancontact",
> "in_class": "setup_attempt_payment_method_details"
> }
30314c36936,36940
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Blik",
> "in_class": "setup_attempt_payment_method_details"
> }
30321c36947,36951
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Boleto",
> "in_class": "setup_attempt_payment_method_details"
> }
30335a36966,36968
> "required": [
> "three_d_secure"
> ],
30340c36973,36977
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "setup_attempt_payment_method_details"
> }
30365a37003,37005
> "required": [
> "generated_card"
> ],
30370c37010,37014
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "CardPresent",
> "in_class": "setup_attempt_payment_method_details"
> }
30467a37112,37119
> "required": [
> "bank",
> "bic",
> "generated_sepa_debit",
> "generated_sepa_debit_mandate",
> "iban_last4",
> "verified_name"
> ],
30473c37125,37129
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Ideal",
> "in_class": "setup_attempt_payment_method_details"
> }
30480c37136,37140
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Klarna",
> "in_class": "setup_attempt_payment_method_details"
> }
30487c37147,37151
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Link",
> "in_class": "setup_attempt_payment_method_details"
> }
30494c37158,37162
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "setup_attempt_payment_method_details"
> }
30580a37249,37258
> "required": [
> "bank_code",
> "bank_name",
> "bic",
> "generated_sepa_debit",
> "generated_sepa_debit_mandate",
> "iban_last4",
> "preferred_language",
> "verified_name"
> ],
30586c37264,37268
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Sofort",
> "in_class": "setup_attempt_payment_method_details"
> }
30593c37275,37279
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "setup_attempt_payment_method_details"
> }
30865a37552,37554
> "application",
> "cancellation_reason",
> "client_secret",
30866a37556,37558
> "customer",
> "description",
> "flow_directions",
30867a37560,37561
> "last_setup_error",
> "latest_attempt",
30868a37563,37565
> "mandate",
> "metadata",
> "next_action",
30869a37567,37569
> "on_behalf_of",
> "payment_method",
> "payment_method_options",
30870a37571
> "single_use_mandate",
30888c37589,37650
< "x-resourceId": "setup_intent"
---
> "x-resourceId": "setup_intent",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/setup_intents"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/setup_intents"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/setup_intents/{intent}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/setup_intents/{intent}"
> },
> {
> "method_name": "confirm",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/setup_intents/{intent}/confirm"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/setup_intents/{intent}/cancel"
> },
> {
> "method_name": "verify_microdeposits",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/setup_intents/{intent}/verify_microdeposits"
> }
> ],
> "x-stripeResource": {
> "class_name": "SetupIntent",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "setup_intent_next_action",
> "setup_intent_next_action_redirect_to_url",
> "setup_intent_payment_method_options"
> ]
> }
30917c37679,37686
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "NextAction",
> "in_class": "setup_intent",
> "inner_classes": [
> "setup_intent_next_action_verify_with_microdeposits"
> ]
> }
30934a37704,37707
> "required": [
> "return_url",
> "url"
> ],
30937c37710,37714
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "NextActionRedirectToUrl",
> "in_class": "setup_intent"
> }
30964c37741,37742
< "hosted_verification_url"
---
> "hosted_verification_url",
> "microdeposit_type"
30968c37746,37750
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "VerifyWithMicrodeposits",
> "in_class": "setup_intent_next_action"
> }
30974,30981c37756
< "anyOf": [
< {
< "$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit"
< },
< {
< "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit"
30984,30991c37759
< "anyOf": [
< {
< "$ref": "#/components/schemas/setup_intent_payment_method_options_blik"
< },
< {
< "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/setup_intent_payment_method_options_blik"
30997,31004c37765
< "anyOf": [
< {
< "$ref": "#/components/schemas/setup_intent_payment_method_options_link"
< },
< {
< "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/setup_intent_payment_method_options_link"
31007,31014c37768
< "anyOf": [
< {
< "$ref": "#/components/schemas/setup_intent_payment_method_options_sepa_debit"
< },
< {
< "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/setup_intent_payment_method_options_sepa_debit"
31017,31024c37771
< "anyOf": [
< {
< "$ref": "#/components/schemas/setup_intent_payment_method_options_us_bank_account"
< },
< {
< "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
< }
< ]
---
> "$ref": "#/components/schemas/setup_intent_payment_method_options_us_bank_account"
31036c37783,37797
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodOptions",
> "in_class": "setup_intent",
> "inner_classes": [
> "setup_intent_payment_method_options_acss_debit",
> "setup_intent_payment_method_options_blik",
> "setup_intent_payment_method_options_card",
> "setup_intent_payment_method_options_link",
> "setup_intent_payment_method_options_mandate_options_blik",
> "setup_intent_payment_method_options_mandate_options_sepa_debit",
> "setup_intent_payment_method_options_sepa_debit",
> "setup_intent_payment_method_options_us_bank_account"
> ]
> }
31063a37825,37827
> "required": [
> "currency"
> ],
31068c37832,37839
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "setup_intent_payment_method_options",
> "inner_classes": [
> "setup_intent_payment_method_options_mandate_options_acss_debit"
> ]
> }
31081c37852,37856
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Blik",
> "in_class": "setup_intent_payment_method_options"
> }
31122a37898,37902
> "required": [
> "mandate_options",
> "network",
> "request_three_d_secure"
> ],
31127c37907,37914
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "setup_intent_payment_method_options",
> "inner_classes": [
> "setup_intent_payment_method_options_card_mandate_options"
> ]
> }
31201a37989,37990
> "description",
> "end_date",
31202a37992
> "interval_count",
31204c37994,37995
< "start_date"
---
> "start_date",
> "supported_types"
31208c37999,38003
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MandateOptions",
> "in_class": "setup_intent_payment_method_options_card"
> }
31219a38015,38017
> "required": [
> "persistent_token"
> ],
31222c38020,38024
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Link",
> "in_class": "setup_intent_payment_method_options"
> }
31268a38071,38075
> "required": [
> "interval_description",
> "payment_schedule",
> "transaction_type"
> ],
31271c38078,38082
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "MandateOptions",
> "in_class": "setup_intent_payment_method_options_acss_debit"
> }
31294a38106,38109
> "required": [
> "expires_after",
> "type"
> ],
31299c38114,38118
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BlikMandateOptions",
> "in_class": "setup_intent_payment_method_options"
> }
31306c38125,38129
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebitMandateOptions",
> "in_class": "setup_intent_payment_method_options"
> }
31319c38142,38146
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "setup_intent_payment_method_options"
> }
31342c38169,38173
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "setup_intent_payment_method_options"
> }
31360c38191,38195
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SetupIntentTypeSpecificPaymentMethodOptionsClient",
> "in_package": ""
> }
31396c38231,38235
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ShippingDetails",
> "in_package": ""
> }
31492a38332,38333
> "delivery_estimate",
> "display_name",
31496a38338,38339
> "tax_behavior",
> "tax_code",
31506c38349,38389
< "x-resourceId": "shipping_rate"
---
> "x-resourceId": "shipping_rate",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/shipping_rates"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/shipping_rates/{shipping_rate_token}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/shipping_rates"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/shipping_rates/{shipping_rate_token}"
> }
> ],
> "x-stripeResource": {
> "class_name": "ShippingRate",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "shipping_rate_currency_option",
> "shipping_rate_delivery_estimate",
> "shipping_rate_fixed_amount"
> ]
> }
31531c38414,38418
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CurrencyOption",
> "in_class": "shipping_rate"
> }
31554a38442,38445
> "required": [
> "maximum",
> "minimum"
> ],
31560c38451,38458
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "DeliveryEstimate",
> "in_class": "shipping_rate",
> "inner_classes": [
> "shipping_rate_delivery_estimate_bound"
> ]
> }
31587c38485,38489
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "DeliveryEstimateBound",
> "in_class": "shipping_rate_delivery_estimate"
> }
31616c38518,38522
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FixedAmount",
> "in_class": "shipping_rate"
> }
31632c38538,38542
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "RunError",
> "in_class": "scheduled_query_run"
> }
31734a38645
> "image",
31738a38650
> "package_dimensions",
31750c38662,38707
< "x-resourceId": "sku"
---
> "x-resourceId": "sku",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/skus/{id}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/skus"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/skus/{id}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/skus"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/skus/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Sku",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "sku_inventory"
> ]
> }
31773c38730,38732
< "type"
---
> "quantity",
> "type",
> "value"
31777c38736,38740
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Inventory",
> "in_class": "sku"
> }
31896a38860,38862
> "sepa_credit_transfer": {
> "$ref": "#/components/schemas/source_type_sepa_credit_transfer"
> },
31936a38903
> "sepa_credit_transfer",
31955a38923
> "amount",
31957a38926
> "currency",
31960a38930
> "metadata",
31961a38932,38933
> "owner",
> "statement_descriptor",
31963c38935,38936
< "type"
---
> "type",
> "usage"
31974c38947,39026
< "x-resourceId": "source"
---
> "x-resourceId": "source",
> "x-stripeOperations": [
> {
> "method_name": "detach",
> "method_on": "service",
> "method_type": "custom",
> "operation": "delete",
> "path": "/v1/customers/{customer}/sources/{id}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/sources/{source}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/sources"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/sources/{source}"
> },
> {
> "method_name": "verify",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/sources/{source}/verify"
> },
> {
> "method_name": "source_transactions",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/sources/{source}/source_transactions"
> }
> ],
> "x-stripeResource": {
> "class_name": "Source",
> "in_package": "",
> "inner_classes": [
> "source_code_verification_flow",
> "source_order",
> "source_order_item",
> "source_owner",
> "source_receiver_flow",
> "source_redirect_flow",
> "source_type_ach_credit_transfer",
> "source_type_ach_debit",
> "source_type_acss_debit",
> "source_type_alipay",
> "source_type_au_becs_debit",
> "source_type_bancontact",
> "source_type_card",
> "source_type_card_present",
> "source_type_eps",
> "source_type_giropay",
> "source_type_ideal",
> "source_type_klarna",
> "source_type_multibanco",
> "source_type_p24",
> "source_type_sepa_credit_transfer",
> "source_type_sepa_debit",
> "source_type_sofort",
> "source_type_three_d_secure",
> "source_type_wechat"
> ],
> "polymorphic_groups": [
> "deleted_payment_source",
> "payment_source"
> ]
> }
31995c39047,39051
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CodeVerificationFlow",
> "in_class": "source"
> }
32054a39111
> "amount",
32072c39129,39137
< "x-resourceId": "source_mandate_notification"
---
> "x-stripeResource": {
> "class_name": "SourceMandateNotification",
> "in_package": "",
> "inner_classes": [
> "source_mandate_notification_acss_debit_data",
> "source_mandate_notification_bacs_debit_data",
> "source_mandate_notification_sepa_debit_data"
> ]
> }
32085c39150,39154
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AcssDebitData",
> "in_class": "source_mandate_notification"
> }
32098c39167,39171
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BacsDebitData",
> "in_class": "source_mandate_notification"
> }
32121c39194,39198
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaDebitData",
> "in_class": "source_mandate_notification"
> }
32153c39230,39231
< "currency"
---
> "currency",
> "items"
32160c39238,39242
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Order",
> "in_class": "source"
> }
32198a39281,39287
> "required": [
> "amount",
> "currency",
> "description",
> "parent",
> "type"
> ],
32201c39290,39294
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "OrderItem",
> "in_class": "source"
> }
32260a39354,39363
> "required": [
> "address",
> "email",
> "name",
> "phone",
> "verified_address",
> "verified_email",
> "verified_name",
> "verified_phone"
> ],
32266c39369,39373
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Owner",
> "in_class": "source"
> }
32300a39408
> "address",
32309c39417,39421
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ReceiverFlow",
> "in_class": "source"
> }
32336a39449
> "failure_reason",
32343c39456,39460
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "RedirectFlow",
> "in_class": "source"
> }
32445c39562,39574
< "x-resourceId": "source_transaction"
---
> "x-resourceId": "source_transaction",
> "x-stripeResource": {
> "class_name": "SourceTransaction",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "source_transaction_ach_credit_transfer_data",
> "source_transaction_chf_credit_transfer_data",
> "source_transaction_gbp_credit_transfer_data",
> "source_transaction_paper_check_data",
> "source_transaction_sepa_credit_transfer_data"
> ]
> }
32473c39602,39606
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AchCreditTransferData",
> "in_class": "source_transaction"
> }
32506c39639,39643
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ChfCreditTransferData",
> "in_class": "source_transaction"
> }
32549c39686,39690
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "GbpCreditTransferData",
> "in_class": "source_transaction"
> }
32567c39708,39712
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PaperCheckData",
> "in_class": "source_transaction"
> }
32590c39735,39739
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "SepaCreditTransferData",
> "in_class": "source_transaction"
> }
32627c39776,39780
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "AchCreditTransfer",
> "in_class": "source"
> }
32656c39809,39813
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "AchDebit",
> "in_class": "source"
> }
32701c39858,39862
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "AcssDebit",
> "in_class": "source"
> }
32718c39879,39883
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Alipay",
> "in_class": "source"
> }
32735c39900,39904
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "AuBecsDebit",
> "in_class": "source"
> }
32764c39933,39937
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Bancontact",
> "in_class": "source"
> }
32787a39961,39963
> "description": {
> "type": "string"
> },
32806a39983,39988
> "iin": {
> "type": "string"
> },
> "issuer": {
> "type": "string"
> },
32823c40005,40009
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "source"
> }
32857a40044,40046
> "description": {
> "type": "string"
> },
32883a40073,40078
> "iin": {
> "type": "string"
> },
> "issuer": {
> "type": "string"
> },
32910c40105,40109
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "CardPresent",
> "in_class": "source"
> }
32923c40122,40126
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Eps",
> "in_class": "source"
> }
32944c40147,40151
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Giropay",
> "in_class": "source"
> }
32965c40172,40176
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Ideal",
> "in_class": "source"
> }
33049c40260,40264
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Klarna",
> "in_class": "source"
> }
33094c40309,40313
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Multibanco",
> "in_class": "source"
> }
33103c40322,40379
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "P24",
> "in_class": "source"
> }
> },
> "source_type_sepa_credit_transfer": {
> "properties": {
> "bank_name": {
> "nullable": true,
> "type": "string"
> },
> "bic": {
> "nullable": true,
> "type": "string"
> },
> "iban": {
> "nullable": true,
> "type": "string"
> },
> "refund_account_holder_address_city": {
> "nullable": true,
> "type": "string"
> },
> "refund_account_holder_address_country": {
> "nullable": true,
> "type": "string"
> },
> "refund_account_holder_address_line1": {
> "nullable": true,
> "type": "string"
> },
> "refund_account_holder_address_line2": {
> "nullable": true,
> "type": "string"
> },
> "refund_account_holder_address_postal_code": {
> "nullable": true,
> "type": "string"
> },
> "refund_account_holder_address_state": {
> "nullable": true,
> "type": "string"
> },
> "refund_account_holder_name": {
> "nullable": true,
> "type": "string"
> },
> "refund_iban": {
> "nullable": true,
> "type": "string"
> }
> },
> "type": "object",
> "x-stripeResource": {
> "class_name": "SepaCreditTransfer",
> "in_class": "source"
> }
33136c40412,40416
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "SepaDebit",
> "in_class": "source"
> }
33169c40449,40453
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Sofort",
> "in_class": "source"
> }
33204a40489,40491
> "description": {
> "type": "string"
> },
33223a40511,40516
> "iin": {
> "type": "string"
> },
> "issuer": {
> "type": "string"
> },
33240c40533,40537
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "ThreeDSecure",
> "in_class": "source"
> }
33255c40552,40556
< "type": "object"
---
> "type": "object",
> "x-stripeResource": {
> "class_name": "Wechat",
> "in_class": "source"
> }
33408,33414c40709
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
---
> "$ref": "#/components/schemas/payment_source"
33422,33428c40717
< "$ref": "#/components/schemas/bank_account"
< },
< {
< "$ref": "#/components/schemas/card"
< },
< {
< "$ref": "#/components/schemas/source"
---
> "$ref": "#/components/schemas/payment_source"
33431,33432c40720
< },
< "x-stripeBypassValidation": true
---
> }
33709a40998,40999
> "application",
> "application_fee_percent",
33711a41002,41003
> "billing_thresholds",
> "cancel_at",
33712a41005
> "canceled_at",
33718a41012,41017
> "days_until_due",
> "default_payment_method",
> "default_source",
> "description",
> "discount",
> "ended_at",
33720a41020
> "latest_invoice",
33722a41023
> "next_pending_invoice_item_invoice",
33723a41025,41031
> "on_behalf_of",
> "pause_collection",
> "payment_settings",
> "pending_invoice_item_interval",
> "pending_setup_intent",
> "pending_update",
> "schedule",
33725c41033,41037
< "status"
---
> "status",
> "test_clock",
> "transfer_data",
> "trial_end",
> "trial_start"
33750c41062,41129
< "x-resourceId": "subscription"
---
> "x-resourceId": "subscription",
> "x-stripeOperations": [
> {
> "method_name": "search",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/subscriptions/search"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/subscriptions"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/subscriptions"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/subscriptions/{subscription_exposed_id}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/subscriptions/{subscription_exposed_id}"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "delete",
> "path": "/v1/subscriptions/{subscription_exposed_id}"
> },
> {
> "method_name": "delete_discount",
> "method_on": "service",
> "method_type": "custom",
> "operation": "delete",
> "path": "/v1/subscriptions/{subscription_exposed_id}/discount"
> }
> ],
> "x-stripeResource": {
> "class_name": "Subscription",
> "has_collection_class": true,
> "has_search_result_class": true,
> "in_package": "",
> "inner_classes": [
> "subscription_automatic_tax",
> "subscription_billing_thresholds",
> "subscription_pending_invoice_item_interval",
> "subscription_transfer_data",
> "subscriptions_resource_pause_collection",
> "subscriptions_resource_payment_method_options",
> "subscriptions_resource_payment_settings",
> "subscriptions_resource_pending_update"
> ]
> }
33765c41144,41148
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "subscription"
> }
33780a41164,41167
> "required": [
> "amount_gte",
> "reset_billing_cycle_anchor"
> ],
33783c41170,41174
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BillingThresholds",
> "in_class": "subscription"
> }
33820a41212,41214
> "plan": {
> "$ref": "#/components/schemas/plan"
> },
33842a41237
> "billing_thresholds",
33846a41242
> "plan",
33848c41244,41245
< "subscription"
---
> "subscription",
> "tax_rates"
33853a41251
> "plan",
33857c41255,41307
< "x-resourceId": "subscription_item"
---
> "x-resourceId": "subscription_item",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/subscription_items"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/subscription_items/{item}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/subscription_items"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/subscription_items/{item}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/subscription_items/{item}"
> },
> {
> "method_name": "usage_record_summaries",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/subscription_items/{subscription_item}/usage_record_summaries"
> }
> ],
> "x-stripeResource": {
> "class_name": "SubscriptionItem",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "subscription_item_billing_thresholds"
> ]
> }
33867a41318,41320
> "required": [
> "usage_gte"
> ],
33870c41323,41327
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BillingThresholds",
> "in_class": "subscription_item"
> }
33904a41362,41365
> "required": [
> "network",
> "request_three_d_secure"
> ],
33909c41370,41377
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Card",
> "in_class": "subscriptions_resource_payment_method_options",
> "inner_classes": [
> "invoice_mandate_options_card"
> ]
> }
33935c41403,41407
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PendingInvoiceItemInterval",
> "in_class": "subscription"
> }
34126a41599,41601
> "application",
> "canceled_at",
> "completed_at",
34127a41603
> "current_phase",
34132a41609
> "metadata",
34135c41612,41616
< "status"
---
> "released_at",
> "released_subscription",
> "status",
> "subscription",
> "test_clock"
34148c41629,41686
< "x-resourceId": "subscription_schedule"
---
> "x-resourceId": "subscription_schedule",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/subscription_schedules"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/subscription_schedules"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/subscription_schedules/{schedule}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/subscription_schedules/{schedule}"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/subscription_schedules/{schedule}/cancel"
> },
> {
> "method_name": "release",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/subscription_schedules/{schedule}/release"
> }
> ],
> "x-stripeResource": {
> "class_name": "SubscriptionSchedule",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "invoice_setting_subscription_schedule_setting",
> "subscription_schedule_add_invoice_item",
> "subscription_schedule_configuration_item",
> "subscription_schedule_current_phase",
> "subscription_schedule_phase_configuration",
> "subscription_schedules_resource_default_settings"
> ]
> }
34193c41731,41732
< "price"
---
> "price",
> "quantity"
34200c41739,41743
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AddInvoiceItem",
> "in_class": "subscription_schedule"
> }
34213a41757,41781
> "plan": {
> "anyOf": [
> {
> "maxLength": 5000,
> "type": "string"
> },
> {
> "$ref": "#/components/schemas/plan"
> },
> {
> "$ref": "#/components/schemas/deleted_plan"
> }
> ],
> "description": "ID of the plan to which the customer should be subscribed.",
> "x-expansionResources": {
> "oneOf": [
> {
> "$ref": "#/components/schemas/plan"
> },
> {
> "$ref": "#/components/schemas/deleted_plan"
> }
> ]
> }
> },
34252a41821,41822
> "billing_thresholds",
> "plan",
34258a41829
> "plan",
34261c41832,41836
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PhaseItem",
> "in_class": "subscription_schedule"
> }
34283c41858,41862
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CurrentPhase",
> "in_class": "subscription_schedule"
> }
34475a42055,42059
> "application_fee_percent",
> "billing_cycle_anchor",
> "billing_thresholds",
> "collection_method",
> "coupon",
34476a42061,42062
> "default_payment_method",
> "description",
34477a42064
> "invoice_settings",
34478a42066,42067
> "metadata",
> "on_behalf_of",
34480c42069,42071
< "start_date"
---
> "start_date",
> "transfer_data",
> "trial_end"
34495c42086,42093
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Phase",
> "in_class": "subscription_schedule",
> "inner_classes": [
> "schedules_phase_automatic_tax"
> ]
> }
34600c42198,42206
< "billing_cycle_anchor"
---
> "application_fee_percent",
> "billing_cycle_anchor",
> "billing_thresholds",
> "collection_method",
> "default_payment_method",
> "description",
> "invoice_settings",
> "on_behalf_of",
> "transfer_data"
34611c42217,42224
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "DefaultSettings",
> "in_class": "subscription_schedule",
> "inner_classes": [
> "subscription_schedules_resource_default_settings_automatic_tax"
> ]
> }
34626c42239,42243
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "AutomaticTax",
> "in_class": "subscription_schedules_resource_default_settings"
> }
34656a42274
> "amount_percent",
34663c42281,42285
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TransferData",
> "in_class": "subscription"
> }
34685c42307,42308
< "behavior"
---
> "behavior",
> "resumes_at"
34689c42312,42316
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PauseCollection",
> "in_class": "subscription"
> }
34748a42376,42383
> "required": [
> "acss_debit",
> "bancontact",
> "card",
> "customer_balance",
> "konbini",
> "us_bank_account"
> ],
34758c42393,42400
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentMethodOptions",
> "in_class": "subscription",
> "inner_classes": [
> "subscription_payment_method_options_card"
> ]
> }
34792a42435
> "sepa_credit_transfer",
34813a42457,42461
> "required": [
> "payment_method_options",
> "payment_method_types",
> "save_default_payment_method"
> ],
34818c42466,42470
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PaymentSettings",
> "in_class": "subscription"
> }
34855c42507,42511
< "expires_at"
---
> "billing_cycle_anchor",
> "expires_at",
> "subscription_items",
> "trial_end",
> "trial_from_plan"
34861c42517,42521
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "PendingUpdate",
> "in_class": "subscription"
> }
34898c42558,42579
< "x-resourceId": "tax_code"
---
> "x-resourceId": "tax_code",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/tax_codes"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/tax_codes/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "TaxCode",
> "has_collection_class": true,
> "in_package": ""
> }
34940c42621,42628
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TaxDeductedAtSource",
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
35065a42754
> "country",
35066a42756
> "customer",
35071c42761,42762
< "value"
---
> "value",
> "verification"
35079c42770,42829
< "x-resourceId": "tax_id"
---
> "x-resourceId": "tax_id",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "collection",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/customers/{customer}/tax_ids"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/customers/{customer}/tax_ids"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/tax_ids/{id}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/customers/{customer}/tax_ids/{id}"
> },
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/tax_ids"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/customers/{customer}/tax_ids"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/customers/{customer}/tax_ids/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "TaxId",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "tax_id_verification"
> ]
> }
35108c42858,42860
< "status"
---
> "status",
> "verified_address",
> "verified_name"
35112c42864,42868
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Verification",
> "in_class": "tax_id"
> }
35205a42962
> "country",
35206a42964
> "description",
35209a42968
> "jurisdiction",
35210a42970
> "metadata",
35212c42972,42974
< "percentage"
---
> "percentage",
> "state",
> "tax_type"
35217c42979,43014
< "x-resourceId": "tax_rate"
---
> "x-resourceId": "tax_rate",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/tax_rates"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/tax_rates/{tax_rate}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/tax_rates"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/tax_rates/{tax_rate}"
> }
> ],
> "x-stripeResource": {
> "class_name": "TaxRate",
> "has_collection_class": true,
> "in_package": ""
> }
35254a43052
> "is_account_default",
35265c43063,43110
< "x-resourceId": "terminal.configuration"
---
> "x-resourceId": "terminal.configuration",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/terminal/configurations"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/terminal/configurations"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/terminal/configurations/{configuration}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/terminal/configurations/{configuration}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/terminal/configurations/{configuration}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Configuration",
> "has_collection_class": true,
> "in_package": "Terminal",
> "inner_classes": [
> "terminal_configuration_configuration_resource_currency_specific_config",
> "terminal_configuration_configuration_resource_device_type_specific_config",
> "terminal_configuration_configuration_resource_tipping"
> ]
> }
35295c43140,43153
< "x-resourceId": "terminal.connection_token"
---
> "x-resourceId": "terminal.connection_token",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/terminal/connection_tokens"
> }
> ],
> "x-stripeResource": {
> "class_name": "ConnectionToken",
> "in_package": "Terminal"
> }
35351c43209,43251
< "x-resourceId": "terminal.location"
---
> "x-resourceId": "terminal.location",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/terminal/locations/{location}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/terminal/locations"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/terminal/locations/{location}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/terminal/locations"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/terminal/locations/{location}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Location",
> "has_collection_class": true,
> "in_package": "Terminal"
> }
35450a43351,43352
> "action",
> "device_sw_version",
35452a43355
> "ip_address",
35454a43358
> "location",
35457c43361,43362
< "serial_number"
---
> "serial_number",
> "status"
35465c43370,43450
< "x-resourceId": "terminal.reader"
---
> "x-resourceId": "terminal.reader",
> "x-stripeOperations": [
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/terminal/readers/{reader}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/terminal/readers/{reader}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/terminal/readers"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/terminal/readers"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/terminal/readers/{reader}"
> },
> {
> "method_name": "process_payment_intent",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/terminal/readers/{reader}/process_payment_intent"
> },
> {
> "method_name": "process_setup_intent",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/terminal/readers/{reader}/process_setup_intent"
> },
> {
> "method_name": "cancel_action",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/terminal/readers/{reader}/cancel_action"
> },
> {
> "method_name": "set_reader_display",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/terminal/readers/{reader}/set_reader_display"
> },
> {
> "method_name": "present_payment_method",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/terminal/readers/{reader}/present_payment_method"
> }
> ],
> "x-stripeResource": {
> "class_name": "Reader",
> "has_collection_class": true,
> "in_package": "Terminal",
> "inner_classes": [
> "terminal_reader_reader_resource_reader_action"
> ]
> }
35493c43478,43482
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "CurrencySpecificConfig",
> "in_class": "terminal.configuration"
> }
35522c43511,43515
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "DeviceTypeSpecificConfig",
> "in_class": "terminal.configuration"
> }
35587c43580,43584
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Tipping",
> "in_class": "terminal.configuration"
> }
35615a43613
> "tax",
35622c43620,43627
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "Cart",
> "in_class": "terminal_reader_reader_resource_set_reader_display_action",
> "inner_classes": [
> "terminal_reader_reader_resource_line_item"
> ]
> }
35648c43653,43657
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "LineItem",
> "in_class": "terminal_reader_reader_resource_cart"
> }
35665c43674,43678
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ProcessConfig",
> "in_class": "terminal_reader_reader_resource_process_payment_intent_action"
> }
35701c43714,43722
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ProcessPaymentIntentAction",
> "in_class": "terminal_reader_reader_resource_reader_action",
> "inner_classes": [
> "terminal_reader_reader_resource_process_config",
> "terminal_reader_reader_resource_tipping_config"
> ]
> }
35738c43759,43763
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ProcessSetupIntentAction",
> "in_class": "terminal_reader_reader_resource_reader_action"
> }
35784a43810,43811
> "failure_code",
> "failure_message",
35794c43821,43830
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ReaderAction",
> "in_class": "terminal.reader",
> "inner_classes": [
> "terminal_reader_reader_resource_process_payment_intent_action",
> "terminal_reader_reader_resource_process_setup_intent_action",
> "terminal_reader_reader_resource_set_reader_display_action"
> ]
> }
35816a43853
> "cart",
35823c43860,43867
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SetReaderDisplayAction",
> "in_class": "terminal_reader_reader_resource_reader_action",
> "inner_classes": [
> "terminal_reader_reader_resource_cart"
> ]
> }
35835c43879,43883
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TippingConfig",
> "in_class": "terminal_reader_reader_resource_process_payment_intent_action"
> }
35892a43941
> "name",
35899c43948,43990
< "x-resourceId": "test_helpers.test_clock"
---
> "x-resourceId": "test_helpers.test_clock",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/test_helpers/test_clocks/{test_clock}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/test_helpers/test_clocks"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/test_helpers/test_clocks/{test_clock}"
> },
> {
> "method_name": "advance",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/test_clocks/{test_clock}/advance"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/test_helpers/test_clocks"
> }
> ],
> "x-stripeResource": {
> "class_name": "TestClock",
> "has_collection_class": true,
> "in_package": "TestHelpers"
> }
35951a44043,44048
> "required": [
> "authentication_flow",
> "result",
> "result_reason",
> "version"
> ],
35954c44051,44055
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ThreeDSecure",
> "in_class": "payment_method_details_card"
> }
35969c44070,44074
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ThreeDSecureUsage",
> "in_class": "payment_method_card"
> }
36017a44123
> "client_ip",
36031c44137,44157
< "x-resourceId": "token"
---
> "x-resourceId": "token",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/tokens/{token}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/tokens"
> }
> ],
> "x-stripeResource": {
> "class_name": "Token",
> "in_package": ""
> }
36151a44278
> "balance_transaction",
36153a44281,44284
> "description",
> "expected_availability_date",
> "failure_code",
> "failure_message",
36158c44289,44292
< "status"
---
> "source",
> "statement_descriptor",
> "status",
> "transfer_group"
36166c44300,44345
< "x-resourceId": "topup"
---
> "x-resourceId": "topup",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/topups"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/topups"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/topups/{topup}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/topups/{topup}"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/topups/{topup}/cancel"
> }
> ],
> "x-stripeResource": {
> "class_name": "Topup",
> "has_collection_class": true,
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
36354a44534
> "balance_transaction",
36356a44537,44538
> "description",
> "destination",
36362c44544,44546
< "reversed"
---
> "reversed",
> "source_transaction",
> "transfer_group"
36373c44557,44595
< "x-resourceId": "transfer"
---
> "x-resourceId": "transfer",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/transfers"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/transfers"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/transfers/{transfer}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/transfers/{transfer}"
> }
> ],
> "x-stripeResource": {
> "class_name": "Transfer",
> "has_collection_class": true,
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
36409c44631,44635
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "TransferData",
> "in_class": "payment_intent"
> }
36529a44756
> "balance_transaction",
36531a44759
> "destination_payment_refund",
36532a44761
> "metadata",
36533a44763
> "source_refund",
36544c44774,44833
< "x-resourceId": "transfer_reversal"
---
> "x-resourceId": "transfer_reversal",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "collection",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/transfers/{id}/reversals"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/transfers/{id}/reversals"
> },
> {
> "method_name": "list",
> "method_on": "collection",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/transfers/{id}/reversals"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/transfers/{id}/reversals"
> },
> {
> "method_name": "retrieve",
> "method_on": "collection",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/transfers/{transfer}/reversals/{id}"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/transfers/{transfer}/reversals/{id}"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/transfers/{transfer}/reversals/{id}"
> }
> ],
> "x-stripeResource": {
> "class_name": "TransferReversal",
> "has_collection_class": true,
> "in_package": "",
> "polymorphic_groups": [
> "balance_transaction_source"
> ]
> }
36574c44863,44867
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PayoutSchedule",
> "in_class": "account"
> }
36598c44891,44895
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TransformQuantity",
> "in_class": "price"
> }
36622c44919,44923
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "TransformUsage",
> "in_class": "plan"
> }
36725a45027
> "hosted_regulatory_receipt_url",
36733c45035,45036
< "status_transitions"
---
> "status_transitions",
> "transaction"
36741c45044,45072
< "x-resourceId": "treasury.credit_reversal"
---
> "x-resourceId": "treasury.credit_reversal",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/credit_reversals"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/credit_reversals/{credit_reversal}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/treasury/credit_reversals"
> }
> ],
> "x-stripeResource": {
> "class_name": "CreditReversal",
> "has_collection_class": true,
> "in_package": "Treasury"
> }
36853a45185,45186
> "financial_account",
> "hosted_regulatory_receipt_url",
36854a45188
> "linked_flows",
36861c45195,45196
< "status_transitions"
---
> "status_transitions",
> "transaction"
36870c45205,45236
< "x-resourceId": "treasury.debit_reversal"
---
> "x-resourceId": "treasury.debit_reversal",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/treasury/debit_reversals"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/debit_reversals/{debit_reversal}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/debit_reversals"
> }
> ],
> "x-stripeResource": {
> "class_name": "DebitReversal",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "treasury_received_debits_resource_debit_reversal_linked_flows"
> ]
> }
37018a45385
> "metadata",
37033c45400,45456
< "x-resourceId": "treasury.financial_account"
---
> "x-resourceId": "treasury.financial_account",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/treasury/financial_accounts"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/treasury/financial_accounts/{financial_account}"
> },
> {
> "method_name": "update_features",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/treasury/financial_accounts/{financial_account}/features"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/financial_accounts"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/financial_accounts/{financial_account}"
> },
> {
> "method_name": "retrieve_features",
> "method_on": "service",
> "method_type": "custom",
> "operation": "get",
> "path": "/v1/treasury/financial_accounts/{financial_account}/features"
> }
> ],
> "x-stripeResource": {
> "class_name": "FinancialAccount",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "treasury_financial_accounts_resource_ach_toggle_settings",
> "treasury_financial_accounts_resource_balance",
> "treasury_financial_accounts_resource_financial_address",
> "treasury_financial_accounts_resource_status_details",
> "treasury_financial_accounts_resource_toggle_settings"
> ]
> }
37081c45504,45515
< "x-resourceId": "treasury.financial_account_features"
---
> "x-resourceId": "treasury.financial_account_features",
> "x-stripeResource": {
> "class_name": "FinancialAccountFeatures",
> "in_package": "Treasury",
> "inner_classes": [
> "treasury_financial_accounts_resource_financial_addresses_features",
> "treasury_financial_accounts_resource_inbound_transfers",
> "treasury_financial_accounts_resource_outbound_payments",
> "treasury_financial_accounts_resource_outbound_transfers",
> "treasury_financial_accounts_resource_platform_restrictions"
> ]
> }
37218a45653,45654
> "description",
> "failure_details",
37219a45656
> "hosted_regulatory_receipt_url",
37225a45663,45664
> "origin_payment_method_details",
> "returned",
37228c45667,45668
< "status_transitions"
---
> "status_transitions",
> "transaction"
37239c45679,45741
< "x-resourceId": "treasury.inbound_transfer"
---
> "x-resourceId": "treasury.inbound_transfer",
> "x-stripeOperations": [
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/treasury/inbound_transfers"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/inbound_transfers/{id}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/inbound_transfers"
> },
> {
> "method_name": "succeed",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed"
> },
> {
> "method_name": "fail",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/fail"
> },
> {
> "method_name": "return_inbound_transfer",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/return"
> }
> ],
> "x-stripeResource": {
> "class_name": "InboundTransfer",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "inbound_transfers",
> "treasury_inbound_transfers_resource_failure_details",
> "treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows",
> "treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"
> ]
> }
37389a45892,45896
> "customer",
> "description",
> "destination_payment_method",
> "destination_payment_method_details",
> "end_user_details",
37391a45899
> "hosted_regulatory_receipt_url",
37395a45904
> "returned_details",
37410c45919,45981
< "x-resourceId": "treasury.outbound_payment"
---
> "x-resourceId": "treasury.outbound_payment",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/treasury/outbound_payments"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/outbound_payments/{id}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/outbound_payments"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/treasury/outbound_payments/{id}/cancel"
> },
> {
> "method_name": "fail",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/outbound_payments/{id}/fail"
> },
> {
> "method_name": "post",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/outbound_payments/{id}/post"
> },
> {
> "method_name": "return_outbound_payment",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/outbound_payments/{id}/return"
> }
> ],
> "x-stripeResource": {
> "class_name": "OutboundPayment",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "outbound_payments_payment_method_details",
> "treasury_outbound_payments_resource_outbound_payment_resource_end_user_details",
> "treasury_outbound_payments_resource_outbound_payment_resource_status_transitions",
> "treasury_outbound_payments_resource_returned_status"
> ]
> }
37539a46111,46112
> "description",
> "destination_payment_method",
37542a46116
> "hosted_regulatory_receipt_url",
37546a46121
> "returned_details",
37560c46135,46196
< "x-resourceId": "treasury.outbound_transfer"
---
> "x-resourceId": "treasury.outbound_transfer",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/treasury/outbound_transfers"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/outbound_transfers/{outbound_transfer}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/outbound_transfers"
> },
> {
> "method_name": "cancel",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel"
> },
> {
> "method_name": "fail",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail"
> },
> {
> "method_name": "post",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post"
> },
> {
> "method_name": "return_outbound_transfer",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return"
> }
> ],
> "x-stripeResource": {
> "class_name": "OutboundTransfer",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "outbound_transfers_payment_method_details",
> "treasury_outbound_transfers_resource_returned_details",
> "treasury_outbound_transfers_resource_status_transitions"
> ]
> }
37682a46319,46321
> "failure_code",
> "financial_account",
> "hosted_regulatory_receipt_url",
37689c46328,46330
< "status"
---
> "reversal_details",
> "status",
> "transaction"
37699c46340,46374
< "x-resourceId": "treasury.received_credit"
---
> "x-resourceId": "treasury.received_credit",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/received_credits"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/received_credits/{id}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/received_credits"
> }
> ],
> "x-stripeResource": {
> "class_name": "ReceivedCredit",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "treasury_received_credits_resource_linked_flows",
> "treasury_received_credits_resource_reversal_details",
> "treasury_received_credits_resource_status_transitions",
> "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
> ]
> }
37820a46496,46498
> "failure_code",
> "financial_account",
> "hosted_regulatory_receipt_url",
37826c46504,46506
< "status"
---
> "reversal_details",
> "status",
> "transaction"
37836c46516,46549
< "x-resourceId": "treasury.received_debit"
---
> "x-resourceId": "treasury.received_debit",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/received_debits"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/received_debits/{id}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/test_helpers/treasury/received_debits"
> }
> ],
> "x-stripeResource": {
> "class_name": "ReceivedDebit",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "treasury_received_debits_resource_linked_flows",
> "treasury_received_debits_resource_reversal_details",
> "treasury_received_debits_resource_status_transitions"
> ]
> }
37972a46686
> "entries",
37973a46688,46689
> "flow",
> "flow_details",
37989c46705,46730
< "x-resourceId": "treasury.transaction"
---
> "x-resourceId": "treasury.transaction",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/transactions/{id}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/transactions"
> }
> ],
> "x-stripeResource": {
> "class_name": "Transaction",
> "has_collection_class": true,
> "in_package": "Treasury",
> "inner_classes": [
> "treasury_transactions_resource_abstract_transaction_resource_status_transitions",
> "treasury_transactions_resource_balance_impact"
> ]
> }
38113a46855,46856
> "flow",
> "flow_details",
38128c46871,46892
< "x-resourceId": "treasury.transaction_entry"
---
> "x-resourceId": "treasury.transaction_entry",
> "x-stripeOperations": [
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/treasury/transaction_entries/{id}"
> },
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/treasury/transaction_entries"
> }
> ],
> "x-stripeResource": {
> "class_name": "TransactionEntry",
> "has_collection_class": true,
> "in_package": "Treasury"
> }
38161a46926
> "account_number",
38168c46933,46937
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Aba",
> "in_class": "treasury_financial_accounts_resource_financial_address"
> }
38203c46972,46976
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "AchToggleSettings",
> "in_class": "treasury.financial_account"
> }
38237c47010,47014
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Balance",
> "in_class": "treasury.financial_account"
> }
38260c47037,47041
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Closed",
> "in_class": "treasury_financial_accounts_resource_status_details"
> }
38296c47077,47084
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FinancialAddress",
> "in_class": "treasury.financial_account",
> "inner_classes": [
> "treasury_financial_accounts_resource_aba_record"
> ]
> }
38309c47097,47101
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FinancialAddresses",
> "in_class": "treasury.financial_account_features"
> }
38322c47114,47118
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "InboundTransfers",
> "in_class": "treasury.financial_account_features"
> }
38339c47135,47139
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "OutboundPayments",
> "in_class": "treasury.financial_account_features"
> }
38356c47156,47160
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "OutboundTransfers",
> "in_class": "treasury.financial_account_features"
> }
38379a47184,47187
> "required": [
> "inbound_flows",
> "outbound_flows"
> ],
38382c47190,47194
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "PlatformRestriction",
> "in_class": "treasury.financial_account_features"
> }
38396a47209,47211
> "required": [
> "closed"
> ],
38401c47216,47223
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "StatusDetails",
> "in_class": "treasury.financial_account",
> "inner_classes": [
> "treasury_financial_accounts_resource_closed_status_details"
> ]
> }
38436c47258,47265
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ToggleSettings",
> "in_class": "treasury.financial_account",
> "inner_classes": [
> "treasury_financial_accounts_resource_toggles_setting_status_details"
> ]
> }
38478c47307,47308
< "code"
---
> "code",
> "resolution"
38482,38483c47312,47317
< "x-expandableFields": []
< },
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusDetails",
> "in_class": "treasury_financial_accounts_resource_toggle_settings"
> }
> },
38512c47346,47350
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "FailureDetails",
> "in_class": "treasury.inbound_transfer"
> }
38523a47362,47364
> "required": [
> "received_debit"
> ],
38526c47367,47371
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "LinkedFlows",
> "in_class": "treasury.inbound_transfer"
> }
38549a47395,47398
> "required": [
> "failed_at",
> "succeeded_at"
> ],
38552c47401,47405
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "treasury.inbound_transfer"
> }
38568a47422
> "ip_address",
38573c47427,47431
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "EndUserDetails",
> "in_class": "treasury.outbound_payment"
> }
38602a47461,47466
> "required": [
> "canceled_at",
> "failed_at",
> "posted_at",
> "returned_at"
> ],
38605c47469,47473
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "treasury.outbound_payment"
> }
38654c47522,47526
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ReturnedDetails",
> "in_class": "treasury.outbound_payment"
> }
38703c47575,47579
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "ReturnedDetails",
> "in_class": "treasury.outbound_transfer"
> }
38732a47609,47614
> "required": [
> "canceled_at",
> "failed_at",
> "posted_at",
> "returned_at"
> ],
38735c47617,47621
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "treasury.outbound_transfer"
> }
38779a47666,47673
> "required": [
> "credit_reversal",
> "issuing_authorization",
> "issuing_transaction",
> "source_flow",
> "source_flow_details",
> "source_flow_type"
> ],
38784c47678,47685
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "LinkedFlows",
> "in_class": "treasury.received_credit",
> "inner_classes": [
> "treasury_received_credits_resource_source_flows_details"
> ]
> }
38807a47709,47712
> "required": [
> "deadline",
> "restricted_reason"
> ],
38810c47715,47719
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ReversalDetails",
> "in_class": "treasury.received_credit"
> }
38845c47754,47758
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "SourceFlowDetails",
> "in_class": "treasury_received_credits_resource_linked_flows"
> }
38856a47770,47772
> "required": [
> "posted_at"
> ],
38859c47775,47779
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "treasury.received_credit"
> }
38870a47791,47793
> "required": [
> "issuing_dispute"
> ],
38873c47796,47800
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "LinkedFlows",
> "in_class": "treasury.debit_reversal"
> }
38902a47830,47835
> "required": [
> "debit_reversal",
> "inbound_transfer",
> "issuing_authorization",
> "issuing_transaction"
> ],
38905c47838,47842
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "LinkedFlows",
> "in_class": "treasury.received_debit"
> }
38928a47866,47869
> "required": [
> "deadline",
> "restricted_reason"
> ],
38931c47872,47876
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "ReversalDetails",
> "in_class": "treasury.received_debit"
> }
38942a47888,47890
> "required": [
> "completed_at"
> ],
38945c47893,47897
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "treasury.received_debit"
> }
38967c47919,47921
< "address"
---
> "address",
> "email",
> "name"
38973c47927,47931
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "BillingDetails",
> "in_class": "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
> }
39022c47980,47989
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "InitiatingPaymentMethodDetails",
> "in_class": "treasury.received_credit",
> "inner_classes": [
> "received_payment_method_details_financial_account",
> "treasury_shared_resource_billing_details",
> "treasury_shared_resource_initiating_payment_method_details_us_bank_account"
> ]
> }
39045a48013,48017
> "required": [
> "bank_name",
> "last4",
> "routing_number"
> ],
39048c48020,48024
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "UsBankAccount",
> "in_class": "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
> }
39065a48042,48045
> "required": [
> "posted_at",
> "void_at"
> ],
39068c48048,48052
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "StatusTransitions",
> "in_class": "treasury.transaction"
> }
39093c48077,48081
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "BalanceImpact",
> "in_class": "treasury.transaction"
> }
39152c48140,48144
< ]
---
> ],
> "x-stripeResource": {
> "class_name": "FlowDetails",
> "in_package": "Treasury"
> }
39175a48168
> "preferred",
39180c48173,48177
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Networks",
> "in_class": "payment_method_us_bank_account"
> }
39227c48224,48237
< "x-resourceId": "usage_record"
---
> "x-resourceId": "usage_record",
> "x-stripeOperations": [
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "custom",
> "operation": "post",
> "path": "/v1/subscription_items/{subscription_item}/usage_records"
> }
> ],
> "x-stripeResource": {
> "class_name": "UsageRecord",
> "in_package": ""
> }
39268a48279
> "invoice",
39280c48291,48308
< "x-resourceId": "usage_record_summary"
---
> "x-resourceId": "usage_record_summary",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/subscription_items/{subscription_item}/usage_record_summaries"
> }
> ],
> "x-stripeResource": {
> "class_name": "UsageRecordSummary",
> "has_collection_class": true,
> "in_package": "",
> "inner_classes": [
> "period"
> ]
> }
39299c48327,48331
< "x-expandableFields": []
---
> "x-expandableFields": [],
> "x-stripeResource": {
> "class_name": "Redaction",
> "in_class": "identity.verification_session"
> }
39375a48408,48409
> "api_version",
> "application",
39376a48411
> "description",
39388c48423,48465
< "x-resourceId": "webhook_endpoint"
---
> "x-resourceId": "webhook_endpoint",
> "x-stripeOperations": [
> {
> "method_name": "list",
> "method_on": "service",
> "method_type": "list",
> "operation": "get",
> "path": "/v1/webhook_endpoints"
> },
> {
> "method_name": "retrieve",
> "method_on": "service",
> "method_type": "retrieve",
> "operation": "get",
> "path": "/v1/webhook_endpoints/{webhook_endpoint}"
> },
> {
> "method_name": "create",
> "method_on": "service",
> "method_type": "create",
> "operation": "post",
> "path": "/v1/webhook_endpoints"
> },
> {
> "method_name": "update",
> "method_on": "service",
> "method_type": "update",
> "operation": "post",
> "path": "/v1/webhook_endpoints/{webhook_endpoint}"
> },
> {
> "method_name": "delete",
> "method_on": "service",
> "method_type": "delete",
> "operation": "delete",
> "path": "/v1/webhook_endpoints/{webhook_endpoint}"
> }
> ],
> "x-stripeResource": {
> "class_name": "WebhookEndpoint",
> "has_collection_class": true,
> "in_package": ""
> }
39415c48492
< "x-stripeSpecFilename": "spec3"
---
> "x-stripeSpecFilename": "spec3.sdk"
39526c48603,48605
< "account_update"
---
> "account_update",
> "custom_account_update",
> "custom_account_verification"
39580a48660
> "description": "Minimum value to filter by (exclusive)",
39583a48664
> "description": "Minimum value to filter by (inclusive)",
39586a48668
> "description": "Maximum value to filter by (exclusive)",
39589a48672
> "description": "Maximum value to filter by (inclusive)",
39728,39731d48810
< "bank_account": {
< "explode": true,
< "style": "deepObject"
< },
39777,39839d48855
< "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."
< },
39843a48860
> "description": "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.",
39847a48865
> "description": "The customer-facing business name.",
39851a48870
> "description": "Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.",
39855a48875
> "description": "A publicly available mailing address for sending support issues to.",
39857a48878
> "description": "City, district, suburb, town, or village.",
39861a48883
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
39865a48888
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
39869a48893
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
39873a48898
> "description": "ZIP or postal code.",
39877a48903
> "description": "State, county, province, or region.",
39885a48912
> "description": "A publicly available email address for sending support issues to.",
39888a48916
> "description": "A publicly available phone number to call with support issues.",
39903c48931,48932
< ]
---
> ],
> "description": "A publicly available website for handling support issues."
39905a48935
> "description": "The business's publicly available website.",
39927a48958
> "description": "The acss_debit_payments capability.",
39929a48961
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39936a48969
> "description": "The affirm_payments capability.",
39938a48972
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39945a48980
> "description": "The afterpay_clearpay_payments capability.",
39947a48983
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39954a48991
> "description": "The au_becs_debit_payments capability.",
39956a48994
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39963a49002
> "description": "The bacs_debit_payments capability.",
39965a49005
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39972a49013
> "description": "The bancontact_payments capability.",
39974a49016
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39981a49024
> "description": "The bank_transfer_payments capability.",
39983a49027
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39990a49035
> "description": "The blik_payments capability.",
39992a49038
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
39999a49046
> "description": "The boleto_payments capability.",
40001a49049
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40008a49057
> "description": "The card_issuing capability.",
40010a49060
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40017a49068
> "description": "The card_payments capability.",
40019a49071
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40026a49079
> "description": "The cartes_bancaires_payments capability.",
40028a49082
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40035a49090
> "description": "The eps_payments capability.",
40037a49093
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40044a49101
> "description": "The fpx_payments capability.",
40046a49104
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40053a49112
> "description": "The giropay_payments capability.",
40055a49115
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40062a49123
> "description": "The grabpay_payments capability.",
40064a49126
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40071a49134
> "description": "The ideal_payments capability.",
40073a49137
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40080a49145
> "description": "The jcb_payments capability.",
40082a49148
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40089a49156
> "description": "The klarna_payments capability.",
40091a49159
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40098a49167
> "description": "The konbini_payments capability.",
40100a49170
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40107a49178
> "description": "The legacy_payments capability.",
40109a49181
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40116a49189
> "description": "The link_payments capability.",
40118a49192
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40125a49200
> "description": "The oxxo_payments capability.",
40127a49203
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40134a49211
> "description": "The p24_payments capability.",
40136a49214
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40143a49222
> "description": "The paynow_payments capability.",
40145a49225
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40152a49233
> "description": "The promptpay_payments capability.",
40154a49236
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40161a49244
> "description": "The sepa_debit_payments capability.",
40163a49247
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40170a49255
> "description": "The sofort_payments capability.",
40172a49258
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40179a49266
> "description": "The tax_reporting_us_1099_k capability.",
40181a49269
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40188a49277
> "description": "The tax_reporting_us_1099_misc capability.",
40190a49280
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40197a49288
> "description": "The transfers capability.",
40199a49291
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40206a49299
> "description": "The treasury capability.",
40208a49302
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40215a49310
> "description": "The us_bank_account_ach_payments capability.",
40217a49313
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
40231a49328
> "description": "The company's primary address.",
40233a49331
> "description": "City, district, suburb, town, or village.",
40237a49336
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
40241a49341
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
40245a49346
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
40249a49351
> "description": "ZIP or postal code.",
40253a49356
> "description": "State, county, province, or region.",
40261a49365
> "description": "The Kana variation of the company's primary address (Japan only).",
40263a49368
> "description": "City or ward.",
40267a49373
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
40271a49378
> "description": "Block or building number.",
40275a49383
> "description": "Building details.",
40279a49388
> "description": "Postal code.",
40283a49393
> "description": "Prefecture.",
40287a49398
> "description": "Town or cho-me.",
40295a49407
> "description": "The Kanji variation of the company's primary address (Japan only).",
40297a49410
> "description": "City or ward.",
40301a49415
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
40305a49420
> "description": "Block or building number.",
40309a49425
> "description": "Building details.",
40313a49430
> "description": "Postal code.",
40317a49435
> "description": "Prefecture.",
40321a49440
> "description": "Town or cho-me.",
40329a49449
> "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.",
40332a49453
> "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.",
40335a49457
> "description": "The company's legal name.",
40339a49462
> "description": "The Kana variation of the company's legal name (Japan only).",
40343a49467
> "description": "The Kanji variation of the company's legal name (Japan only).",
40347a49472
> "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.",
40350a49476
> "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.",
40352a49479
> "description": "The Unix timestamp marking when the beneficial owner attestation was made.",
40356a49484
> "description": "The IP address from which the beneficial owner attestation was made.",
40359a49488
> "description": "The user agent of the browser from which the beneficial owner attestation was made.",
40367a49497
> "description": "The company's phone number (used for verification).",
40371a49502
> "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).",
40375a49507
> "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.",
40402a49535
> "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.)",
40406a49540
> "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).",
40410a49545
> "description": "The VAT number of the company.",
40414a49550
> "description": "Information on the verification state of the company.",
40416a49553
> "description": "A document verifying the business.",
40418a49556
> "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.",
40422a49561
> "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.",
40450a49590
> "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.",
40452a49593
> "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`.",
40463a49605
> "description": "One or more documents that demonstrate proof of a company's license to operate.",
40465a49608
> "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`.",
40476a49620
> "description": "One or more documents showing the company's Memorandum of Association.",
40478a49623
> "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`.",
40489a49635
> "description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.",
40491a49638
> "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`.",
40502a49650
> "description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.",
40504a49653
> "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`.",
40515a49665
> "description": "One or more documents that demonstrate proof of a company's tax ID.",
40517a49668
> "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`.",
40528a49680
> "description": "One or more documents showing the company’s proof of registration with the national business registry.",
40530a49683
> "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`.",
40566a49720
> "description": "The individual's primary address.",
40568a49723
> "description": "City, district, suburb, town, or village.",
40572a49728
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
40576a49733
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
40580a49738
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
40584a49743
> "description": "ZIP or postal code.",
40588a49748
> "description": "State, county, province, or region.",
40596a49757
> "description": "The Kana variation of the the individual's primary address (Japan only).",
40598a49760
> "description": "City or ward.",
40602a49765
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
40606a49770
> "description": "Block or building number.",
40610a49775
> "description": "Building details.",
40614a49780
> "description": "Postal code.",
40618a49785
> "description": "Prefecture.",
40622a49790
> "description": "Town or cho-me.",
40630a49799
> "description": "The Kanji variation of the the individual's primary address (Japan only).",
40632a49802
> "description": "City or ward.",
40636a49807
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
40640a49812
> "description": "Block or building number.",
40644a49817
> "description": "Building details.",
40648a49822
> "description": "Postal code.",
40652a49827
> "description": "Prefecture.",
40656a49832
> "description": "Town or cho-me.",
40668a49845
> "description": "The day of birth, between 1 and 31.",
40671a49849
> "description": "The month of birth, between 1 and 12.",
40674a49853
> "description": "The four-digit year of birth.",
40692c49871,49872
< ]
---
> ],
> "description": "The individual's date of birth."
40694a49875
> "description": "The individual's email address.",
40697a49879
> "description": "The individual's first name.",
40701a49884
> "description": "The Kana variation of the the individual's first name (Japan only).",
40705a49889
> "description": "The Kanji variation of the individual's first name (Japan only).",
40724c49908,49909
< ]
---
> ],
> "description": "A list of alternate names or aliases that the individual is known by."
40726a49912
> "description": "The individual's gender (International regulations require either \"male\" or \"female\").",
40729a49916
> "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).",
40733a49921
> "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).",
40737a49926
> "description": "The individual's last name.",
40741a49931
> "description": "The Kana variation of the individual's last name (Japan only).",
40745a49936
> "description": "The Kanji variation of the individual's last name (Japan only).",
40749a49941
> "description": "The individual's maiden name.",
40767c49959,49960
< ]
---
> ],
> "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`."
40769a49963
> "description": "The individual's phone number.",
40772a49967
> "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.",
40779a49975
> "description": "The individual's registered address.",
40781a49978
> "description": "City, district, suburb, town, or village.",
40785a49983
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
40789a49988
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
40793a49993
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
40797a49998
> "description": "ZIP or postal code.",
40801a50003
> "description": "State, county, province, or region.",
40809a50012
> "description": "The last four digits of the individual's Social Security Number (U.S. only).",
40813a50017
> "description": "The individual's verification document information.",
40815a50020
> "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.",
40817a50023
> "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.",
40821a50028
> "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.",
40829a50037
> "description": "An identifying document, either a passport or local ID card.",
40831a50040
> "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.",
40835a50045
> "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.",
40871a50082
> "description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
40873a50085
> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.",
40877a50090
> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.",
40881a50095
> "description": "A CSS hex color value representing the primary branding color for this account.",
40885a50100
> "description": "A CSS hex color value representing the secondary branding color for this account.",
40893a50109
> "description": "Settings specific to the account's use of the Card Issuing product.",
40895a50112
> "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/docs/issuing/connect/tos_acceptance).",
40897a50115
> "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
40901a50120
> "description": "The IP address from which the account representative accepted the service agreement.",
40904a50124
> "description": "The user agent of the browser from which the account representative accepted the service agreement.",
40916a50137
> "description": "Settings specific to card charging on the account.",
40918a50140
> "description": "Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.",
40920a50143
> "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.",
40923a50147
> "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.",
40930a50155
> "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.",
40946c50171,50172
< ]
---
> ],
> "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion."
40960c50186,50187
< ]
---
> ],
> "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion."
40966a50194
> "description": "Settings that apply across payment methods for charging on the account.",
40968a50197
> "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.",
40972a50202
> "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).",
40976a50207
> "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).",
40984a50216
> "description": "Settings specific to the account's payouts.",
40986a50219
> "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).",
40989a50223
> "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation.",
41003c50237,50238
< ]
---
> ],
> "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`."
41005a50241
> "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.",
41016a50253
> "description": "The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.",
41019a50257
> "description": "The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. (required and applicable only if `interval` is `weekly`.)",
41036a50275
> "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.",
41044a50284
> "description": "Settings specific to the account's Treasury FinancialAccounts.",
41046a50287
> "description": "Details on the account's acceptance of the Stripe Treasury Services Agreement.",
41048a50290
> "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
41052a50295
> "description": "The IP address from which the account representative accepted the service agreement.",
41055a50299
> "description": "The user agent of the browser from which the account representative accepted the service agreement.",
41074a50319
> "description": "The Unix timestamp marking when the account representative accepted their service agreement.",
41078a50324
> "description": "The IP address from which the account representative accepted their service agreement.",
41081a50328
> "description": "The user's service agreement type.",
41085a50333
> "description": "The user agent of the browser from which the account representative accepted their service agreement.",
41318a50567
> "description": "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.",
41322a50572
> "description": "The customer-facing business name.",
41326a50577
> "description": "Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.",
41330a50582
> "description": "A publicly available mailing address for sending support issues to.",
41332a50585
> "description": "City, district, suburb, town, or village.",
41336a50590
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
41340a50595
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
41344a50600
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
41348a50605
> "description": "ZIP or postal code.",
41352a50610
> "description": "State, county, province, or region.",
41360a50619
> "description": "A publicly available email address for sending support issues to.",
41363a50623
> "description": "A publicly available phone number to call with support issues.",
41378c50638,50639
< ]
---
> ],
> "description": "A publicly available website for handling support issues."
41380a50642
> "description": "The business's publicly available website.",
41402a50665
> "description": "The acss_debit_payments capability.",
41404a50668
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41411a50676
> "description": "The affirm_payments capability.",
41413a50679
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41420a50687
> "description": "The afterpay_clearpay_payments capability.",
41422a50690
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41429a50698
> "description": "The au_becs_debit_payments capability.",
41431a50701
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41438a50709
> "description": "The bacs_debit_payments capability.",
41440a50712
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41447a50720
> "description": "The bancontact_payments capability.",
41449a50723
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41456a50731
> "description": "The bank_transfer_payments capability.",
41458a50734
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41465a50742
> "description": "The blik_payments capability.",
41467a50745
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41474a50753
> "description": "The boleto_payments capability.",
41476a50756
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41483a50764
> "description": "The card_issuing capability.",
41485a50767
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41492a50775
> "description": "The card_payments capability.",
41494a50778
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41501a50786
> "description": "The cartes_bancaires_payments capability.",
41503a50789
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41510a50797
> "description": "The eps_payments capability.",
41512a50800
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41519a50808
> "description": "The fpx_payments capability.",
41521a50811
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41528a50819
> "description": "The giropay_payments capability.",
41530a50822
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41537a50830
> "description": "The grabpay_payments capability.",
41539a50833
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41546a50841
> "description": "The ideal_payments capability.",
41548a50844
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41555a50852
> "description": "The jcb_payments capability.",
41557a50855
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41564a50863
> "description": "The klarna_payments capability.",
41566a50866
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41573a50874
> "description": "The konbini_payments capability.",
41575a50877
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41582a50885
> "description": "The legacy_payments capability.",
41584a50888
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41591a50896
> "description": "The link_payments capability.",
41593a50899
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41600a50907
> "description": "The oxxo_payments capability.",
41602a50910
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41609a50918
> "description": "The p24_payments capability.",
41611a50921
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41618a50929
> "description": "The paynow_payments capability.",
41620a50932
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41627a50940
> "description": "The promptpay_payments capability.",
41629a50943
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41636a50951
> "description": "The sepa_debit_payments capability.",
41638a50954
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41645a50962
> "description": "The sofort_payments capability.",
41647a50965
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41654a50973
> "description": "The tax_reporting_us_1099_k capability.",
41656a50976
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41663a50984
> "description": "The tax_reporting_us_1099_misc capability.",
41665a50987
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41672a50995
> "description": "The transfers capability.",
41674a50998
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41681a51006
> "description": "The treasury capability.",
41683a51009
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41690a51017
> "description": "The us_bank_account_ach_payments capability.",
41692a51020
> "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
41706a51035
> "description": "The company's primary address.",
41708a51038
> "description": "City, district, suburb, town, or village.",
41712a51043
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
41716a51048
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
41720a51053
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
41724a51058
> "description": "ZIP or postal code.",
41728a51063
> "description": "State, county, province, or region.",
41736a51072
> "description": "The Kana variation of the company's primary address (Japan only).",
41738a51075
> "description": "City or ward.",
41742a51080
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
41746a51085
> "description": "Block or building number.",
41750a51090
> "description": "Building details.",
41754a51095
> "description": "Postal code.",
41758a51100
> "description": "Prefecture.",
41762a51105
> "description": "Town or cho-me.",
41770a51114
> "description": "The Kanji variation of the company's primary address (Japan only).",
41772a51117
> "description": "City or ward.",
41776a51122
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
41780a51127
> "description": "Block or building number.",
41784a51132
> "description": "Building details.",
41788a51137
> "description": "Postal code.",
41792a51142
> "description": "Prefecture.",
41796a51147
> "description": "Town or cho-me.",
41804a51156
> "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.",
41807a51160
> "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.",
41810a51164
> "description": "The company's legal name.",
41814a51169
> "description": "The Kana variation of the company's legal name (Japan only).",
41818a51174
> "description": "The Kanji variation of the company's legal name (Japan only).",
41822a51179
> "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.",
41825a51183
> "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.",
41827a51186
> "description": "The Unix timestamp marking when the beneficial owner attestation was made.",
41831a51191
> "description": "The IP address from which the beneficial owner attestation was made.",
41834a51195
> "description": "The user agent of the browser from which the beneficial owner attestation was made.",
41842a51204
> "description": "The company's phone number (used for verification).",
41846a51209
> "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).",
41850a51214
> "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.",
41877a51242
> "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.)",
41881a51247
> "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).",
41885a51252
> "description": "The VAT number of the company.",
41889a51257
> "description": "Information on the verification state of the company.",
41891a51260
> "description": "A document verifying the business.",
41893a51263
> "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.",
41897a51268
> "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.",
41920a51292
> "description": "One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.",
41922a51295
> "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`.",
41933a51307
> "description": "One or more documents that demonstrate proof of a company's license to operate.",
41935a51310
> "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`.",
41946a51322
> "description": "One or more documents showing the company's Memorandum of Association.",
41948a51325
> "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`.",
41959a51337
> "description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.",
41961a51340
> "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`.",
41972a51352
> "description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.",
41974a51355
> "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`.",
41985a51367
> "description": "One or more documents that demonstrate proof of a company's tax ID.",
41987a51370
> "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`.",
41998a51382
> "description": "One or more documents showing the company’s proof of registration with the national business registry.",
42000a51385
> "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`.",
42036a51422
> "description": "The individual's primary address.",
42038a51425
> "description": "City, district, suburb, town, or village.",
42042a51430
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
42046a51435
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
42050a51440
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
42054a51445
> "description": "ZIP or postal code.",
42058a51450
> "description": "State, county, province, or region.",
42066a51459
> "description": "The Kana variation of the the individual's primary address (Japan only).",
42068a51462
> "description": "City or ward.",
42072a51467
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
42076a51472
> "description": "Block or building number.",
42080a51477
> "description": "Building details.",
42084a51482
> "description": "Postal code.",
42088a51487
> "description": "Prefecture.",
42092a51492
> "description": "Town or cho-me.",
42100a51501
> "description": "The Kanji variation of the the individual's primary address (Japan only).",
42102a51504
> "description": "City or ward.",
42106a51509
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
42110a51514
> "description": "Block or building number.",
42114a51519
> "description": "Building details.",
42118a51524
> "description": "Postal code.",
42122a51529
> "description": "Prefecture.",
42126a51534
> "description": "Town or cho-me.",
42138a51547
> "description": "The day of birth, between 1 and 31.",
42141a51551
> "description": "The month of birth, between 1 and 12.",
42144a51555
> "description": "The four-digit year of birth.",
42162c51573,51574
< ]
---
> ],
> "description": "The individual's date of birth."
42164a51577
> "description": "The individual's email address.",
42167a51581
> "description": "The individual's first name.",
42171a51586
> "description": "The Kana variation of the the individual's first name (Japan only).",
42175a51591
> "description": "The Kanji variation of the individual's first name (Japan only).",
42194c51610,51611
< ]
---
> ],
> "description": "A list of alternate names or aliases that the individual is known by."
42196a51614
> "description": "The individual's gender (International regulations require either \"male\" or \"female\").",
42199a51618
> "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).",
42203a51623
> "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).",
42207a51628
> "description": "The individual's last name.",
42211a51633
> "description": "The Kana variation of the individual's last name (Japan only).",
42215a51638
> "description": "The Kanji variation of the individual's last name (Japan only).",
42219a51643
> "description": "The individual's maiden name.",
42237c51661,51662
< ]
---
> ],
> "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`."
42239a51665
> "description": "The individual's phone number.",
42242a51669
> "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.",
42249a51677
> "description": "The individual's registered address.",
42251a51680
> "description": "City, district, suburb, town, or village.",
42255a51685
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
42259a51690
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
42263a51695
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
42267a51700
> "description": "ZIP or postal code.",
42271a51705
> "description": "State, county, province, or region.",
42279a51714
> "description": "The last four digits of the individual's Social Security Number (U.S. only).",
42283a51719
> "description": "The individual's verification document information.",
42285a51722
> "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.",
42287a51725
> "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.",
42291a51730
> "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.",
42299a51739
> "description": "An identifying document, either a passport or local ID card.",
42301a51742
> "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.",
42305a51747
> "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.",
42341a51784
> "description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
42343a51787
> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.",
42347a51792
> "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.",
42351a51797
> "description": "A CSS hex color value representing the primary branding color for this account.",
42355a51802
> "description": "A CSS hex color value representing the secondary branding color for this account.",
42363a51811
> "description": "Settings specific to the account's use of the Card Issuing product.",
42365a51814
> "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/docs/issuing/connect/tos_acceptance).",
42367a51817
> "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
42371a51822
> "description": "The IP address from which the account representative accepted the service agreement.",
42374a51826
> "description": "The user agent of the browser from which the account representative accepted the service agreement.",
42386a51839
> "description": "Settings specific to card charging on the account.",
42388a51842
> "description": "Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.",
42390a51845
> "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.",
42393a51849
> "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.",
42400a51857
> "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.",
42416c51873,51874
< ]
---
> ],
> "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion."
42430c51888,51889
< ]
---
> ],
> "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion."
42436a51896
> "description": "Settings that apply across payment methods for charging on the account.",
42438a51899
> "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.",
42442a51904
> "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).",
42446a51909
> "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).",
42454a51918
> "description": "Settings specific to the account's payouts.",
42456a51921
> "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).",
42459a51925
> "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation.",
42473c51939,51940
< ]
---
> ],
> "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter does not apply when the `interval` is `manual`."
42475a51943
> "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.",
42486a51955
> "description": "The day of the month when available funds are paid out, specified as a number between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.",
42489a51959
> "description": "The day of the week when available funds are paid out, specified as `monday`, `tuesday`, etc. (required and applicable only if `interval` is `weekly`.)",
42506a51977
> "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.",
42514a51986
> "description": "Settings specific to the account's Treasury FinancialAccounts.",
42516a51989
> "description": "Details on the account's acceptance of the Stripe Treasury Services Agreement.",
42518a51992
> "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
42522a51997
> "description": "The IP address from which the account representative accepted the service agreement.",
42525a52001
> "description": "The user agent of the browser from which the account representative accepted the service agreement.",
42544a52021
> "description": "The Unix timestamp marking when the account representative accepted their service agreement.",
42548a52026
> "description": "The IP address from which the account representative accepted their service agreement.",
42551a52030
> "description": "The user's service agreement type.",
42555a52035
> "description": "The user agent of the browser from which the account representative accepted their service agreement.",
42594,43055d52073
< "/v1/accounts/{account}/bank_accounts": {
< "post": {
< "description": "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.
",
< "operationId": "DeleteAccountsAccountPeoplePerson",
< "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": {},
< "schema": {
< "additionalProperties": false,
< "properties": {},
< "type": "object"
< }
< }
< },
< "required": false
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/deleted_person"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< },
< "get": {
< "description": "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.
",
< "operationId": "GetBalanceHistoryId",
< "parameters": [
< {
< "description": "Specifies which fields in the response should be expanded.",
< "explode": true,
< "in": "query",
< "name": "expand",
< "required": false,
< "schema": {
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "style": "deepObject"
< },
< {
< "in": "path",
< "name": "id",
< "required": true,
< "schema": {
< "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/balance_transaction"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/balance_transactions": {
< "get": {
< "description": "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.
",
< "operationId": "GetBalanceTransactions",
< "parameters": [
< {
48457a55905
> "description": "Minimum value to filter by (exclusive)",
48460a55909
> "description": "Minimum value to filter by (inclusive)",
48463a55913
> "description": "Maximum value to filter by (exclusive)",
48466a55917
> "description": "Maximum value to filter by (inclusive)",
48895a56347
> "description": "The messaging shown to customers in the portal.",
48899a56352
> "description": "A link to the business’s publicly available privacy policy.",
48902a56356
> "description": "A link to the business’s publicly available terms of service.",
48934a56389
> "description": "Information about updating the customer details in the portal.",
48947c56402,56403
< "type": "string"
---
> "type": "string",
> "x-stripeBypassValidation": true
48957c56413,56414
< ]
---
> ],
> "description": "The types of customer updates that are supported. When empty, customers are not updateable."
48959a56417
> "description": "Whether the feature is enabled.",
48969a56428
> "description": "Information about showing the billing history in the portal.",
48971a56431
> "description": "Whether the feature is enabled.",
48981a56442
> "description": "Information about updating payment methods in the portal.",
48983a56445
> "description": "Whether the feature is enabled.",
48993a56456
> "description": "Information about canceling subscriptions in the portal.",
48995a56459
> "description": "Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer",
48997a56462
> "description": "Whether the feature is enabled.",
49024c56489,56490
< ]
---
> ],
> "description": "Which cancellation reasons will be given as options to the customer."
49034a56501
> "description": "Whether the feature is enabled.",
49037a56505
> "description": "Whether to cancel subscriptions immediately or at the end of the billing period.",
49044a56513
> "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.",
49059a56529
> "description": "Information about pausing subscriptions in the portal.",
49061a56532
> "description": "Whether the feature is enabled.",
49068a56540
> "description": "Information about updating subscriptions in the portal.",
49089c56561,56562
< ]
---
> ],
> "description": "The types of subscription updates that are supported. When empty, subscriptions are not updateable."
49091a56565
> "description": "Whether the feature is enabled.",
49099a56574
> "description": "The list of price IDs for the product that a subscription can be updated to.",
49106a56582
> "description": "The product id.",
49126c56602,56603
< ]
---
> ],
> "description": "The list of products that support subscription updates."
49128a56606
> "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.",
49152a56631
> "description": "Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.",
49325a56805
> "description": "The messaging shown to customers in the portal.",
49340c56820,56821
< ]
---
> ],
> "description": "A link to the business’s publicly available privacy policy."
49353c56834,56835
< ]
---
> ],
> "description": "A link to the business’s publicly available terms of service."
49384a56867
> "description": "Information about updating the customer details in the portal.",
49397c56880,56881
< "type": "string"
---
> "type": "string",
> "x-stripeBypassValidation": true
49407c56891,56892
< ]
---
> ],
> "description": "The types of customer updates that are supported. When empty, customers are not updateable."
49409a56895
> "description": "Whether the feature is enabled.",
49416a56903
> "description": "Information about showing the billing history in the portal.",
49418a56906
> "description": "Whether the feature is enabled.",
49428a56917
> "description": "Information about updating payment methods in the portal.",
49430a56920
> "description": "Whether the feature is enabled.",
49440a56931
> "description": "Information about canceling subscriptions in the portal.",
49442a56934
> "description": "Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer",
49444a56937
> "description": "Whether the feature is enabled.",
49471c56964,56965
< ]
---
> ],
> "description": "Which cancellation reasons will be given as options to the customer."
49480a56975
> "description": "Whether the feature is enabled.",
49483a56979
> "description": "Whether to cancel subscriptions immediately or at the end of the billing period.",
49490a56987
> "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.",
49502a57000
> "description": "Information about pausing subscriptions in the portal.",
49504a57003
> "description": "Whether the feature is enabled.",
49511a57011
> "description": "Information about updating subscriptions in the portal.",
49532c57032,57033
< ]
---
> ],
> "description": "The types of subscription updates that are supported. When empty, subscriptions are not updateable."
49534a57036
> "description": "Whether the feature is enabled.",
49542a57045
> "description": "The list of price IDs for the product that a subscription can be updated to.",
49549a57053
> "description": "The product id.",
49569c57073,57074
< ]
---
> ],
> "description": "The list of products that support subscription updates."
49571a57077
> "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.",
49590a57097
> "description": "Set to `true` to generate a shareable URL [`login_page.url`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.\n\nSet to `false` to deactivate the `login_page.url`.",
49791a57299
> "description": "Minimum value to filter by (exclusive)",
49794a57303
> "description": "Minimum value to filter by (inclusive)",
49797a57307
> "description": "Maximum value to filter by (exclusive)",
49800a57311
> "description": "Maximum value to filter by (inclusive)",
49972,49975d57482
< "card": {
< "explode": true,
< "style": "deepObject"
< },
50019,50094d57525
< "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
< },
50110,50127c57541,57544
< "anyOf": [
< {
< "properties": {
< "account": {
< "maxLength": 5000,
< "type": "string"
< },
< "amount": {
< "type": "integer"
< }
< },
< "required": [
< "account"
< ],
< "title": "destination_specs",
< "type": "object"
< },
< {
---
> "properties": {
> "account": {
> "description": "ID of an existing, connected Stripe account.",
> "maxLength": 5000,
50128a57546,57549
> },
> "amount": {
> "description": "The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.",
> "type": "integer"
50130c57551,57556
< ]
---
> },
> "required": [
> "account"
> ],
> "title": "destination_specs",
> "type": "object"
50165a57592
> "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.",
50180a57608
> "description": "Shipping address.",
50182a57611
> "description": "City, district, suburb, town, or village.",
50186a57616
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
50190a57621
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
50194a57626
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
50198a57631
> "description": "ZIP or postal code.",
50202a57636
> "description": "State, county, province, or region.",
50210a57645
> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
50214a57650
> "description": "Recipient name.",
50218a57655
> "description": "Recipient phone (including extension).",
50222a57660
> "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.",
50253a57692
> "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.",
50256a57696
> "description": "ID of an existing, connected Stripe account.",
50407a57848
> "next_page",
50561a58003
> "description": "Either `safe` or `fraudulent`.",
50602a58045
> "description": "Shipping address.",
50604a58048
> "description": "City, district, suburb, town, or village.",
50608a58053
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
50612a58058
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
50616a58063
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
50620a58068
> "description": "ZIP or postal code.",
50624a58073
> "description": "State, county, province, or region.",
50632a58082
> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
50636a58087
> "description": "Recipient name.",
50640a58092
> "description": "Recipient phone (including extension).",
50644a58097
> "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.",
50760a58214
> "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.",
50802,51249d58255
< "/v1/charges/{charge}/dispute": {
< "get": {
< "description": "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.
",
< "operationId": "GetCustomersCustomerBankAccounts",
< "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": {
< "type": "string"
< },
< "style": "form"
< },
< {
< "description": "Specifies which fields in the response should be expanded.",
< "explode": true,
< "in": "query",
< "name": "expand",
< "required": false,
< "schema": {
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "style": "deepObject"
< },
< {
< "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
< "in": "query",
< "name": "limit",
< "required": false,
< "schema": {
< "type": "integer"
< },
< "style": "form"
< },
< {
< "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
< "in": "query",
< "name": "starting_after",
< "required": false,
< "schema": {
< "type": "string"
< },
< "style": "form"
< }
< ],
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {},
< "schema": {
< "additionalProperties": false,
< "properties": {},
< "type": "object"
< }
< }
< },
< "required": false
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "description": "",
< "properties": {
< "data": {
< "description": "Details about each object.",
< "items": {
< "$ref": "#/components/schemas/bank_account"
< },
< "type": "array"
< },
< "has_more": {
< "description": "True if this list has another page of items after this one that can be fetched.",
< "type": "boolean"
< },
< "object": {
< "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
< "enum": [
< "list"
< ],
< "type": "string"
< },
< "url": {
< "description": "The URL where this list can be accessed.",
< "maxLength": 5000,
< "type": "string"
< }
< },
< "required": [
< "data",
< "has_more",
< "object",
< "url"
< ],
< "title": "BankAccountList",
< "type": "object",
< "x-expandableFields": [
< "data"
< ]
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< },
< "post": {
< "description": "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.
",
< "operationId": "PostCustomersCustomerBankAccounts",
< "parameters": [
< {
< "in": "path",
< "name": "customer",
< "required": true,
< "schema": {
< "maxLength": 5000,
< "type": "string"
< },
< "style": "simple"
< }
< ],
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {
< "bank_account": {
< "explode": true,
< "style": "deepObject"
< },
< "card": {
< "explode": true,
< "style": "deepObject"
< },
< "expand": {
< "explode": true,
< "style": "deepObject"
< },
< "metadata": {
< "explode": true,
< "style": "deepObject"
< }
< },
< "schema": {
< "additionalProperties": false,
< "properties": {
< "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
< },
< "expand": {
< "description": "Specifies which fields in the response should be expanded.",
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "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"
< },
< "source": {
< "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
< "maxLength": 5000,
< "type": "string",
< "x-stripeBypassValidation": true
< }
< },
< "type": "object"
< }
< }
< },
< "required": false
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/payment_source"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/customers/{customer}/bank_accounts/{id}": {
< "delete": {
< "description": "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.
",
< "operationId": "GetCustomersCustomerCards",
< "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": {
< "type": "string"
< },
< "style": "form"
< },
< {
< "description": "Specifies which fields in the response should be expanded.",
< "explode": true,
< "in": "query",
< "name": "expand",
< "required": false,
< "schema": {
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "style": "deepObject"
< },
< {
< "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
< "in": "query",
< "name": "limit",
< "required": false,
< "schema": {
< "type": "integer"
< },
< "style": "form"
< },
< {
< "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
< "in": "query",
< "name": "starting_after",
< "required": false,
< "schema": {
< "type": "string"
< },
< "style": "form"
< }
< ],
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {},
< "schema": {
< "additionalProperties": false,
< "properties": {},
< "type": "object"
< }
< }
< },
< "required": false
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "description": "",
< "properties": {
< "data": {
< "items": {
< "$ref": "#/components/schemas/card"
< },
< "type": "array"
< },
< "has_more": {
< "description": "True if this list has another page of items after this one that can be fetched.",
< "type": "boolean"
< },
< "object": {
< "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
< "enum": [
< "list"
< ],
< "type": "string"
< },
< "url": {
< "description": "The URL where this list can be accessed.",
< "maxLength": 5000,
< "type": "string"
< }
< },
< "required": [
< "data",
< "has_more",
< "object",
< "url"
< ],
< "title": "CardList",
< "type": "object",
< "x-expandableFields": [
< "data"
< ]
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< },
< "post": {
< "description": "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.
",
< "operationId": "PostCustomersCustomerCards",
< "parameters": [
< {
< "in": "path",
< "name": "customer",
< "required": true,
< "schema": {
< "maxLength": 5000,
< "type": "string"
< },
< "style": "simple"
< }
< ],
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {
< "bank_account": {
< "explode": true,
< "style": "deepObject"
< },
< "card": {
< "explode": true,
< "style": "deepObject"
< },
< "expand": {
< "explode": true,
< "style": "deepObject"
< },
< "metadata": {
< "explode": true,
< "style": "deepObject"
< }
< },
< "schema": {
< "additionalProperties": false,
< "properties": {
< "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
< },
< "expand": {
< "description": "Specifies which fields in the response should be expanded.",
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "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"
< },
< "source": {
< "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
< "maxLength": 5000,
< "type": "string",
< "x-stripeBypassValidation": true
< }
< },
< "type": "object"
< }
< }
< },
< "required": false
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/payment_source"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/customers/{customer}/cards/{id}": {
< "delete": {
< "description": "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.
\n\nNote, 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.
",
< "operationId": "GetIssuingSettlements",
< "parameters": [
< {
< "description": "Only return issuing settlements that were created during the given date interval.",
< "explode": true,
< "in": "query",
< "name": "created",
< "required": false,
< "schema": {
< "anyOf": [
< {
< "properties": {
< "gt": {
< "type": "integer"
< },
< "gte": {
< "type": "integer"
< },
< "lt": {
< "type": "integer"
< },
< "lte": {
< "type": "integer"
< }
< },
< "title": "range_query_specs",
< "type": "object"
< },
< {
< "type": "integer"
< }
< ]
< },
< "style": "deepObject"
< },
< {
< "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
< "in": "query",
< "name": "ending_before",
< "required": false,
< "schema": {
< "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": {
< "items": {
< "$ref": "#/components/schemas/issuing.settlement"
< },
< "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/issuing/settlements",
< "type": "string"
< }
< },
< "required": [
< "data",
< "has_more",
< "object",
< "url"
< ],
< "title": "IssuingSettlementList",
< "type": "object",
< "x-expandableFields": [
< "data"
< ]
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/issuing/settlements/{settlement}": {
< "get": {
< "description": "Retrieves an Issuing Settlement object.
",
< "operationId": "GetIssuingSettlementsSettlement",
< "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": "settlement",
< "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/issuing.settlement"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< },
< "post": {
< "description": "Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
",
< "operationId": "PostIssuingSettlementsSettlement",
< "parameters": [
< {
< "in": "path",
< "name": "settlement",
< "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": {
< "expand": {
< "description": "Specifies which fields in the response should be expanded.",
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "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/issuing.settlement"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
79216a82526
> "description": "Minimum value to filter by (exclusive)",
79219a82530
> "description": "Minimum value to filter by (inclusive)",
79222a82534
> "description": "Maximum value to filter by (exclusive)",
79225a82538
> "description": "Maximum value to filter by (inclusive)",
79528,80256d82840
< "/v1/link_account_sessions": {
< "post": {
< "description": "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.
",
< "operationId": "PostLinkAccountSessions",
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {
< "account_holder": {
< "explode": true,
< "style": "deepObject"
< },
< "expand": {
< "explode": true,
< "style": "deepObject"
< },
< "filters": {
< "explode": true,
< "style": "deepObject"
< },
< "permissions": {
< "explode": true,
< "style": "deepObject"
< }
< },
< "schema": {
< "additionalProperties": false,
< "properties": {
< "account_holder": {
< "description": "The account holder to link accounts for.",
< "properties": {
< "account": {
< "maxLength": 5000,
< "type": "string"
< },
< "customer": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": {
< "enum": [
< "account",
< "customer"
< ],
< "type": "string"
< }
< },
< "required": [
< "type"
< ],
< "title": "accountholder_params",
< "type": "object"
< },
< "expand": {
< "description": "Specifies which fields in the response should be expanded.",
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "filters": {
< "description": "Filters to restrict the kinds of accounts to collect.",
< "properties": {
< "countries": {
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< }
< },
< "required": [
< "countries"
< ],
< "title": "filters_params",
< "type": "object"
< },
< "permissions": {
< "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.",
< "items": {
< "enum": [
< "balances",
< "ownership",
< "payment_method",
< "transactions"
< ],
< "maxLength": 5000,
< "type": "string",
< "x-stripeBypassValidation": true
< },
< "type": "array"
< },
< "return_url": {
< "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.",
< "maxLength": 5000,
< "type": "string"
< }
< },
< "required": [
< "account_holder",
< "permissions"
< ],
< "type": "object"
< }
< }
< },
< "required": true
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/financial_connections.session"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/link_account_sessions/{session}": {
< "get": {
< "description": "Retrieves the details of a Financial Connections Session
",
< "operationId": "GetLinkAccountSessionsSession",
< "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": "session",
< "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/financial_connections.session"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/linked_accounts": {
< "get": {
< "description": "Returns a list of Financial Connections Account objects.
",
< "operationId": "GetLinkedAccounts",
< "parameters": [
< {
< "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.",
< "explode": true,
< "in": "query",
< "name": "account_holder",
< "required": false,
< "schema": {
< "properties": {
< "account": {
< "maxLength": 5000,
< "type": "string"
< },
< "customer": {
< "maxLength": 5000,
< "type": "string"
< }
< },
< "title": "accountholder_params",
< "type": "object"
< },
< "style": "deepObject"
< },
< {
< "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
< "in": "query",
< "name": "ending_before",
< "required": false,
< "schema": {
< "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": "If present, only return accounts that were collected as part of the given session.",
< "in": "query",
< "name": "session",
< "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"
< }
< ],
< "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/financial_connections.account"
< },
< "type": "array"
< },
< "has_more": {
< "description": "True if this list has another page of items after this one that can be fetched.",
< "type": "boolean"
< },
< "object": {
< "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
< "enum": [
< "list"
< ],
< "type": "string"
< },
< "url": {
< "description": "The URL where this list can be accessed.",
< "maxLength": 5000,
< "pattern": "^/v1/financial_connections/accounts",
< "type": "string"
< }
< },
< "required": [
< "data",
< "has_more",
< "object",
< "url"
< ],
< "title": "BankConnectionsResourceLinkedAccountList",
< "type": "object",
< "x-expandableFields": [
< "data"
< ]
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/linked_accounts/{account}": {
< "get": {
< "description": "Retrieves the details of an Financial Connections Account.
",
< "operationId": "GetLinkedAccountsAccount",
< "parameters": [
< {
< "in": "path",
< "name": "account",
< "required": true,
< "schema": {
< "maxLength": 5000,
< "type": "string"
< },
< "style": "simple"
< },
< {
< "description": "Specifies which fields in the response should be expanded.",
< "explode": true,
< "in": "query",
< "name": "expand",
< "required": false,
< "schema": {
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
< "style": "deepObject"
< }
< ],
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {},
< "schema": {
< "additionalProperties": false,
< "properties": {},
< "type": "object"
< }
< }
< },
< "required": false
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/financial_connections.account"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/linked_accounts/{account}/disconnect": {
< "post": {
< "description": "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).
",
< "operationId": "PostLinkedAccountsAccountDisconnect",
< "parameters": [
< {
< "in": "path",
< "name": "account",
< "required": true,
< "schema": {
< "maxLength": 5000,
< "type": "string"
< },
< "style": "simple"
< }
< ],
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {
< "expand": {
< "explode": true,
< "style": "deepObject"
< }
< },
< "schema": {
< "additionalProperties": false,
< "properties": {
< "expand": {
< "description": "Specifies which fields in the response should be expanded.",
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< }
< },
< "type": "object"
< }
< }
< },
< "required": false
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/financial_connections.account"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/linked_accounts/{account}/owners": {
< "get": {
< "description": "Lists all owners for a given Account
",
< "operationId": "GetLinkedAccountsAccountOwners",
< "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": "The ID of the ownership object to fetch owners from.",
< "in": "query",
< "name": "ownership",
< "required": true,
< "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"
< }
< ],
< "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/financial_connections.account_owner"
< },
< "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": "BankConnectionsResourceOwnerList",
< "type": "object",
< "x-expandableFields": [
< "data"
< ]
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
< "/v1/linked_accounts/{account}/refresh": {
< "post": {
< "description": "Refreshes the data associated with a Financial Connections Account.
",
< "operationId": "PostLinkedAccountsAccountRefresh",
< "parameters": [
< {
< "in": "path",
< "name": "account",
< "required": true,
< "schema": {
< "maxLength": 5000,
< "type": "string"
< },
< "style": "simple"
< }
< ],
< "requestBody": {
< "content": {
< "application/x-www-form-urlencoded": {
< "encoding": {
< "expand": {
< "explode": true,
< "style": "deepObject"
< },
< "features": {
< "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"
< },
< "features": {
< "description": "The list of account features that you would like to refresh.",
< "items": {
< "enum": [
< "balance",
< "ownership"
< ],
< "type": "string",
< "x-stripeBypassValidation": true
< },
< "type": "array"
< }
< },
< "required": [
< "features"
< ],
< "type": "object"
< }
< }
< },
< "required": true
< },
< "responses": {
< "200": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/financial_connections.account"
< }
< }
< },
< "description": "Successful response."
< },
< "default": {
< "content": {
< "application/json": {
< "schema": {
< "$ref": "#/components/schemas/error"
< }
< }
< },
< "description": "Error response."
< }
< }
< }
< },
80473,80476d83056
< "client_permissions": {
< "explode": true,
< "style": "deepObject"
< },
80516a83097
> "description": "Enable automatic tax calculation which will automatically compute tax rates on this order.",
80530a83112
> "description": "The billing address provided by the customer.",
80532a83115
> "description": "City, district, suburb, town, or village.",
80536a83120
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
80540a83125
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
80544a83130
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
80548a83135
> "description": "ZIP or postal code.",
80552a83140
> "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".",
80560a83149
> "description": "The billing email provided by the customer.",
80563a83153
> "description": "The billing name provided by the customer.",
80567a83158
> "description": "The billing phone number provided by the customer.",
80584,80611d83174
< "client_permissions": {
< "description": "The fields on the order that are allowed to be updated from your frontend application with a publishable key and order client secret.",
< "properties": {
< "billing_details": {
< "enum": [
< "allow",
< "disallow"
< ],
< "type": "string"
< },
< "promotion_codes": {
< "enum": [
< "allow",
< "disallow"
< ],
< "type": "string"
< },
< "shipping_details": {
< "enum": [
< "allow",
< "disallow"
< ],
< "type": "string"
< }
< },
< "title": "client_permissions",
< "type": "object"
< },
80631a83195
> "description": "ID of the coupon to create a new discount for.",
80635a83200
> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
80639a83205
> "description": "ID of the promotion code to create a new discount for.",
80674a83241
> "description": "The description for the line item. Will default to the name of the associated product.",
80683a83251
> "description": "ID of the coupon to create a new discount for.",
80687a83256
> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
80703c83272,83273
< ]
---
> ],
> "description": "The discounts applied to this line item."
80705a83276
> "description": "The ID of a [Price](https://stripe.com/docs/api/prices) to add to the Order.\n\nThe `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.",
80709a83281
> "description": "Data used to generate a new Price object inline.\n\nThe `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create products upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.\n\nEach time you pass `price_data` we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused.",
80711a83284
> "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).",
80714a83288
> "description": "ID of the product this price belongs to.\n\nUse this to implement a variable-pricing model in your integration. This is required if `product_data` is not specifed.",
80718a83293
> "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.",
80726a83302
> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
80729a83306
> "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.",
80737a83315
> "description": "The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order.\n\nThe product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.",
80741a83320
> "description": "Defines a Product inline and adds it to the Order.\n\n`product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.\n\n`product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.",
80743a83323
> "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.",
80747a83328
> "description": "A unique identifier for this product.\n\n`product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.",
80765c83346,83347
< ]
---
> ],
> "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer."
80781c83363,83364
< ]
---
> ],
> "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`."
80783a83367
> "description": "The product's name, meant to be displayable to the customer.",
80791a83376
> "description": "Height, in inches. Maximum precision is 2 decimal places.",
80794a83380
> "description": "Length, in inches. Maximum precision is 2 decimal places.",
80797a83384
> "description": "Weight, in ounces. Maximum precision is 2 decimal places.",
80800a83388
> "description": "Width, in inches. Maximum precision is 2 decimal places.",
80819c83407,83408
< ]
---
> ],
> "description": "The dimensions of this product for shipping purposes."
80821a83411
> "description": "Whether this product is shipped (i.e., physical goods).",
80824a83415
> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
80839c83430,83431
< ]
---
> ],
> "description": "A URL of a publicly-accessible webpage for this product."
80849a83442
> "description": "The quantity of the line item.",
80867c83460,83461
< ]
---
> ],
> "description": "The tax rates applied to this line item."
80885a83480
> "description": "Settings describing how the order should configure generated PaymentIntents.",
80887a83483
> "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.",
80890a83487
> "description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.",
80892a83490
> "description": "If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent.",
80894a83493
> "description": "Additional fields for Mandate creation",
80907c83506,83507
< ]
---
> ],
> "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."
80909a83510
> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
80913a83515
> "description": "Payment schedule for the mandate.",
80921a83524
> "description": "Transaction type of the mandate.",
80932a83536
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
80941a83546
> "description": "Verification method for the intent",
80954a83560
> "description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.",
80956a83563
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
80963a83571
> "description": "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.",
80967a83576
> "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's 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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
80977a83587
> "description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.",
80979a83590
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
80991a83603
> "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.",
80993a83606
> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
81002a83616
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81014a83629
> "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.",
81016a83632
> "description": "Controls when the funds will be captured from the customer's account.",
81023a83640
> "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's 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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81035a83653
> "description": "If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.",
81037a83656
> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.",
81041a83661
> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.",
81052a83673
> "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`.",
81066a83688
> "description": "The list of bank transfer types 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`.",
81083a83706
> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
81089a83713
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81099a83724
> "description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.",
81101a83727
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81113a83740
> "description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.",
81115a83743
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
81122a83751
> "description": "Preferred language of the Klarna authorization page that the customer is redirected to",
81168a83798
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81178a83809
> "description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.",
81180a83812
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
81187a83820
> "description": "Token used for persistent Link logins.",
81191a83825
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81203a83838
> "description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.",
81205a83841
> "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.",
81208a83845
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81218a83856
> "description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.",
81220a83859
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81226a83866
> "description": "Confirm that the payer has accepted the P24 terms and conditions.",
81233a83874
> "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.",
81235a83877
> "description": "Additional fields for Mandate creation",
81240a83883
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81253a83897
> "description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.",
81255a83900
> "description": "Language shown to the payer on redirect.",
81268a83914
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81280a83927
> "description": "If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.",
81282a83930
> "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
81286a83935
> "description": "The client type that the end customer will pay from",
81295a83945
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
81312a83963
> "description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
81341a83993
> "description": "The URL to redirect the customer to after they authenticate their payment.",
81344a83997
> "description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.",
81348a84002
> "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
81352a84007
> "description": "Provides configuration for completing a transfer for the order after it is paid.",
81354a84010
> "description": "The amount that will be transferred automatically when the order 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.",
81357a84014
> "description": "ID of the Connected account receiving the transfer.",
81382a84040
> "description": "The ID of the shipping rate to use for this order.",
81386a84045
> "description": "Parameters to create a new ad-hoc shipping rate for this order.",
81388a84048
> "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.",
81390a84051
> "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.",
81392a84054
> "description": "A unit of time.",
81402a84065
> "description": "Must be greater than 0.",
81413a84077
> "description": "The lower bound of the estimated range. If empty, represents no lower bound.",
81415a84080
> "description": "A unit of time.",
81425a84091
> "description": "Must be greater than 0.",
81440a84107
> "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
81444a84112
> "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
81446a84115
> "description": "A non-negative integer in cents representing how much to charge.",
81449a84119
> "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).",
81455a84126
> "description": "A non-negative integer in cents representing how much to charge.",
81458a84130
> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
81472a84145
> "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).",
81486a84160
> "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`.",
81489a84164
> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
81497a84173
> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
81500a84177
> "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.",
81530a84208
> "description": "The shipping address for the order.",
81532a84211
> "description": "City, district, suburb, town, or village.",
81536a84216
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
81540a84221
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
81544a84226
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
81548a84231
> "description": "ZIP or postal code.",
81552a84236
> "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".",
81560a84245
> "description": "The name of the recipient of the order.",
81564a84250
> "description": "The phone number (including extension) for the recipient of the order.",
81588a84275
> "description": "The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.",
81597a84285
> "description": "The purchaser's tax IDs to be used for this order.",
81600a84289
> "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`",
81658a84348
> "description": "Value of the tax ID.",
81804,81807d84493
< "client_permissions": {
< "explode": true,
< "style": "deepObject"
< },
81847a84534
> "description": "Enable automatic tax calculation which will automatically compute tax rates on this order.",
81861a84549
> "description": "The billing address provided by the customer.",
81863a84552
> "description": "City, district, suburb, town, or village.",
81867a84557
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
81871a84562
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
81875a84567
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
81879a84572
> "description": "ZIP or postal code.",
81883a84577
> "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".",
81891a84586
> "description": "The billing email provided by the customer.",
81894a84590
> "description": "The billing name provided by the customer.",
81898a84595
> "description": "The billing phone number provided by the customer.",
81915,81942d84611
< "client_permissions": {
< "description": "The fields on the order that are allowed to be updated from your frontend application with a publishable key and order client secret.",
< "properties": {
< "billing_details": {
< "enum": [
< "allow",
< "disallow"
< ],
< "type": "string"
< },
< "promotion_codes": {
< "enum": [
< "allow",
< "disallow"
< ],
< "type": "string"
< },
< "shipping_details": {
< "enum": [
< "allow",
< "disallow"
< ],
< "type": "string"
< }
< },
< "title": "client_permissions",
< "type": "object"
< },
81962a84632
> "description": "ID of the coupon to create a new discount for.",
81966a84637
> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
81970a84642
> "description": "ID of the promotion code to create a new discount for.",
82005a84678
> "description": "The description for the line item. Will default to the name of the associated product.",
82014a84688
> "description": "ID of the coupon to create a new discount for.",
82018a84693
> "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
82034c84709,84710
< ]
---
> ],
> "description": "The discounts applied to this line item."
82036a84713
> "description": "The ID of an existing line item on the order.",
82040a84718
> "description": "The ID of a [Price](https://stripe.com/docs/api/prices) to add to the Order.\n\nThe `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.",
82044a84723
> "description": "Data used to generate a new Price object inline.\n\nThe `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create products upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.\n\nEach time you pass `price_data` we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused.",
82046a84726
> "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).",
82049a84730
> "description": "ID of the product this price belongs to.\n\nUse this to implement a variable-pricing model in your integration. This is required if `product_data` is not specifed.",
82053a84735
> "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.",
82061a84744
> "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
82064a84748
> "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.",
82072a84757
> "description": "The ID of a [Product](https://stripe.com/docs/api/products) to add to the Order.\n\nThe product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.",
82076a84762
> "description": "Defines a Product inline and adds it to the Order.\n\n`product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.\n\n`product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.",
82078a84765
> "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.",
82082a84770
> "description": "A unique identifier for this product.\n\n`product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products.",
82100c84788,84789
< ]
---
> ],
> "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer."
82116c84805,84806
< ]
---
> ],
> "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`."
82118a84809
> "description": "The product's name, meant to be displayable to the customer.",
82126a84818
> "description": "Height, in inches. Maximum precision is 2 decimal places.",
82129a84822
> "description": "Length, in inches. Maximum precision is 2 decimal places.",
82132a84826
> "description": "Weight, in ounces. Maximum precision is 2 decimal places.",
82135a84830
> "description": "Width, in inches. Maximum precision is 2 decimal places.",
82154c84849,84850
< ]
---
> ],
> "description": "The dimensions of this product for shipping purposes."
82156a84853
> "description": "Whether this product is shipped (i.e., physical goods).",
82159a84857
> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
82174c84872,84873
< ]
---
> ],
> "description": "A URL of a publicly-accessible webpage for this product."
82184a84884
> "description": "The quantity of the line item.",
82202c84902,84903
< ]
---
> ],
> "description": "The tax rates applied to this line item."
82230a84932
> "description": "Settings describing how the order should configure generated PaymentIntents.",
82243c84945,84946
< ]
---
> ],
> "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."
82245a84949
> "description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.",
82251a84956
> "description": "Additional fields for Mandate creation",
82264c84969,84970
< ]
---
> ],
> "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."
82266a84973
> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
82270a84978
> "description": "Payment schedule for the mandate.",
82278a84987
> "description": "Transaction type of the mandate.",
82289a84999
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82298a85009
> "description": "Verification method for the intent",
82317c85028,85029
< ]
---
> ],
> "description": "If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent."
82323a85036
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
82330a85044
> "description": "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.",
82334a85049
> "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's 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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82350c85065,85066
< ]
---
> ],
> "description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent."
82356a85073
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82374c85091,85092
< ]
---
> ],
> "description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent."
82380a85099
> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
82389a85109
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82407c85127,85128
< ]
---
> ],
> "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent."
82413a85135
> "description": "Controls when the funds will be captured from the customer's account.",
82420a85143
> "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's 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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82438c85161,85162
< ]
---
> ],
> "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent."
82444a85169
> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.",
82448a85174
> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.",
82459a85186
> "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`.",
82473a85201
> "description": "The list of bank transfer types 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`.",
82490a85219
> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
82496a85226
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82512c85242,85243
< ]
---
> ],
> "description": "If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent."
82518a85250
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82536c85268,85269
< ]
---
> ],
> "description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent."
82542a85276
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
82549a85284
> "description": "Preferred language of the Klarna authorization page that the customer is redirected to",
82595a85331
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82611c85347,85348
< ]
---
> ],
> "description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent."
82617a85355
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
82624a85363
> "description": "Token used for persistent Link logins.",
82628a85368
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82646c85386,85387
< ]
---
> ],
> "description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent."
82652a85394
> "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.",
82655a85398
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82671c85414,85415
< ]
---
> ],
> "description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent."
82677a85422
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82683a85429
> "description": "Confirm that the payer has accepted the P24 terms and conditions.",
82696c85442,85443
< ]
---
> ],
> "description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent."
82702a85450
> "description": "Additional fields for Mandate creation",
82707a85456
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82726c85475,85476
< ]
---
> ],
> "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent."
82732a85483
> "description": "Language shown to the payer on redirect.",
82745a85497
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82763c85515,85516
< ]
---
> ],
> "description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent."
82769a85523
> "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
82773a85528
> "description": "The client type that the end customer will pay from",
82782a85538
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
82801c85557,85558
< ]
---
> ],
> "description": "If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent."
82807a85565
> "description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
82847c85605,85606
< ]
---
> ],
> "description": "The URL to redirect the customer to after they authenticate their payment."
82849a85609
> "description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.",
82853a85614
> "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
82861a85623
> "description": "The amount that will be transferred automatically when the order 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.",
82864a85627
> "description": "ID of the Connected account receiving the transfer.",
82880c85643,85644
< ]
---
> ],
> "description": "Provides configuration for completing a transfer for the order after it is paid."
82897a85662
> "description": "The ID of the shipping rate to use for this order.",
82901a85667
> "description": "Parameters to create a new ad-hoc shipping rate for this order.",
82903a85670
> "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.",
82905a85673
> "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.",
82907a85676
> "description": "A unit of time.",
82917a85687
> "description": "Must be greater than 0.",
82928a85699
> "description": "The lower bound of the estimated range. If empty, represents no lower bound.",
82930a85702
> "description": "A unit of time.",
82940a85713
> "description": "Must be greater than 0.",
82955a85729
> "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
82959a85734
> "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
82961a85737
> "description": "A non-negative integer in cents representing how much to charge.",
82964a85741
> "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).",
82970a85748
> "description": "A non-negative integer in cents representing how much to charge.",
82973a85752
> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
82987a85767
> "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).",
83001a85782
> "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`.",
83004a85786
> "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
83012a85795
> "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
83015a85799
> "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.",
83045a85830
> "description": "The shipping address for the order.",
83047a85833
> "description": "City, district, suburb, town, or village.",
83051a85838
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
83055a85843
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
83059a85848
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
83063a85853
> "description": "ZIP or postal code.",
83067a85858
> "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".",
83075a85867
> "description": "The name of the recipient of the order.",
83079a85872
> "description": "The phone number (including extension) for the recipient of the order.",
83103a85897
> "description": "The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.",
83112a85907
> "description": "The purchaser's tax IDs to be used for this order.",
83115a85911
> "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`",
83173a85970
> "description": "Value of the tax ID.",
83580a86378
> "description": "Minimum value to filter by (exclusive)",
83583a86382
> "description": "Minimum value to filter by (inclusive)",
83586a86386
> "description": "Maximum value to filter by (exclusive)",
83589a86390
> "description": "Maximum value to filter by (inclusive)",
83800a86602
> "description": "Whether this feature is enabled.",
83863a86666
> "description": "This hash contains details about the customer acceptance of the Mandate.",
83865a86669
> "description": "The time at which the customer accepted the Mandate.",
83869a86674
> "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
83874a86680
> "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
83876a86683
> "description": "The IP address from which the Mandate was accepted by the customer.",
83879a86687
> "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
83891a86700
> "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
83941c86750
< "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.\n\nIf this parameter is omitted with `confirm=true`, `customer.default_source` will be attached as this PaymentIntent's payment instrument to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward.",
---
> "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.\n\nIf neither the `payment_method` parameter nor the `source` parameter are provided with `confirm=true`, `source` will be automatically populated with `customer.default_source` to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward.",
83948a86758
> "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.",
83950a86761
> "description": "Customer's bank account number.",
83954a86766
> "description": "Institution number of the customer's bank.",
83958a86771
> "description": "Transit number of the customer's bank.",
83971a86785
> "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
83976a86791
> "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.",
83981a86797
> "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.",
83986a86803
> "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.",
83988a86806
> "description": "The account number for the bank account.",
83992a86811
> "description": "Bank-State-Branch number of the bank account.",
84004a86824
> "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
84006a86827
> "description": "Account number of the bank account that the funds will be debited from.",
84010a86832
> "description": "Sort code of the bank account. (e.g., `10-20-30`)",
84018a86841
> "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
84023a86847
> "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.",
84029a86854
> "description": "City, district, suburb, town, or village.",
84033a86859
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
84037a86864
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
84041a86869
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
84045a86874
> "description": "ZIP or postal code.",
84049a86879
> "description": "State, county, province, or region.",
84063c86893,86894
< ]
---
> ],
> "description": "Billing address."
84076c86907,86908
< ]
---
> ],
> "description": "Email address."
84078a86911
> "description": "Full name.",
84082a86916
> "description": "Billing phone number (including extension).",
84090a86925
> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
84095a86931
> "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.",
84097a86934
> "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)",
84108a86946
> "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.",
84113a86952
> "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.",
84115a86955
> "description": "The customer's bank.",
84153a86994
> "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
84154a86996,87004
> "account_holder_type": {
> "description": "Account holder type for FPX transaction",
> "enum": [
> "company",
> "individual"
> ],
> "maxLength": 5000,
> "type": "string"
> },
84155a87006
> "description": "The customer's bank.",
84191a87043
> "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
84196a87049
> "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.",
84201a87055
> "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.",
84203a87058
> "description": "The customer's bank.",
84226a87082
> "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
84231a87088
> "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
84233a87091
> "description": "Customer's date of birth",
84235a87094
> "description": "The day of birth, between 1 and 31.",
84238a87098
> "description": "The month of birth, between 1 and 12.",
84241a87102
> "description": "The four-digit year of birth.",
84257a87119
> "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
84262a87125
> "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.",
84270a87134
> "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`.",
84273a87138
> "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.",
84278a87144
> "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.",
84280a87147
> "description": "The customer's bank.",
84315a87183
> "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
84320a87189
> "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
84325a87195
> "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
84330a87201
> "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
84332a87204
> "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.",
84340a87213
> "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
84342a87216
> "description": "IBAN of the bank account.",
84353a87228
> "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
84355a87231
> "description": "Two-letter ISO code representing the country the bank account is located in.",
84373a87250
> "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.",
84406a87284
> "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.",
84408a87287
> "description": "Account holder type: individual or company.",
84415a87295
> "description": "Account number of the bank account.",
84419a87300
> "description": "Account type: checkings or savings. Defaults to checking if omitted.",
84426a87308
> "description": "The ID of a Financial Connections Account to use as a payment method.",
84430a87313
> "description": "Routing number of the bank account.",
84438a87322
> "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
84457a87342
> "description": "Additional fields for Mandate creation",
84470c87355,87356
< ]
---
> ],
> "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."
84472a87359
> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
84476a87364
> "description": "Payment schedule for the mandate.",
84484a87373
> "description": "Transaction type of the mandate.",
84495a87385
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84504a87395
> "description": "Verification method for the intent",
84523c87414,87415
< ]
---
> ],
> "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options."
84529a87422
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
84536a87430
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84552c87446,87447
< ]
---
> ],
> "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options."
84558a87454
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
84565a87462
> "description": "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.",
84569a87467
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84586c87484,87485
< ]
---
> ],
> "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options."
84592a87492
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84610c87510,87511
< ]
---
> ],
> "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options."
84616a87518
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84635c87537,87538
< ]
---
> ],
> "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options."
84641a87545
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84660c87564,87565
< ]
---
> ],
> "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options."
84666a87572
> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
84675a87582
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84693c87600,87601
< ]
---
> ],
> "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options."
84699a87608
> "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
84713c87622,87623
< ]
---
> ],
> "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options."
84719a87630
> "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.",
84722a87634
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84741c87653,87654
< ]
---
> ],
> "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options."
84747a87661
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
84754a87669
> "description": "A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.",
84758a87674
> "description": "Installment configuration for payments attempted on this PaymentIntent (Mexico Only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
84760a87677
> "description": "Setting to true enables installments for this PaymentIntent.\nThis will cause the response to contain a list of available installment plans.\nSetting to false will prevent any selected plan from applying to a charge.",
84767a87685
> "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.",
84770a87689
> "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
84776a87696
> "description": "Type of installment plan, one of `fixed_count`.",
84797c87717,87718
< ]
---
> ],
> "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation."
84803a87725
> "description": "Configuration options for setting up an eMandate for cards issued in India.",
84805a87728
> "description": "Amount to be charged for future payments.",
84808a87732
> "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.",
84815a87740
> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
84819a87745
> "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.",
84823a87750
> "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
84833a87761
> "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`.",
84836a87765
> "description": "Unique identifier for the mandate or subscription.",
84840a87770
> "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.",
84844a87775
> "description": "Specifies the type of mandates supported. Possible values are `india`.",
84863a87795,87798
> "moto": {
> "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
> "type": "boolean"
> },
84864a87800
> "description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.",
84881a87818
> "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.",
84890a87828
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
84911c87849,87850
< ]
---
> ],
> "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."
84925c87864,87865
< ]
---
> ],
> "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."
84937c87877,87878
< ]
---
> ],
> "description": "Configuration for any card payments attempted on this PaymentIntent."
84943a87885
> "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
84946a87889
> "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.",
84959c87902,87903
< ]
---
> ],
> "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
84965a87910
> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.",
84969a87915
> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.",
84980a87927
> "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`.",
84994a87942
> "description": "The list of bank transfer types 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`.",
85011a87960
> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
85017a87967
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85033c87983,87984
< ]
---
> ],
> "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options."
85039a87991
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85055c88007,88008
< ]
---
> ],
> "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options."
85061a88015
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85077c88031,88032
< ]
---
> ],
> "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options."
85083a88039
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85099c88055,88056
< ]
---
> ],
> "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options."
85105a88063
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85121c88079,88080
< ]
---
> ],
> "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options."
85127a88087
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85145c88105,88106
< ]
---
> ],
> "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options."
85160c88121,88122
< ]
---
> ],
> "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
85166a88129
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
85173a88137
> "description": "Preferred language of the Klarna authorization page that the customer is redirected to",
85219a88184
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85235c88200,88201
< ]
---
> ],
> "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options."
85241a88208
> "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.",
85256c88223,88224
< ]
---
> ],
> "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."
85270c88238,88239
< ]
---
> ],
> "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
85272a88242
> "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
85276a88247
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85292c88263,88264
< ]
---
> ],
> "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options."
85298a88271
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
85305a88279
> "description": "Token used for persistent Link logins.",
85309a88284
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85327c88302,88303
< ]
---
> ],
> "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
85333a88310
> "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.",
85336a88314
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85352c88330,88331
< ]
---
> ],
> "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options."
85358a88338
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85364a88345
> "description": "Confirm that the payer has accepted the P24 terms and conditions.",
85377c88358,88359
< ]
---
> ],
> "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options."
85383a88366
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85399c88382,88383
< ]
---
> ],
> "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options."
85405a88390
> "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.",
85408a88394
> "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.",
85412a88399
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85428c88415,88416
< ]
---
> ],
> "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options."
85434a88423
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85450c88439,88440
< ]
---
> ],
> "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
85456a88447
> "description": "Additional fields for Mandate creation",
85461a88453
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85480c88472,88473
< ]
---
> ],
> "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options."
85486a88480
> "description": "Language shown to the payer on redirect.",
85499a88494
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85517c88512,88513
< ]
---
> ],
> "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options."
85523a88520
> "description": "Additional fields for Financial Connections Session creation",
85525a88523
> "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`.",
85539a88538
> "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.",
85547a88547
> "description": "Additional fields for network related functions",
85549a88550
> "description": "Triggers validations to run across the selected networks",
85563a88565
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85572a88575
> "description": "Verification method for the intent",
85591c88594,88595
< ]
---
> ],
> "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options."
85597a88602
> "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
85601a88607
> "description": "The client type that the end customer will pay from",
85610a88617
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
85629c88636,88637
< ]
---
> ],
> "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options."
85646a88655
> "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.",
85673a88683
> "description": "Shipping address.",
85675a88686
> "description": "City, district, suburb, town, or village.",
85679a88691
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
85683a88696
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
85687a88701
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
85691a88706
> "description": "ZIP or postal code.",
85695a88711
> "description": "State, county, province, or region.",
85703a88720
> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
85707a88725
> "description": "Recipient name.",
85711a88730
> "description": "Recipient phone (including extension).",
85715a88735
> "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.",
85740a88761
> "description": "The amount that will be transferred automatically when a charge succeeds.\nThe amount is capped at the total transaction amount and if no amount is set,\nthe full amount is transferred.\n\nIf you intend to collect a fee and you need a more robust reporting experience, using\n[application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount)\nmight be a better fit for your integration.",
85743a88765
> "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.",
85901a88924
> "next_page",
86138a89162
> "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.",
86140a89165
> "description": "Customer's bank account number.",
86144a89170
> "description": "Institution number of the customer's bank.",
86148a89175
> "description": "Transit number of the customer's bank.",
86161a89189
> "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
86166a89195
> "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.",
86171a89201
> "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.",
86176a89207
> "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.",
86178a89210
> "description": "The account number for the bank account.",
86182a89215
> "description": "Bank-State-Branch number of the bank account.",
86194a89228
> "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
86196a89231
> "description": "Account number of the bank account that the funds will be debited from.",
86200a89236
> "description": "Sort code of the bank account. (e.g., `10-20-30`)",
86208a89245
> "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
86213a89251
> "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.",
86219a89258
> "description": "City, district, suburb, town, or village.",
86223a89263
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
86227a89268
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
86231a89273
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
86235a89278
> "description": "ZIP or postal code.",
86239a89283
> "description": "State, county, province, or region.",
86253c89297,89298
< ]
---
> ],
> "description": "Billing address."
86266c89311,89312
< ]
---
> ],
> "description": "Email address."
86268a89315
> "description": "Full name.",
86272a89320
> "description": "Billing phone number (including extension).",
86280a89329
> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
86285a89335
> "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.",
86287a89338
> "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)",
86298a89350
> "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.",
86303a89356
> "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.",
86305a89359
> "description": "The customer's bank.",
86343a89398
> "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
86344a89400,89408
> "account_holder_type": {
> "description": "Account holder type for FPX transaction",
> "enum": [
> "company",
> "individual"
> ],
> "maxLength": 5000,
> "type": "string"
> },
86345a89410
> "description": "The customer's bank.",
86381a89447
> "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
86386a89453
> "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.",
86391a89459
> "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.",
86393a89462
> "description": "The customer's bank.",
86416a89486
> "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
86421a89492
> "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
86423a89495
> "description": "Customer's date of birth",
86425a89498
> "description": "The day of birth, between 1 and 31.",
86428a89502
> "description": "The month of birth, between 1 and 12.",
86431a89506
> "description": "The four-digit year of birth.",
86447a89523
> "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
86452a89529
> "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.",
86460a89538
> "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`.",
86463a89542
> "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.",
86468a89548
> "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.",
86470a89551
> "description": "The customer's bank.",
86505a89587
> "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
86510a89593
> "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
86515a89599
> "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
86520a89605
> "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
86522a89608
> "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.",
86530a89617
> "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
86532a89620
> "description": "IBAN of the bank account.",
86543a89632
> "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
86545a89635
> "description": "Two-letter ISO code representing the country the bank account is located in.",
86563a89654
> "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.",
86596a89688
> "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.",
86598a89691
> "description": "Account holder type: individual or company.",
86605a89699
> "description": "Account number of the bank account.",
86609a89704
> "description": "Account type: checkings or savings. Defaults to checking if omitted.",
86616a89712
> "description": "The ID of a Financial Connections Account to use as a payment method.",
86620a89717
> "description": "Routing number of the bank account.",
86628a89726
> "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
86647a89746
> "description": "Additional fields for Mandate creation",
86660c89759,89760
< ]
---
> ],
> "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."
86662a89763
> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
86666a89768
> "description": "Payment schedule for the mandate.",
86674a89777
> "description": "Transaction type of the mandate.",
86685a89789
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86694a89799
> "description": "Verification method for the intent",
86713c89818,89819
< ]
---
> ],
> "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options."
86719a89826
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
86726a89834
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86742c89850,89851
< ]
---
> ],
> "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options."
86748a89858
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
86755a89866
> "description": "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.",
86759a89871
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86776c89888,89889
< ]
---
> ],
> "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options."
86782a89896
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86800c89914,89915
< ]
---
> ],
> "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options."
86806a89922
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86825c89941,89942
< ]
---
> ],
> "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options."
86831a89949
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86850c89968,89969
< ]
---
> ],
> "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options."
86856a89976
> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
86865a89986
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86883c90004,90005
< ]
---
> ],
> "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options."
86889a90012
> "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
86903c90026,90027
< ]
---
> ],
> "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options."
86909a90034
> "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.",
86912a90038
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
86931c90057,90058
< ]
---
> ],
> "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options."
86937a90065
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
86944a90073
> "description": "A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.",
86948a90078
> "description": "Installment configuration for payments attempted on this PaymentIntent (Mexico Only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
86950a90081
> "description": "Setting to true enables installments for this PaymentIntent.\nThis will cause the response to contain a list of available installment plans.\nSetting to false will prevent any selected plan from applying to a charge.",
86957a90089
> "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.",
86960a90093
> "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
86966a90100
> "description": "Type of installment plan, one of `fixed_count`.",
86987c90121,90122
< ]
---
> ],
> "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation."
86993a90129
> "description": "Configuration options for setting up an eMandate for cards issued in India.",
86995a90132
> "description": "Amount to be charged for future payments.",
86998a90136
> "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.",
87005a90144
> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
87009a90149
> "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.",
87013a90154
> "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
87023a90165
> "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`.",
87026a90169
> "description": "Unique identifier for the mandate or subscription.",
87030a90174
> "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.",
87034a90179
> "description": "Specifies the type of mandates supported. Possible values are `india`.",
87053a90199,90202
> "moto": {
> "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
> "type": "boolean"
> },
87054a90204
> "description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.",
87071a90222
> "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.",
87080a90232
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87101c90253,90254
< ]
---
> ],
> "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."
87115c90268,90269
< ]
---
> ],
> "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."
87127c90281,90282
< ]
---
> ],
> "description": "Configuration for any card payments attempted on this PaymentIntent."
87133a90289
> "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
87136a90293
> "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.",
87149c90306,90307
< ]
---
> ],
> "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
87155a90314
> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.",
87159a90319
> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.",
87170a90331
> "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`.",
87184a90346
> "description": "The list of bank transfer types 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`.",
87201a90364
> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
87207a90371
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87223c90387,90388
< ]
---
> ],
> "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options."
87229a90395
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87245c90411,90412
< ]
---
> ],
> "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options."
87251a90419
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87267c90435,90436
< ]
---
> ],
> "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options."
87273a90443
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87289c90459,90460
< ]
---
> ],
> "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options."
87295a90467
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87311c90483,90484
< ]
---
> ],
> "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options."
87317a90491
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87335c90509,90510
< ]
---
> ],
> "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options."
87350c90525,90526
< ]
---
> ],
> "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
87356a90533
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
87363a90541
> "description": "Preferred language of the Klarna authorization page that the customer is redirected to",
87409a90588
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87425c90604,90605
< ]
---
> ],
> "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options."
87431a90612
> "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.",
87446c90627,90628
< ]
---
> ],
> "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."
87460c90642,90643
< ]
---
> ],
> "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
87462a90646
> "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
87466a90651
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87482c90667,90668
< ]
---
> ],
> "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options."
87488a90675
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
87495a90683
> "description": "Token used for persistent Link logins.",
87499a90688
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87517c90706,90707
< ]
---
> ],
> "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
87523a90714
> "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.",
87526a90718
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87542c90734,90735
< ]
---
> ],
> "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options."
87548a90742
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87554a90749
> "description": "Confirm that the payer has accepted the P24 terms and conditions.",
87567c90762,90763
< ]
---
> ],
> "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options."
87573a90770
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87589c90786,90787
< ]
---
> ],
> "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options."
87595a90794
> "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.",
87598a90798
> "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.",
87602a90803
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87618c90819,90820
< ]
---
> ],
> "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options."
87624a90827
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87640c90843,90844
< ]
---
> ],
> "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
87646a90851
> "description": "Additional fields for Mandate creation",
87651a90857
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87670c90876,90877
< ]
---
> ],
> "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options."
87676a90884
> "description": "Language shown to the payer on redirect.",
87689a90898
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87707c90916,90917
< ]
---
> ],
> "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options."
87713a90924
> "description": "Additional fields for Financial Connections Session creation",
87715a90927
> "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`.",
87729a90942
> "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.",
87737a90951
> "description": "Additional fields for network related functions",
87739a90954
> "description": "Triggers validations to run across the selected networks",
87753a90969
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87762a90979
> "description": "Verification method for the intent",
87781c90998,90999
< ]
---
> ],
> "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options."
87787a91006
> "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
87791a91011
> "description": "The client type that the end customer will pay from",
87800a91021
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
87819c91040,91041
< ]
---
> ],
> "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options."
87860a91083
> "description": "Shipping address.",
87862a91086
> "description": "City, district, suburb, town, or village.",
87866a91091
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
87870a91096
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
87874a91101
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
87878a91106
> "description": "ZIP or postal code.",
87882a91111
> "description": "State, county, province, or region.",
87890a91120
> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
87894a91125
> "description": "Recipient name.",
87898a91130
> "description": "Recipient phone (including extension).",
87902a91135
> "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.",
87936a91170
> "description": "The amount that will be transferred automatically when a charge succeeds.",
88193a91428
> "description": "The amount that will be transferred automatically when a charge succeeds.",
88271,88274d91505
< "payment_method_types": {
< "explode": true,
< "style": "deepObject"
< },
88299,88303d91529
< "client_secret": {
< "description": "The client secret of the PaymentIntent.",
< "maxLength": 5000,
< "type": "string"
< },
88325a91552
> "description": "This hash contains details about the customer acceptance of the Mandate.",
88327a91555
> "description": "The time at which the customer accepted the Mandate.",
88331a91560
> "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
88336a91566
> "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
88338a91569
> "description": "The IP address from which the Mandate was accepted by the customer.",
88341a91573
> "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
88353a91586
> "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
88377a91611
> "description": "This hash contains details about the customer acceptance of the Mandate.",
88379a91614
> "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
88381a91617
> "description": "The IP address from which the Mandate was accepted by the customer.",
88384a91621
> "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
88392a91630
> "description": "The type of customer acceptance information included with the Mandate.",
88412c91650,91653
< "type": "object"
---
> "type": "object",
> "x-stripeParam": {
> "class_name": "MandateDataPublishableKey"
> }
88441a91683
> "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.",
88443a91686
> "description": "Customer's bank account number.",
88447a91691
> "description": "Institution number of the customer's bank.",
88451a91696
> "description": "Transit number of the customer's bank.",
88464a91710
> "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
88469a91716
> "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.",
88474a91722
> "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.",
88479a91728
> "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.",
88481a91731
> "description": "The account number for the bank account.",
88485a91736
> "description": "Bank-State-Branch number of the bank account.",
88497a91749
> "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
88499a91752
> "description": "Account number of the bank account that the funds will be debited from.",
88503a91757
> "description": "Sort code of the bank account. (e.g., `10-20-30`)",
88511a91766
> "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
88516a91772
> "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.",
88522a91779
> "description": "City, district, suburb, town, or village.",
88526a91784
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
88530a91789
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
88534a91794
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
88538a91799
> "description": "ZIP or postal code.",
88542a91804
> "description": "State, county, province, or region.",
88556c91818,91819
< ]
---
> ],
> "description": "Billing address."
88569c91832,91833
< ]
---
> ],
> "description": "Email address."
88571a91836
> "description": "Full name.",
88575a91841
> "description": "Billing phone number (including extension).",
88583a91850
> "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
88588a91856
> "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.",
88590a91859
> "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)",
88601a91871
> "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.",
88606a91877
> "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.",
88608a91880
> "description": "The customer's bank.",
88646a91919
> "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
88647a91921,91929
> "account_holder_type": {
> "description": "Account holder type for FPX transaction",
> "enum": [
> "company",
> "individual"
> ],
> "maxLength": 5000,
> "type": "string"
> },
88648a91931
> "description": "The customer's bank.",
88684a91968
> "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
88689a91974
> "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.",
88694a91980
> "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.",
88696a91983
> "description": "The customer's bank.",
88719a92007
> "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
88724a92013
> "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
88726a92016
> "description": "Customer's date of birth",
88728a92019
> "description": "The day of birth, between 1 and 31.",
88731a92023
> "description": "The month of birth, between 1 and 12.",
88734a92027
> "description": "The four-digit year of birth.",
88750a92044
> "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
88755a92050
> "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.",
88763a92059
> "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`.",
88766a92063
> "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.",
88771a92069
> "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.",
88773a92072
> "description": "The customer's bank.",
88808a92108
> "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
88813a92114
> "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
88818a92120
> "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
88823a92126
> "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
88825a92129
> "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.",
88833a92138
> "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
88835a92141
> "description": "IBAN of the bank account.",
88846a92153
> "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
88848a92156
> "description": "Two-letter ISO code representing the country the bank account is located in.",
88866a92175
> "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.",
88899a92209
> "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.",
88901a92212
> "description": "Account holder type: individual or company.",
88908a92220
> "description": "Account number of the bank account.",
88912a92225
> "description": "Account type: checkings or savings. Defaults to checking if omitted.",
88919a92233
> "description": "The ID of a Financial Connections Account to use as a payment method.",
88923a92238
> "description": "Routing number of the bank account.",
88931a92247
> "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
88950a92267
> "description": "Additional fields for Mandate creation",
88963c92280,92281
< ]
---
> ],
> "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."
88965a92284
> "description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
88969a92289
> "description": "Payment schedule for the mandate.",
88977a92298
> "description": "Transaction type of the mandate.",
88988a92310
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
88997a92320
> "description": "Verification method for the intent",
89016c92339,92340
< ]
---
> ],
> "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options."
89022a92347
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
89029a92355
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89045c92371,92372
< ]
---
> ],
> "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options."
89051a92379
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
89058a92387
> "description": "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.",
89062a92392
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89079c92409,92410
< ]
---
> ],
> "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options."
89085a92417
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89103c92435,92436
< ]
---
> ],
> "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options."
89109a92443
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89128c92462,92463
< ]
---
> ],
> "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options."
89134a92470
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89153c92489,92490
< ]
---
> ],
> "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options."
89159a92497
> "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
89168a92507
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89186c92525,92526
< ]
---
> ],
> "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options."
89192a92533
> "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
89206c92547,92548
< ]
---
> ],
> "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options."
89212a92555
> "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.",
89215a92559
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89234c92578,92579
< ]
---
> ],
> "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options."
89240a92586
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
89247a92594
> "description": "A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.",
89251a92599
> "description": "Installment configuration for payments attempted on this PaymentIntent (Mexico Only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
89253a92602
> "description": "Setting to true enables installments for this PaymentIntent.\nThis will cause the response to contain a list of available installment plans.\nSetting to false will prevent any selected plan from applying to a charge.",
89260a92610
> "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.",
89263a92614
> "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
89269a92621
> "description": "Type of installment plan, one of `fixed_count`.",
89290c92642,92643
< ]
---
> ],
> "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation."
89296a92650
> "description": "Configuration options for setting up an eMandate for cards issued in India.",
89298a92653
> "description": "Amount to be charged for future payments.",
89301a92657
> "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.",
89308a92665
> "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
89312a92670
> "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.",
89316a92675
> "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
89326a92686
> "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`.",
89329a92690
> "description": "Unique identifier for the mandate or subscription.",
89333a92695
> "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.",
89337a92700
> "description": "Specifies the type of mandates supported. Possible values are `india`.",
89356a92720,92723
> "moto": {
> "description": "When specified, this parameter indicates that a transaction will be marked\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation.",
> "type": "boolean"
> },
89357a92725
> "description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.",
89374a92743
> "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.",
89383a92753
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89404c92774,92775
< ]
---
> ],
> "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."
89418c92789,92790
< ]
---
> ],
> "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."
89430c92802,92803
< ]
---
> ],
> "description": "Configuration for any card payments attempted on this PaymentIntent."
89436a92810
> "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
89439a92814
> "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.",
89452c92827,92828
< ]
---
> ],
> "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
89458a92835
> "description": "Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.",
89462a92840
> "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.",
89473a92852
> "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`.",
89487a92867
> "description": "The list of bank transfer types 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`.",
89504a92885
> "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
89510a92892
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89526c92908,92909
< ]
---
> ],
> "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options."
89532a92916
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89548c92932,92933
< ]
---
> ],
> "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options."
89554a92940
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89570c92956,92957
< ]
---
> ],
> "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options."
89576a92964
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89592c92980,92981
< ]
---
> ],
> "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options."
89598a92988
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89614c93004,93005
< ]
---
> ],
> "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options."
89620a93012
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89638c93030,93031
< ]
---
> ],
> "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options."
89653c93046,93047
< ]
---
> ],
> "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
89659a93054
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
89666a93062
> "description": "Preferred language of the Klarna authorization page that the customer is redirected to",
89712a93109
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89728c93125,93126
< ]
---
> ],
> "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options."
89734a93133
> "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.",
89749c93148,93149
< ]
---
> ],
> "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."
89763c93163,93164
< ]
---
> ],
> "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
89765a93167
> "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
89769a93172
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89785c93188,93189
< ]
---
> ],
> "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options."
89791a93196
> "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.",
89798a93204
> "description": "Token used for persistent Link logins.",
89802a93209
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89820c93227,93228
< ]
---
> ],
> "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
89826a93235
> "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.",
89829a93239
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89845c93255,93256
< ]
---
> ],
> "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options."
89851a93263
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89857a93270
> "description": "Confirm that the payer has accepted the P24 terms and conditions.",
89870c93283,93284
< ]
---
> ],
> "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options."
89876a93291
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89892c93307,93308
< ]
---
> ],
> "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options."
89898a93315
> "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.",
89901a93319
> "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.",
89905a93324
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89921c93340,93341
< ]
---
> ],
> "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options."
89927a93348
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89943c93364,93365
< ]
---
> ],
> "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
89949a93372
> "description": "Additional fields for Mandate creation",
89954a93378
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
89973c93397,93398
< ]
---
> ],
> "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options."
89979a93405
> "description": "Language shown to the payer on redirect.",
89992a93419
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
90010c93437,93438
< ]
---
> ],
> "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options."
90016a93445
> "description": "Additional fields for Financial Connections Session creation",
90018a93448
> "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`.",
90032a93463
> "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.",
90040a93472
> "description": "Additional fields for network related functions",
90042a93475
> "description": "Triggers validations to run across the selected networks",
90056a93490
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
90065a93500
> "description": "Verification method for the intent",
90084c93519,93520
< ]
---
> ],
> "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options."
90090a93527
> "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
90094a93532
> "description": "The client type that the end customer will pay from",
90103a93542
> "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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
90122c93561,93562
< ]
---
> ],
> "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options."
90128,90135d93567
< "payment_method_types": {
< "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. Use automatic_payment_methods to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
< "items": {
< "maxLength": 5000,
< "type": "string"
< },
< "type": "array"
< },
90139a93572
> "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.",
90178a93612
> "description": "Shipping address.",
90180a93615
> "description": "City, district, suburb, town, or village.",
90184a93620
> "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
90188a93625
> "description": "Address line 1 (e.g., street, PO Box, or company name).",
90192a93630
> "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
90196a93635
> "description": "ZIP or postal code.",
90200a93640
> "description": "State, county, province, or region.",
90208a93649
> "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
90212a93654
> "description": "Recipient name.",
90216a93659
> "description": "Recipient phone (including extension).",
90220a93664
> "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.",
90348a93793
> "description": "The amount that will be transferred automatically when a charge succeeds.",
90428,90432d93872
< "client_secret": {
< "description": "The client secret of the PaymentIntent.",
< "maxLength": 5000,
< "type": "string"
< },
90682a94123
> "description": "Configuration when `type=hosted_confirmation`.",
90684a94126
> "description": "A custom message to display to the customer after the purchase is complete.",
90692a94135
> "description": "Configuration when `type=redirect`.",
90694a94138
> "description": "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](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.",
90705a94150
> "description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.",
90734a94180
> "description": "If `true`, tax will be calculated automatically using the customer's location.",
90755a94202
> "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.",
90762a94210
> "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).",
90797a94246
> "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.",
90799a94249
> "description": "Set to true if the quantity can be adjusted to any non-negative Integer.",
90802a94253
> "description": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 99.",
90805a94257
> "description": "The minimum quantity the customer can purchase. By default this value is 0. You can specify a value up to 98. If there is only one item in the cart then that item's quantity cannot go down to 0.",
90815a94268
> "description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.",
90819a94273
> "description": "The quantity of the line item being purchased.",
90846a94301
> "description": "Controls when the funds will be captured from the customer's account.",
90853a94309
> "description": "Indicates that you intend to [make future payments](https://stripe.com/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.",
90910a94367
> "description": "Set to `true` to enable phone number collection.",
90923a94381
> "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`.",
91179a94638
> "description": "The ID of the Shipping Rate to use for this shipping option.",
91202a94662
> "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
91206a94667
> "description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.",
91216a94678
> "description": "Set to `true` to enable tax ID collection.",
91229a94692
> "description": "The amount that will be transferred automatically when a charge succeeds.",
91232a94696
> "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.",
91401a94866
> "description": "Configuration when `type=hosted_confirmation`.",
91403a94869
> "description": "A custom message to display to the customer after the purchase is complete.",
91411a94878
> "description": "Configuration when `type=redirect`.",
91413a94881
> "description": "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](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-id) included.",
91424a94893
> "description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.",
91445a94915
> "description": "If `true`, tax will be calculated automatically using the customer's location.",
91483a94954
> "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.",
91485a94957
> "description": "Set to true if the quantity can be adjusted to any non-negative Integer.",
91488a94961
> "description": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 99.",
91491a94965
> "description": "The minimum quantity the customer can purchase. By default this value is 0. You can specify a value up to 98. If there is only one item in the cart then that item's quantity cannot go down to 0.",
91501a94976
> "description": "The ID of an existing line item on the payment link.",
91505a94981
> "description": "The quantity of the line item being purchased.",
91581a95058
> "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`.",
92011c95488
< "description": "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."