diff --git a/embedded/openapi/fixtures3.json b/embedded/openapi/fixtures3.json
index 308f4684..2e924b96 100644
--- a/embedded/openapi/fixtures3.json
+++ b/embedded/openapi/fixtures3.json
@@ -577,7 +577,8 @@
"status": "unavailable"
},
"three_d_secure": null,
- "wallet": null
+ "wallet": null,
+ "authorization_code": null
},
"type": "card"
},
@@ -664,7 +665,6 @@
"setup_intent": null,
"shipping_address_collection": null,
"shipping_cost": null,
- "shipping_details": null,
"shipping_options": [],
"status": "open",
"submit_type": null,
@@ -672,7 +672,8 @@
"success_url": "https://example.com/success",
"total_details": null,
"ui_mode": "hosted",
- "url": "https://checkout.stripe.com/pay/c/cs_test_a1YS1URlnyQCN5fUUduORoQ7Pw41PJqDWkIVQCpJPqkfIhd6tVY8XB1OLY"
+ "url": "https://checkout.stripe.com/pay/c/cs_test_a1YS1URlnyQCN5fUUduORoQ7Pw41PJqDWkIVQCpJPqkfIhd6tVY8XB1OLY",
+ "shipping_details": null
},
"climate.order": {
"amount_fees": 300,
@@ -3496,24 +3497,7 @@
"interval_start": 1522540800
},
"report_type": "balance.summary.1",
- "result": {
- "created": 1721948551,
- "expires_at": 1753484551,
- "filename": "file_1Pgag7B7WZ01zgkWZFBKk3TC",
- "id": "file_1Pgag7B7WZ01zgkWZFBKk3TC",
- "links": {
- "data": [],
- "has_more": false,
- "object": "list",
- "url": "/v1/file_links?file=file_1Pgag7B7WZ01zgkWZFBKk3TC"
- },
- "object": "file",
- "purpose": "finance_report_run",
- "size": 16890,
- "title": null,
- "type": "csv",
- "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/v1/files/file_1Pgag7B7WZ01zgkWZFBKk3TC/contents"
- },
+ "result": null,
"status": "succeeded",
"succeeded_at": 1234567890
},
@@ -3551,24 +3535,7 @@
"scheduled_query_run": {
"created": 1234567890,
"data_load_time": 1234567890,
- "file": {
- "created": 1721948551,
- "expires_at": null,
- "filename": "path",
- "id": "file_1Pgag7B7WZ01zgkWJbdoNCXR",
- "links": {
- "data": [],
- "has_more": false,
- "object": "list",
- "url": "/v1/file_links?file=file_1Pgag7B7WZ01zgkWJbdoNCXR"
- },
- "object": "file",
- "purpose": "sigma_scheduled_query",
- "size": 500,
- "title": null,
- "type": "csv",
- "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/v1/files/file_1Pgag7B7WZ01zgkWJbdoNCXR/contents"
- },
+ "file": null,
"id": "sqr_1Pgc7AB7WZ01zgkWvpIic1Di",
"livemode": false,
"object": "scheduled_query_run",
diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json
index 2be88698..d8f69a09 100644
--- a/embedded/openapi/spec3.beta.sdk.json
+++ b/embedded/openapi/spec3.beta.sdk.json
@@ -841,6 +841,15 @@
],
"type": "string"
},
+ "mb_way_payments": {
+ "description": "The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges.",
+ "enum": [
+ "active",
+ "inactive",
+ "pending"
+ ],
+ "type": "string"
+ },
"mobilepay_payments": {
"description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.",
"enum": [
@@ -2612,6 +2621,7 @@
"taxes_calculation_failed",
"terminal_location_country_unsupported",
"terminal_reader_busy",
+ "terminal_reader_collected_data_invalid",
"terminal_reader_hardware_fault",
"terminal_reader_invalid_location_for_payment",
"terminal_reader_offline",
@@ -4909,6 +4919,35 @@
"in_package": "Billing"
}
},
+ "billing_clocks_resource_status_details_advancing_status_details": {
+ "description": "",
+ "properties": {
+ "target_frozen_time": {
+ "description": "The `frozen_time` that the Test Clock is advancing towards.",
+ "format": "unix-time",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "target_frozen_time"
+ ],
+ "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "billing_clocks_resource_status_details_status_details": {
+ "description": "",
+ "properties": {
+ "advancing": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details"
+ }
+ },
+ "title": "BillingClocksResourceStatusDetailsStatusDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "advancing"
+ ]
+ },
"billing_details": {
"description": "",
"properties": {
@@ -7134,7 +7173,7 @@
"$ref": "#/components/schemas/transfer"
}
],
- "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
+ "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -7145,13 +7184,13 @@
}
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -7713,6 +7752,15 @@
"nullable": true,
"type": "string"
},
+ "collected_information": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_collected_information"
+ }
+ ],
+ "description": "Information about the customer collected within the Checkout Session.",
+ "nullable": true
+ },
"consent": {
"anyOf": [
{
@@ -8050,6 +8098,15 @@
],
"type": "string"
},
+ "permissions": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_permissions"
+ }
+ ],
+ "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.",
+ "nullable": true
+ },
"phone_number_collection": {
"$ref": "#/components/schemas/payment_pages_checkout_session_phone_number_collection"
},
@@ -8269,6 +8326,7 @@
"x-expandableFields": [
"after_expiration",
"automatic_tax",
+ "collected_information",
"consent",
"consent_collection",
"currency_conversion",
@@ -8283,6 +8341,7 @@
"payment_link",
"payment_method_configuration_details",
"payment_method_options",
+ "permissions",
"phone_number_collection",
"saved_payment_method_options",
"setup_intent",
@@ -10314,6 +10373,9 @@
"link": {
"$ref": "#/components/schemas/payment_method_link"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_mb_way"
+ },
"mobilepay": {
"$ref": "#/components/schemas/payment_method_mobilepay"
},
@@ -10385,6 +10447,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -10450,6 +10513,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -13808,7 +13872,7 @@
}
},
"customer_session": {
- "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.",
+ "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).",
"properties": {
"client_secret": {
"description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
@@ -15675,12 +15739,9 @@
"status": {
"description": "Visa Compelling Evidence 3.0 eligibility status.",
"enum": [
- "accepted",
"not_qualified",
- "partner_rejected",
"qualified",
- "requires_action",
- "submitted"
+ "requires_action"
],
"type": "string"
}
@@ -17614,6 +17675,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -24347,7 +24409,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -24381,6 +24443,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -25495,6 +25558,12 @@
],
"type": "string"
},
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"underwriting_exception": {
"anyOf": [
{
@@ -25517,6 +25586,7 @@
"livemode",
"metadata",
"object",
+ "regulatory_reporting_file",
"underwriting_exception"
],
"title": "IssuingComplianceCreditUnderwritingRecord",
@@ -28109,6 +28179,7 @@
},
"required": [
"address",
+ "address_validation",
"carrier",
"customs",
"eta",
@@ -32296,7 +32367,6 @@
"amount_tax",
"amount_total",
"currency",
- "description",
"id",
"object",
"price",
@@ -35208,7 +35278,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -35242,6 +35312,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -36372,6 +36443,27 @@
"in_package": ""
}
},
+ "payment_flows_private_payment_methods_card_present_common_wallet": {
+ "description": "",
+ "properties": {
+ "type": {
+ "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.",
+ "enum": [
+ "apple_pay",
+ "google_pay",
+ "samsung_pay",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet",
+ "type": "object",
+ "x-expandableFields": []
+ },
"payment_flows_private_payment_methods_klarna_dob": {
"description": "",
"properties": {
@@ -36585,7 +36677,7 @@
"$ref": "#/components/schemas/deleted_customer"
}
],
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -36843,13 +36935,13 @@
}
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -38210,6 +38302,9 @@
"link": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_link"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_options_mb_way"
+ },
"mobilepay": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay"
},
@@ -38291,6 +38386,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -40571,6 +40667,9 @@
"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"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_mb_way"
+ },
"metadata": {
"additionalProperties": {
"maxLength": 500,
@@ -40661,6 +40760,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -40731,6 +40831,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -41347,6 +41448,9 @@
],
"nullable": true,
"type": "string"
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -41368,7 +41472,8 @@
"type": "object",
"x-expandableFields": [
"networks",
- "offline"
+ "offline",
+ "wallet"
]
},
"payment_method_card_present_networks": {
@@ -42034,6 +42139,9 @@
"link": {
"$ref": "#/components/schemas/payment_method_details_link"
},
+ "mb_way": {
+ "$ref": "#/components/schemas/payment_method_details_mb_way"
+ },
"mobilepay": {
"$ref": "#/components/schemas/payment_method_details_mobilepay"
},
@@ -42134,6 +42242,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -42947,7 +43056,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -42994,6 +43103,9 @@
],
"description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
"nullable": true
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -43022,7 +43134,8 @@
"type": "object",
"x-expandableFields": [
"offline",
- "receipt"
+ "receipt",
+ "wallet"
]
},
"payment_method_details_card_present_offline": {
@@ -43718,7 +43831,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -43942,6 +44055,17 @@
"type": "object",
"x-expandableFields": []
},
+ "payment_method_details_mb_way": {
+ "description": "",
+ "properties": {},
+ "title": "payment_method_details_mb_way",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "MbWay",
+ "in_package": ""
+ }
+ },
"payment_method_details_mobilepay": {
"description": "",
"properties": {
@@ -45092,6 +45216,17 @@
"type": "object",
"x-expandableFields": []
},
+ "payment_method_mb_way": {
+ "description": "",
+ "properties": {},
+ "title": "payment_method_mb_way",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "MbWay",
+ "in_package": ""
+ }
+ },
"payment_method_mobilepay": {
"description": "",
"properties": {},
@@ -45697,6 +45832,21 @@
"type": "object",
"x-expandableFields": []
},
+ "payment_method_options_mb_way": {
+ "description": "",
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
+ "enum": [
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_mb_way",
+ "type": "object",
+ "x-expandableFields": []
+ },
"payment_method_options_multibanco": {
"description": "",
"properties": {
@@ -46510,6 +46660,42 @@
"liability"
]
},
+ "payment_pages_checkout_session_collected_information": {
+ "description": "",
+ "properties": {
+ "email": {
+ "description": "Customer’s email for this Checkout Session",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "phone": {
+ "description": "Customer’s phone number for this Checkout Session",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "shipping_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/shipping"
+ }
+ ],
+ "description": "Shipping information for this Checkout Session.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "email",
+ "phone",
+ "shipping_details"
+ ],
+ "title": "PaymentPagesCheckoutSessionCollectedInformation",
+ "type": "object",
+ "x-expandableFields": [
+ "shipping_details"
+ ]
+ },
"payment_pages_checkout_session_consent": {
"description": "",
"properties": {
@@ -47101,6 +47287,32 @@
"type": "object",
"x-expandableFields": []
},
+ "payment_pages_checkout_session_permissions": {
+ "description": "",
+ "properties": {
+ "update": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_update_permission"
+ }
+ ],
+ "description": "Permissions for updating the Checkout Session.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "update"
+ ],
+ "title": "PaymentPagesCheckoutSessionPermissions",
+ "type": "object",
+ "x-expandableFields": [
+ "update"
+ ],
+ "x-stripeResource": {
+ "class_name": "Permissions",
+ "in_package": ""
+ }
+ },
"payment_pages_checkout_session_phone_number_collection": {
"description": "",
"properties": {
@@ -47518,7 +47730,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -47552,6 +47764,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -47687,6 +47900,30 @@
"taxes"
]
},
+ "payment_pages_checkout_session_update_permission": {
+ "description": "",
+ "properties": {
+ "shipping_details": {
+ "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.",
+ "enum": [
+ "client_only",
+ "server_only"
+ ],
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "shipping_details"
+ ],
+ "title": "PaymentPagesCheckoutSessionUpdatePermission",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "UpdatePermission",
+ "in_package": ""
+ }
+ },
"payment_plan_amount": {
"description": "",
"properties": {
@@ -57847,7 +58084,7 @@
"$ref": "#/components/schemas/payment_method"
}
],
- "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
+ "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -64863,7 +65100,7 @@
"nullable": true
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -64897,6 +65134,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -65585,7 +65823,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -65619,6 +65857,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -67262,6 +67501,75 @@
"type": "terminal.reader.action_updated"
}
},
+ "terminal.reader_collected_data": {
+ "description": "Returns data collected by Terminal readers. This data is only stored for 24 hours.",
+ "properties": {
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "magstripe": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/terminal_reader_collected_data_resource_magstripe_data"
+ }
+ ],
+ "description": "The magstripe data collected by the reader.",
+ "nullable": true
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "terminal.reader_collected_data"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of data collected by the reader.",
+ "enum": [
+ "magstripe"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "created",
+ "id",
+ "livemode",
+ "magstripe",
+ "object",
+ "type"
+ ],
+ "title": "TerminalReaderCollectedData",
+ "type": "object",
+ "x-expandableFields": [
+ "magstripe"
+ ],
+ "x-resourceId": "terminal.reader_collected_data",
+ "x-stripeOperations": [
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/terminal/reader_collected_data/{reader_collected_data}"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "ReaderCollectedData",
+ "in_package": "Terminal"
+ }
+ },
"terminal_configuration_configuration_resource_currency_specific_config": {
"description": "",
"properties": {
@@ -67420,6 +67728,23 @@
"usd"
]
},
+ "terminal_reader_collected_data_resource_magstripe_data": {
+ "description": "Represents magstripe data collected by the reader.",
+ "properties": {
+ "data": {
+ "description": "The raw magstripe data collected by the reader.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "title": "TerminalReaderCollectedDataResourceMagstripeData",
+ "type": "object",
+ "x-expandableFields": []
+ },
"terminal_reader_reader_resource_cart": {
"description": "Represents a cart to be displayed on the reader",
"properties": {
@@ -68311,6 +68636,9 @@
"ready"
],
"type": "string"
+ },
+ "status_details": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details"
}
},
"required": [
@@ -68325,7 +68653,9 @@
],
"title": "TestClock",
"type": "object",
- "x-expandableFields": [],
+ "x-expandableFields": [
+ "status_details"
+ ],
"x-resourceId": "test_helpers.test_clock",
"x-stripeOperations": [
{
@@ -70413,7 +70743,7 @@
}
},
"treasury.inbound_transfer": {
- "description": "Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.",
+ "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -70697,7 +71027,7 @@
}
},
"treasury.outbound_payment": {
- "description": "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -71061,7 +71391,7 @@
}
},
"treasury.outbound_transfer": {
- "description": "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -74017,7 +74347,7 @@
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
"termsOfService": "https://stripe.com/us/terms/",
"title": "Stripe API",
- "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1; custom_checkout_beta=v1",
+ "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; checkout_server_update_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1; custom_checkout_beta=v1",
"x-stripeSpecFilename": "spec3.beta.sdk"
},
"openapi": "3.0.0",
@@ -74130,7 +74460,10 @@
"include",
"omit"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -74149,11 +74482,17 @@
},
"refresh_url": {
"description": "The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_url": {
"description": "The URL that the user will be redirected to upon leaving or completing the linked flow.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.",
@@ -74248,7 +74587,10 @@
"name": "sent",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -74478,7 +74820,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sent_at": {
"description": "Date when you sent the notice.",
@@ -74559,18 +74904,27 @@
"properties": {
"external_account_collection": {
"description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_onboarding": {
"description": "Configuration for the account onboarding embedded component.",
@@ -74584,18 +74938,27 @@
"properties": {
"external_account_collection": {
"description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"app_install": {
"description": "Configuration for the app install component.",
@@ -74623,18 +74986,27 @@
"type": "string"
}
],
- "description": "List of apps allowed to be enabled for this account session."
+ "description": "List of apps allowed to be enabled for this account session.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "app_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "app_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"app_viewport": {
"description": "Configuration for the app viewport component.",
@@ -74662,18 +75034,27 @@
"type": "string"
}
],
- "description": "List of apps allowed to be enabled for this account session."
+ "description": "List of apps allowed to be enabled for this account session.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "app_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "app_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"balances": {
"description": "Configuration for the balances embedded component.",
@@ -74687,32 +75068,103 @@
"properties": {
"edit_payout_schedule": {
"description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"external_account_collection": {
"description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"instant_payouts": {
"description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"standard_payouts": {
"description": "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payouts_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "payouts_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "capital_financing": {
+ "description": "Configuration for the capital financing embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {},
+ "title": "base_features_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "base_config_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "capital_financing_application": {
+ "description": "Configuration for the capital financing application embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {},
+ "title": "base_features_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "base_config_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capital_financing_promotion": {
+ "description": "Configuration for the capital financing promotion embedded component.",
"properties": {
"enabled": {
"description": "Whether the embedded component is enabled.",
@@ -74722,14 +75174,20 @@
"description": "The list of features enabled in the embedded component.",
"properties": {},
"title": "base_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capital_overview": {
"description": "Configuration for the capital overview embedded component.",
@@ -74742,14 +75200,20 @@
"description": "The list of features enabled in the embedded component.",
"properties": {},
"title": "base_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"documents": {
"description": "Configuration for the documents embedded component.",
@@ -74762,14 +75226,20 @@
"description": "The list of features enabled in the embedded component.",
"properties": {},
"title": "base_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_account": {
"description": "Configuration for the financial account component.",
@@ -74782,22 +75252,34 @@
"properties": {
"external_account_collection": {
"description": "Whether to allow external accounts to be linked for money transfer.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"money_movement": {
"description": "Whether to allow money movement features.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "financial_account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "financial_account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_account_transactions": {
"description": "Configuration for the financial account transactions component.",
@@ -74810,18 +75292,27 @@
"properties": {
"card_spend_dispute_management": {
"description": "Whether to allow card spend dispute features.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "financial_account_transactions_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "financial_account_transactions_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuing_card": {
"description": "Configuration for the issuing card component.",
@@ -74833,15 +75324,21 @@
"features": {
"description": "The list of features enabled in the embedded component.",
"properties": {},
- "title": "base_features_param",
- "type": "object"
+ "title": "issuing_card_features_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
- "title": "base_config_param",
- "type": "object"
+ "title": "issuing_card_config_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuing_cards_list": {
"description": "Configuration for the issuing cards list component.",
@@ -74855,22 +75352,34 @@
"properties": {
"card_management": {
"description": "Whether to allow card management features.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cardholder_management": {
"description": "Whether to allow cardholder management features.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "issuing_cards_list_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "issuing_cards_list_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"notification_banner": {
"description": "Configuration for the notification banner embedded component.",
@@ -74884,18 +75393,27 @@
"properties": {
"external_account_collection": {
"description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "account_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "account_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_details": {
"description": "Configuration for the payment details embedded component.",
@@ -74909,30 +75427,48 @@
"properties": {
"capture_payments": {
"description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination_on_behalf_of_charge_management": {
"description": "Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dispute_management": {
"description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_management": {
"description": "Whether to allow sending refunds. This is `true` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payments_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "payments_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_settings": {
"description": "Configuration for the payment method settings embedded component.",
@@ -74945,14 +75481,20 @@
"description": "The list of features enabled in the embedded component.",
"properties": {},
"title": "base_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments": {
"description": "Configuration for the payments embedded component.",
@@ -74966,30 +75508,48 @@
"properties": {
"capture_payments": {
"description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination_on_behalf_of_charge_management": {
"description": "Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dispute_management": {
"description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_management": {
"description": "Whether to allow sending refunds. This is `true` by default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payments_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "payments_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payouts": {
"description": "Configuration for the payouts embedded component.",
@@ -75003,30 +75563,48 @@
"properties": {
"edit_payout_schedule": {
"description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"external_account_collection": {
"description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"instant_payouts": {
"description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"standard_payouts": {
"description": "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payouts_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "payouts_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payouts_list": {
"description": "Configuration for the payouts list embedded component.",
@@ -75039,14 +75617,20 @@
"description": "The list of features enabled in the embedded component.",
"properties": {},
"title": "base_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_registrations": {
"description": "Configuration for the tax registrations embedded component.",
@@ -75059,14 +75643,20 @@
"description": "The list of features enabled in the embedded component.",
"properties": {},
"title": "base_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_settings": {
"description": "Configuration for the tax settings embedded component.",
@@ -75079,14 +75669,20 @@
"description": "The list of features enabled in the embedded component.",
"properties": {},
"title": "base_features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "base_config_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "account_session_create_components_param",
@@ -75152,19 +75748,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -75381,16 +75989,25 @@
"fiscal_year_end"
],
"title": "annual_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"estimated_worker_count": {
"description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mcc": {
"description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"monthly_estimated_revenue": {
"description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.",
@@ -75409,17 +76026,26 @@
"currency"
],
"title": "monthly_estimated_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The customer-facing business name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"description": "Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_address": {
"description": "A publicly available mailing address for sending support issues to.",
@@ -75427,45 +76053,72 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_email": {
"description": "A publicly available email address for sending support issues to.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_phone": {
"description": "A publicly available phone number to call with support issues.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_url": {
"anyOf": [
@@ -75479,11 +76132,17 @@
"type": "string"
}
],
- "description": "A publicly available website for handling support issues."
+ "description": "A publicly available website for handling support issues.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"description": "The business's publicly available website.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "business_profile_specs",
@@ -75498,7 +76157,10 @@
"non_profit"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capabilities": {
"description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.",
@@ -75508,554 +76170,874 @@
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affirm_payments": {
"description": "The affirm_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay_payments": {
"description": "The afterpay_clearpay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay_payments": {
"description": "The amazon_pay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"au_becs_debit_payments": {
"description": "The au_becs_debit_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit_payments": {
"description": "The bacs_debit_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact_payments": {
"description": "The bancontact_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank_transfer_payments": {
"description": "The bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik_payments": {
"description": "The blik_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"boleto_payments": {
"description": "The boleto_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_issuing": {
"description": "The card_issuing capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_payments": {
"description": "The card_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cartes_bancaires_payments": {
"description": "The cartes_bancaires_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cashapp_payments": {
"description": "The cashapp_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eps_payments": {
"description": "The eps_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fpx_payments": {
"description": "The fpx_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gb_bank_transfer_payments": {
"description": "The gb_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"giropay_payments": {
"description": "The giropay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"grabpay_payments": {
"description": "The grabpay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal_payments": {
"description": "The ideal_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"india_international_payments": {
"description": "The india_international_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"jcb_payments": {
"description": "The jcb_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"jp_bank_transfer_payments": {
"description": "The jp_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna_payments": {
"description": "The klarna_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini_payments": {
"description": "The konbini_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"legacy_payments": {
"description": "The legacy_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link_payments": {
"description": "The link_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "mb_way_payments": {
+ "description": "The mb_way_payments capability.",
+ "properties": {
+ "requested": {
+ "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "capability_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay_payments": {
"description": "The mobilepay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"multibanco_payments": {
"description": "The multibanco_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mx_bank_transfer_payments": {
"description": "The mx_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo_payments": {
"description": "The oxxo_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24_payments": {
"description": "The p24_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paynow_payments": {
"description": "The paynow_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal_payments": {
"description": "The paypal_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto_payments": {
"description": "The payto_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promptpay_payments": {
"description": "The promptpay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rechnung_payments": {
"description": "The rechnung_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"revolut_pay_payments": {
"description": "The revolut_pay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_bank_transfer_payments": {
"description": "The sepa_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit_payments": {
"description": "The sepa_debit_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort_payments": {
"description": "The sofort_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"swish_payments": {
"description": "The swish_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_reporting_us_1099_k": {
"description": "The tax_reporting_us_1099_k capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_reporting_us_1099_misc": {
"description": "The tax_reporting_us_1099_misc capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfers": {
"description": "The transfers capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"treasury": {
"description": "The treasury capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"twint_payments": {
"description": "The twint_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account_ach_payments": {
"description": "The us_bank_account_ach_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_transfer_payments": {
"description": "The us_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"zip_payments": {
"description": "The zip_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capabilities_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
@@ -76066,36 +77048,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the company's primary address (Japan only).",
@@ -76103,41 +77106,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kanji": {
"description": "The Kanji variation of the company's primary address (Japan only).",
@@ -76145,78 +77172,126 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"directors_provided": {
"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](/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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executives_provided": {
"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](/api/persons) for accounts with a `relationship.executive` requirement.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"export_license_id": {
"description": "The export license ID number of the company, also referred as Import Export Code (India only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"export_purpose_code": {
"description": "The purpose code to use for export transactions (India only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The company's legal name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name_kana": {
"description": "The Kana variation of the company's legal name (Japan only).",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name_kanji": {
"description": "The Kanji variation of the company's legal name (Japan only).",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owners_provided": {
"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](/api/persons) for accounts with a `relationship.owner` requirement.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ownership_declaration": {
"description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.",
@@ -76224,30 +77299,48 @@
"date": {
"description": "The Unix timestamp marking when the beneficial owner attestation was made.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the beneficial owner attestation was made.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the beneficial owner attestation was made.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "company_ownership_declaration",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The company's phone number (used for verification).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"registration_number": {
"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).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"structure": {
"description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.",
@@ -76278,22 +77371,34 @@
"unincorporated_partnership"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_id": {
"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.)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_id_registrar": {
"description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vat_id": {
"description": "The VAT number of the company.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "Information on the verification state of the company.",
@@ -76304,24 +77409,39 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "company_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"controller": {
"description": "A hash of configuration describing the account controller's attributes.",
@@ -76335,18 +77455,27 @@
},
"onboarding_owner": {
"description": "Whether the controller owns onboarding for this account.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pricing_controls": {
"description": "Whether the controller has pricing controls for this account.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"loss_liable"
],
"title": "controller_application_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dashboard": {
"description": "Properties of the account's dashboard.",
@@ -76358,11 +77487,17 @@
"full",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "controller_dashboard_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fees": {
"description": "A hash of configuration for who pays Stripe fees for product usage on this account.",
@@ -76373,11 +77508,17 @@
"account",
"application"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "controller_fees_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"losses": {
"description": "A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.",
@@ -76388,11 +77529,17 @@
"application",
"stripe"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "controller_losses_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requirement_collection": {
"description": "A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.",
@@ -76400,7 +77547,10 @@
"application",
"stripe"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"stripe_dashboard": {
"description": "A hash of configuration for Stripe-hosted dashboards.",
@@ -76412,20 +77562,32 @@
"full",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "controller_dashboard_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "controller_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_currency": {
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).",
@@ -76435,7 +77597,7 @@
"description": "Documents that may be submitted to satisfy various informational requests.",
"properties": {
"bank_account_ownership_verification": {
- "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.",
+ "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 check.",
"properties": {
"files": {
"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`.",
@@ -76443,11 +77605,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_license": {
"description": "One or more documents that demonstrate proof of a company's license to operate.",
@@ -76458,11 +77626,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_memorandum_of_association": {
"description": "One or more documents showing the company's Memorandum of Association.",
@@ -76473,11 +77647,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_ministerial_decree": {
"description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.",
@@ -76488,11 +77668,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_registration_verification": {
"description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.",
@@ -76503,11 +77689,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_tax_id_verification": {
"description": "One or more documents that demonstrate proof of a company's tax ID.",
@@ -76518,11 +77710,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proof_of_registration": {
"description": "One or more documents showing the company’s proof of registration with the national business registry.",
@@ -76533,11 +77731,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_specs",
@@ -76545,7 +77749,10 @@
},
"email": {
"description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -76570,36 +77777,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the individual's primary address (Japan only).",
@@ -76607,41 +77835,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kanji": {
"description": "The Kanji variation of the individual's primary address (Japan only).",
@@ -76649,41 +77901,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dob": {
"anyOf": [
@@ -76717,26 +77993,41 @@
"type": "string"
}
],
- "description": "The individual's date of birth."
+ "description": "The individual's date of birth.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "The individual's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name": {
"description": "The individual's first name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kana": {
"description": "The Kana variation of the individual's first name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kanji": {
"description": "The Kanji variation of the individual's first name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"full_name_aliases": {
"anyOf": [
@@ -76754,41 +78045,65 @@
"type": "string"
}
],
- "description": "A list of alternate names or aliases that the individual is known by."
+ "description": "A list of alternate names or aliases that the individual is known by.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gender": {
"description": "The individual's gender (International regulations require either \"male\" or \"female\").",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id_number": {
"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](/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id_number_secondary": {
"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](/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name": {
"description": "The individual's last name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kana": {
"description": "The Kana variation of the individual's last name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kanji": {
"description": "The Kanji variation of the individual's last name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"maiden_name": {
"description": "The individual's maiden name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -76805,11 +78120,17 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The individual's phone number.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -76817,7 +78138,10 @@
"existing",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"registered_address": {
"description": "The individual's registered address.",
@@ -76825,51 +78149,81 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"relationship": {
"description": "Describes the person’s relationship to the account.",
"properties": {
"director": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executive": {
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_ownership": {
"anyOf": [
@@ -76883,21 +78237,33 @@
"type": "string"
}
],
- "description": "The percent owned by the person of the account's legal entity."
+ "description": "The percent owned by the person of the account's legal entity.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The person's title (e.g., CEO, Support Engineer).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ssn_last_4": {
"description": "The last four digits of the individual's Social Security Number (U.S. only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "The individual's verification document information.",
@@ -76908,16 +78274,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -76925,24 +78300,39 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -76969,22 +78359,34 @@
"properties": {
"pause_requested": {
"description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payouts": {
"description": "Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).",
"properties": {
"pause_requested": {
"description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "risk_controls_hash_param",
@@ -76998,11 +78400,17 @@
"properties": {
"display_name": {
"description": "The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bacs_debit_payments_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"branding": {
"description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
@@ -77010,26 +78418,41 @@
"icon": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"logo": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"primary_color": {
"description": "A CSS hex color value representing the primary branding color for this account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"secondary_color": {
"description": "A CSS hex color value representing the secondary branding color for this account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "branding_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capital": {
"description": "Settings specific to the account's use of the Capital product.",
@@ -77040,7 +78463,10 @@
"type": "string"
},
"description": "Per-currency mapping of user-selected destination accounts used to pay out loans.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payout_destination_selector": {
"additionalProperties": {
@@ -77051,11 +78477,17 @@
"type": "array"
},
"description": "Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capital_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_issuing": {
"description": "Settings specific to the account's use of the Card Issuing product.",
@@ -77066,11 +78498,17 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted the service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted the service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -77085,15 +78523,24 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ "description": "The user agent of the browser from which the account representative accepted the service agreement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_issuing_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_payments": {
"description": "Settings specific to card charging on the account.",
@@ -77103,20 +78550,32 @@
"properties": {
"avs_failure": {
"description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc_failure": {
"description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "decline_charge_on_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_prefix": {
"description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_prefix_kana": {
"anyOf": [
@@ -77131,7 +78590,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_prefix_kanji": {
"anyOf": [
@@ -77146,11 +78608,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments": {
"description": "Settings that apply across payment methods for charging on the account.",
@@ -77158,28 +78626,43 @@
"statement_descriptor": {
"description": "The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_kana": {
"description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_kanji": {
"description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payouts": {
"description": "Settings specific to the account's payouts.",
"properties": {
"debit_negative_balances": {
"description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"schedule": {
"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](/connect/bank-transfers#payout-information) documentation.",
@@ -77197,7 +78680,10 @@
"type": "integer"
}
],
- "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 remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)."
+ "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 remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.",
@@ -77209,11 +78695,17 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"monthly_anchor": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"weekly_anchor": {
"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`.)",
@@ -77227,31 +78719,49 @@
"wednesday"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "transfer_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
"description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payout_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_forms": {
"description": "Settings specific to the account's tax forms.",
"properties": {
"consented_to_paperless_delivery": {
"description": "Whether the account opted out of receiving their tax forms by postal delivery.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_form_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"treasury": {
"description": "Settings specific to the account's Treasury FinancialAccounts.",
@@ -77262,11 +78772,17 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted the service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted the service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -77281,15 +78797,24 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ "description": "The user agent of the browser from which the account representative accepted the service agreement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "treasury_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_specs",
@@ -77301,25 +78826,40 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted their service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted their service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_agreement": {
"description": "The user's service agreement type.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the account representative accepted their service agreement.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tos_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of Stripe account to create. May be one of `custom`, `express` or `standard`.",
@@ -77328,7 +78868,10 @@
"express",
"standard"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -77573,16 +79116,25 @@
"fiscal_year_end"
],
"title": "annual_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"estimated_worker_count": {
"description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mcc": {
"description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"monthly_estimated_revenue": {
"description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.",
@@ -77601,17 +79153,26 @@
"currency"
],
"title": "monthly_estimated_revenue_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The customer-facing business name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"description": "Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_address": {
"description": "A publicly available mailing address for sending support issues to.",
@@ -77619,45 +79180,72 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_email": {
"description": "A publicly available email address for sending support issues to.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_phone": {
"description": "A publicly available phone number to call with support issues.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"support_url": {
"anyOf": [
@@ -77671,11 +79259,17 @@
"type": "string"
}
],
- "description": "A publicly available website for handling support issues."
+ "description": "A publicly available website for handling support issues.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"description": "The business's publicly available website.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "business_profile_specs",
@@ -77690,7 +79284,10 @@
"non_profit"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capabilities": {
"description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.",
@@ -77700,554 +79297,874 @@
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affirm_payments": {
"description": "The affirm_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay_payments": {
"description": "The afterpay_clearpay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay_payments": {
"description": "The amazon_pay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"au_becs_debit_payments": {
"description": "The au_becs_debit_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit_payments": {
"description": "The bacs_debit_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact_payments": {
"description": "The bancontact_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank_transfer_payments": {
"description": "The bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik_payments": {
"description": "The blik_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"boleto_payments": {
"description": "The boleto_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_issuing": {
"description": "The card_issuing capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_payments": {
"description": "The card_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cartes_bancaires_payments": {
"description": "The cartes_bancaires_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cashapp_payments": {
"description": "The cashapp_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eps_payments": {
"description": "The eps_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fpx_payments": {
"description": "The fpx_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gb_bank_transfer_payments": {
"description": "The gb_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"giropay_payments": {
"description": "The giropay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"grabpay_payments": {
"description": "The grabpay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal_payments": {
"description": "The ideal_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"india_international_payments": {
"description": "The india_international_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"jcb_payments": {
"description": "The jcb_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"jp_bank_transfer_payments": {
"description": "The jp_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna_payments": {
"description": "The klarna_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini_payments": {
"description": "The konbini_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"legacy_payments": {
"description": "The legacy_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link_payments": {
"description": "The link_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "mb_way_payments": {
+ "description": "The mb_way_payments capability.",
+ "properties": {
+ "requested": {
+ "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "capability_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay_payments": {
"description": "The mobilepay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"multibanco_payments": {
"description": "The multibanco_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mx_bank_transfer_payments": {
"description": "The mx_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo_payments": {
"description": "The oxxo_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24_payments": {
"description": "The p24_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paynow_payments": {
"description": "The paynow_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal_payments": {
"description": "The paypal_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto_payments": {
"description": "The payto_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promptpay_payments": {
"description": "The promptpay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rechnung_payments": {
"description": "The rechnung_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"revolut_pay_payments": {
"description": "The revolut_pay_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_bank_transfer_payments": {
"description": "The sepa_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit_payments": {
"description": "The sepa_debit_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort_payments": {
"description": "The sofort_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"swish_payments": {
"description": "The swish_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_reporting_us_1099_k": {
"description": "The tax_reporting_us_1099_k capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_reporting_us_1099_misc": {
"description": "The tax_reporting_us_1099_misc capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfers": {
"description": "The transfers capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"treasury": {
"description": "The treasury capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"twint_payments": {
"description": "The twint_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account_ach_payments": {
"description": "The us_bank_account_ach_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_transfer_payments": {
"description": "The us_bank_transfer_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"zip_payments": {
"description": "The zip_payments capability.",
"properties": {
"requested": {
"description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capability_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capabilities_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
@@ -78258,36 +80175,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the company's primary address (Japan only).",
@@ -78295,41 +80233,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kanji": {
"description": "The Kanji variation of the company's primary address (Japan only).",
@@ -78337,78 +80299,126 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"directors_provided": {
"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](/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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executives_provided": {
"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](/api/persons) for accounts with a `relationship.executive` requirement.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"export_license_id": {
"description": "The export license ID number of the company, also referred as Import Export Code (India only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"export_purpose_code": {
"description": "The purpose code to use for export transactions (India only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The company's legal name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name_kana": {
"description": "The Kana variation of the company's legal name (Japan only).",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name_kanji": {
"description": "The Kanji variation of the company's legal name (Japan only).",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owners_provided": {
"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](/api/persons) for accounts with a `relationship.owner` requirement.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ownership_declaration": {
"description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.",
@@ -78416,30 +80426,48 @@
"date": {
"description": "The Unix timestamp marking when the beneficial owner attestation was made.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the beneficial owner attestation was made.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the beneficial owner attestation was made.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "company_ownership_declaration",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The company's phone number (used for verification).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"registration_number": {
"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).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"structure": {
"description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.",
@@ -78470,22 +80498,34 @@
"unincorporated_partnership"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_id": {
"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.)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_id_registrar": {
"description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vat_id": {
"description": "The VAT number of the company.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "Information on the verification state of the company.",
@@ -78496,24 +80536,39 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "company_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_currency": {
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).",
@@ -78523,7 +80578,7 @@
"description": "Documents that may be submitted to satisfy various informational requests.",
"properties": {
"bank_account_ownership_verification": {
- "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.",
+ "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 check.",
"properties": {
"files": {
"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`.",
@@ -78531,11 +80586,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_license": {
"description": "One or more documents that demonstrate proof of a company's license to operate.",
@@ -78546,11 +80607,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_memorandum_of_association": {
"description": "One or more documents showing the company's Memorandum of Association.",
@@ -78561,11 +80628,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_ministerial_decree": {
"description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.",
@@ -78576,11 +80649,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_registration_verification": {
"description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.",
@@ -78591,11 +80670,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company_tax_id_verification": {
"description": "One or more documents that demonstrate proof of a company's tax ID.",
@@ -78606,11 +80691,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proof_of_registration": {
"description": "One or more documents showing the company’s proof of registration with the national business registry.",
@@ -78621,11 +80712,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_specs",
@@ -78633,7 +80730,10 @@
},
"email": {
"description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -78658,36 +80758,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the individual's primary address (Japan only).",
@@ -78695,41 +80816,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kanji": {
"description": "The Kanji variation of the individual's primary address (Japan only).",
@@ -78737,41 +80882,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dob": {
"anyOf": [
@@ -78805,26 +80974,41 @@
"type": "string"
}
],
- "description": "The individual's date of birth."
+ "description": "The individual's date of birth.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "The individual's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name": {
"description": "The individual's first name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kana": {
"description": "The Kana variation of the individual's first name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kanji": {
"description": "The Kanji variation of the individual's first name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"full_name_aliases": {
"anyOf": [
@@ -78842,41 +81026,65 @@
"type": "string"
}
],
- "description": "A list of alternate names or aliases that the individual is known by."
+ "description": "A list of alternate names or aliases that the individual is known by.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gender": {
"description": "The individual's gender (International regulations require either \"male\" or \"female\").",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id_number": {
"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](/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id_number_secondary": {
"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](/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name": {
"description": "The individual's last name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kana": {
"description": "The Kana variation of the individual's last name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kanji": {
"description": "The Kanji variation of the individual's last name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"maiden_name": {
"description": "The individual's maiden name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -78893,11 +81101,17 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The individual's phone number.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -78905,7 +81119,10 @@
"existing",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"registered_address": {
"description": "The individual's registered address.",
@@ -78913,51 +81130,81 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"relationship": {
"description": "Describes the person’s relationship to the account.",
"properties": {
"director": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executive": {
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_ownership": {
"anyOf": [
@@ -78971,21 +81218,33 @@
"type": "string"
}
],
- "description": "The percent owned by the person of the account's legal entity."
+ "description": "The percent owned by the person of the account's legal entity.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The person's title (e.g., CEO, Support Engineer).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ssn_last_4": {
"description": "The last four digits of the individual's Social Security Number (U.S. only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "The individual's verification document information.",
@@ -78996,16 +81255,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -79013,24 +81281,39 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -79057,22 +81340,34 @@
"properties": {
"pause_requested": {
"description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payouts": {
"description": "Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).",
"properties": {
"pause_requested": {
"description": "To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.\nThere can be a delay before the risk control is paused or unpaused.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "risk_control_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "risk_controls_hash_param",
@@ -79086,11 +81381,17 @@
"properties": {
"display_name": {
"description": "The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bacs_debit_payments_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"branding": {
"description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
@@ -79098,26 +81399,41 @@
"icon": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"logo": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"primary_color": {
"description": "A CSS hex color value representing the primary branding color for this account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"secondary_color": {
"description": "A CSS hex color value representing the secondary branding color for this account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "branding_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capital": {
"description": "Settings specific to the account's use of the Capital product.",
@@ -79128,7 +81444,10 @@
"type": "string"
},
"description": "Per-currency mapping of user-selected destination accounts used to pay out loans.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payout_destination_selector": {
"additionalProperties": {
@@ -79139,11 +81458,17 @@
"type": "array"
},
"description": "Per-currency mapping of all destination accounts eligible to receive Capital financing payouts.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "capital_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_issuing": {
"description": "Settings specific to the account's use of the Card Issuing product.",
@@ -79154,11 +81479,17 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted the service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted the service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -79173,15 +81504,24 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ "description": "The user agent of the browser from which the account representative accepted the service agreement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_issuing_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_payments": {
"description": "Settings specific to card charging on the account.",
@@ -79191,20 +81531,32 @@
"properties": {
"avs_failure": {
"description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc_failure": {
"description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "decline_charge_on_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_prefix": {
"description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_prefix_kana": {
"anyOf": [
@@ -79219,7 +81571,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_prefix_kanji": {
"anyOf": [
@@ -79234,11 +81589,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoices": {
"description": "Settings specific to the account's use of Invoices.",
@@ -79259,11 +81620,17 @@
"type": "string"
}
],
- "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized."
+ "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoices_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments": {
"description": "Settings that apply across payment methods for charging on the account.",
@@ -79271,28 +81638,43 @@
"statement_descriptor": {
"description": "The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_kana": {
"description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_kanji": {
"description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payments_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payouts": {
"description": "Settings specific to the account's payouts.",
"properties": {
"debit_negative_balances": {
"description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"schedule": {
"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](/connect/bank-transfers#payout-information) documentation.",
@@ -79310,7 +81692,10 @@
"type": "integer"
}
],
- "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 remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)."
+ "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 remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.",
@@ -79322,11 +81707,17 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"monthly_anchor": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"weekly_anchor": {
"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`.)",
@@ -79340,31 +81731,49 @@
"wednesday"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "transfer_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
"description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payout_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_forms": {
"description": "Settings specific to the account's tax forms.",
"properties": {
"consented_to_paperless_delivery": {
"description": "Whether the account opted out of receiving their tax forms by postal delivery.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_form_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"treasury": {
"description": "Settings specific to the account's Treasury FinancialAccounts.",
@@ -79375,11 +81784,17 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted the service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted the service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -79394,15 +81809,24 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ "description": "The user agent of the browser from which the account representative accepted the service agreement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "treasury_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_specs_update",
@@ -79414,25 +81838,40 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted their service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted their service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_agreement": {
"description": "The user's service agreement type.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the account representative accepted their service agreement.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tos_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -79690,7 +82129,10 @@
},
"requested": {
"description": "To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.\n\nIf a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -79929,7 +82371,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -80203,13 +82648,16 @@
},
"default_for_currency": {
"description": "When set to true, this becomes the default external account for its currency.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"documents": {
"description": "Documents that may be submitted to satisfy various informational requests.",
"properties": {
"bank_account_ownership_verification": {
- "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 bank account that displays the last 4 digits of the account number, either a statement or a voided check.",
+ "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 bank account that displays the last 4 digits of the account number, either a statement or a check.",
"properties": {
"files": {
"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`.",
@@ -80217,11 +82665,17 @@
"maxLength": 500,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "external_account_documents_param",
@@ -80426,27 +82880,45 @@
"properties": {
"director": {
"description": "A filter on the list of people returned based on whether these people are directors of the account's company.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executive": {
"description": "A filter on the list of people returned based on whether these people are executives of the account's company.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"legal_guardian": {
"description": "A filter on the list of people returned based on whether these people are legal guardians of the account's representative.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "A filter on the list of people returned based on whether these people are owners of the account's company.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"representative": {
"description": "A filter on the list of people returned based on whether these people are the representative of the account's company.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "all_people_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -80543,7 +83015,10 @@
"required": true,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "simple"
}
@@ -80605,7 +83080,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
@@ -80613,11 +83088,17 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted the service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted the service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -80632,11 +83113,17 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ "description": "The user agent of the browser from which the account representative accepted the service agreement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_additional_tos_acceptances_specs",
@@ -80648,36 +83135,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the person's address (Japan only).",
@@ -80685,37 +83193,58 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
@@ -80727,37 +83256,58 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
@@ -80819,11 +83369,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passport": {
"description": "One or more documents showing the person's passport page with photo and personal data.",
@@ -80844,11 +83400,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"visa": {
"description": "One or more documents showing the person's visa required for living in the country where they are residing.",
@@ -80869,11 +83431,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_documents_specs",
@@ -80881,7 +83449,10 @@
},
"email": {
"description": "The person's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -80894,7 +83465,10 @@
"first_name": {
"description": "The person's first name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kana": {
"description": "The Kana variation of the person's first name (Japan only).",
@@ -80931,7 +83505,10 @@
"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://docs.stripe.com/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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://docs.stripe.com/js/tokens/create_token?type=pii).",
@@ -80941,7 +83518,10 @@
"last_name": {
"description": "The person's last name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kana": {
"description": "The Kana variation of the person's last name (Japan only).",
@@ -80987,7 +83567,10 @@
},
"phone": {
"description": "The person's phone number.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -81000,32 +83583,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
@@ -81036,19 +83637,31 @@
"properties": {
"director": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executive": {
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"legal_guardian": {
"description": "Whether the person is the legal guardian of the account's representative.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_ownership": {
"anyOf": [
@@ -81062,24 +83675,39 @@
"type": "string"
}
],
- "description": "The percent owned by the person of the account's legal entity."
+ "description": "The percent owned by the person of the account's legal entity.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"representative": {
"description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The person's title (e.g., CEO, Support Engineer).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ssn_last_4": {
"description": "The last four digits of the person's Social Security number (U.S. only).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "The person's verification status.",
@@ -81090,16 +83718,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -81107,16 +83744,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_specs",
@@ -81301,7 +83947,10 @@
"required": true,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "simple"
},
@@ -81373,7 +84022,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
@@ -81381,11 +84030,17 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted the service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted the service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -81400,11 +84055,17 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ "description": "The user agent of the browser from which the account representative accepted the service agreement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_additional_tos_acceptances_specs",
@@ -81416,36 +84077,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the person's address (Japan only).",
@@ -81453,37 +84135,58 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
@@ -81495,37 +84198,58 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
@@ -81587,11 +84311,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passport": {
"description": "One or more documents showing the person's passport page with photo and personal data.",
@@ -81612,11 +84342,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"visa": {
"description": "One or more documents showing the person's visa required for living in the country where they are residing.",
@@ -81637,11 +84373,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_documents_specs",
@@ -81649,7 +84391,10 @@
},
"email": {
"description": "The person's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -81662,7 +84407,10 @@
"first_name": {
"description": "The person's first name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kana": {
"description": "The Kana variation of the person's first name (Japan only).",
@@ -81699,7 +84447,10 @@
"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://docs.stripe.com/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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://docs.stripe.com/js/tokens/create_token?type=pii).",
@@ -81709,7 +84460,10 @@
"last_name": {
"description": "The person's last name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kana": {
"description": "The Kana variation of the person's last name (Japan only).",
@@ -81755,7 +84509,10 @@
},
"phone": {
"description": "The person's phone number.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -81768,32 +84525,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
@@ -81804,19 +84579,31 @@
"properties": {
"director": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executive": {
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"legal_guardian": {
"description": "Whether the person is the legal guardian of the account's representative.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_ownership": {
"anyOf": [
@@ -81830,24 +84617,39 @@
"type": "string"
}
],
- "description": "The percent owned by the person of the account's legal entity."
+ "description": "The percent owned by the person of the account's legal entity.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"representative": {
"description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The person's title (e.g., CEO, Support Engineer).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ssn_last_4": {
"description": "The last four digits of the person's Social Security number (U.S. only).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "The person's verification status.",
@@ -81858,16 +84660,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -81875,16 +84686,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_specs",
@@ -82007,7 +84827,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -82322,7 +85145,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -82338,19 +85164,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -82894,7 +85732,10 @@
"properties": {
"amount": {
"description": "A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -82909,7 +85750,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -83002,7 +85846,10 @@
"user": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -83127,7 +85974,10 @@
"expires_at": {
"description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "A name for the secret that's unique within the scope.",
@@ -83153,7 +86003,10 @@
"user": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -83245,7 +86098,10 @@
"user": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -83339,7 +86195,10 @@
"user": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -83463,19 +86322,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -83541,7 +86412,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -83574,7 +86448,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -83734,7 +86611,10 @@
"enum": [
"usage_threshold"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -83781,7 +86661,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -83913,11 +86796,17 @@
"customer": {
"description": "Limit the scope to this alert only to this customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "alert_filter",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The title of the alert.",
@@ -83934,7 +86823,10 @@
"meter": {
"description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recurrence": {
"description": "Whether the alert should only fire only once, or once per billing cycle.",
@@ -83950,7 +86842,10 @@
"recurrence"
],
"title": "usage_threshold_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -84267,7 +87162,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -84413,7 +87311,10 @@
"properties": {
"active": {
"description": "Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -84428,12 +87329,18 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the margin, which is displayed to customers, such as on invoices.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_off": {
"description": "Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.",
@@ -84573,7 +87480,10 @@
"properties": {
"active": {
"description": "Whether the margin can be applied to invoices, invoice items, or invoice line items or not.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -84588,12 +87498,18 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the margin, which is displayed to customers, such as on invoices.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -84652,11 +87568,17 @@
"identifier": {
"description": "Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "event_adjustment_cancel_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"event_name": {
"description": "The name of the meter event. Corresponds with the `event_name` field on a meter.",
@@ -84749,7 +87671,10 @@
"identifier": {
"description": "A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payload": {
"additionalProperties": {
@@ -84761,7 +87686,10 @@
"timestamp": {
"description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -84860,7 +87788,10 @@
"active",
"inactive"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -84985,7 +87916,10 @@
"type"
],
"title": "customer_mapping_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_aggregation": {
"description": "The default settings to aggregate a meter's events with.",
@@ -85021,7 +87955,10 @@
"day",
"hour"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -85044,7 +87981,10 @@
"event_payload_key"
],
"title": "meter_value_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -85181,7 +88121,10 @@
"display_name": {
"description": "The meter's name.",
"maxLength": 250,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -85396,7 +88339,10 @@
"day",
"hour"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -85553,7 +88499,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -85589,7 +88538,10 @@
"name": "is_default",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -85738,15 +88690,24 @@
"type": "string"
}
],
- "description": "The messaging shown to customers in the portal."
+ "description": "The messaging shown to customers in the portal.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"privacy_policy_url": {
"description": "A link to the business’s publicly available privacy policy.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terms_of_service_url": {
"description": "A link to the business’s publicly available terms of service.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "business_profile_create_param",
@@ -85803,7 +88764,10 @@
"type": "string"
}
],
- "description": "The types of customer updates that are supported. When empty, customers are not updateable."
+ "description": "The types of customer updates that are supported. When empty, customers are not updateable.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"description": "Whether the feature is enabled.",
@@ -85814,7 +88778,10 @@
"enabled"
],
"title": "customer_update_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_history": {
"description": "Information about showing the billing history in the portal.",
@@ -85828,7 +88795,10 @@
"enabled"
],
"title": "invoice_list_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_update": {
"description": "Information about updating payment methods in the portal.",
@@ -85842,7 +88812,10 @@
"enabled"
],
"title": "payment_method_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_cancel": {
"description": "Information about canceling subscriptions in the portal.",
@@ -85887,7 +88860,10 @@
"options"
],
"title": "subscription_cancellation_reason_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"description": "Whether the feature is enabled.",
@@ -85899,7 +88875,10 @@
"at_period_end",
"immediately"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"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.",
@@ -85908,14 +88887,20 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "subscription_cancel_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_update": {
"description": "Information about updating subscriptions in the portal.",
@@ -85990,7 +88975,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -85999,7 +88987,10 @@
"products"
],
"title": "subscription_update_creation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "features_creation_param",
@@ -86017,14 +89008,20 @@
"enabled"
],
"title": "login_page_create_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -86177,7 +89174,10 @@
"properties": {
"active": {
"description": "Whether the configuration is active and can be used to create portal sessions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"business_profile": {
"description": "The business information shown to customers in the portal.",
@@ -86195,7 +89195,10 @@
"type": "string"
}
],
- "description": "The messaging shown to customers in the portal."
+ "description": "The messaging shown to customers in the portal.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"privacy_policy_url": {
"anyOf": [
@@ -86209,7 +89212,10 @@
"type": "string"
}
],
- "description": "A link to the business’s publicly available privacy policy."
+ "description": "A link to the business’s publicly available privacy policy.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terms_of_service_url": {
"anyOf": [
@@ -86223,11 +89229,17 @@
"type": "string"
}
],
- "description": "A link to the business’s publicly available terms of service."
+ "description": "A link to the business’s publicly available terms of service.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "business_profile_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_return_url": {
"anyOf": [
@@ -86280,15 +89292,24 @@
"type": "string"
}
],
- "description": "The types of customer updates that are supported. When empty, customers are not updateable."
+ "description": "The types of customer updates that are supported. When empty, customers are not updateable.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"description": "Whether the feature is enabled.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_update_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_history": {
"description": "Information about showing the billing history in the portal.",
@@ -86302,7 +89323,10 @@
"enabled"
],
"title": "invoice_list_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_update": {
"description": "Information about updating payment methods in the portal.",
@@ -86316,7 +89340,10 @@
"enabled"
],
"title": "payment_method_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_cancel": {
"description": "Information about canceling subscriptions in the portal.",
@@ -86353,18 +89380,27 @@
"type": "string"
}
],
- "description": "Which cancellation reasons will be given as options to the customer."
+ "description": "Which cancellation reasons will be given as options to the customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "subscription_cancellation_reason_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"description": "Whether the feature is enabled.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mode": {
"description": "Whether to cancel subscriptions immediately or at the end of the billing period.",
@@ -86372,7 +89408,10 @@
"at_period_end",
"immediately"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"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.",
@@ -86381,11 +89420,17 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_cancel_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_update": {
"description": "Information about updating subscriptions in the portal.",
@@ -86410,11 +89455,17 @@
"type": "string"
}
],
- "description": "The types of subscription updates that are supported. When empty, subscriptions are not updateable."
+ "description": "The types of subscription updates that are supported. When empty, subscriptions are not updateable.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"description": "Whether the feature is enabled.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"products": {
"anyOf": [
@@ -86451,7 +89502,10 @@
"type": "string"
}
],
- "description": "The list of up to 10 products that support subscription updates."
+ "description": "The list of up to 10 products that support subscription updates.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.",
@@ -86460,15 +89514,24 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_update_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "features_updating_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"login_page": {
"description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).",
@@ -86482,7 +89545,10 @@
"enabled"
],
"title": "login_page_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -86555,7 +89621,10 @@
"configuration": {
"description": "The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The ID of an existing customer.",
@@ -86582,11 +89651,17 @@
"custom_message": {
"description": "A custom message to display to the customer after the flow is completed.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "after_completion_hosted_confirmation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"redirect": {
"description": "Configuration when `after_completion.type=redirect`.",
@@ -86600,7 +89675,10 @@
"return_url"
],
"title": "after_completion_redirect_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The specified behavior after the flow is completed.",
@@ -86616,7 +89694,10 @@
"type"
],
"title": "flow_data_after_completion_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_cancel": {
"description": "Configuration when `flow_data.type=subscription_cancel`.",
@@ -86652,7 +89733,10 @@
"type"
],
"title": "retention_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "The ID of the subscription to be canceled.",
@@ -86664,7 +89748,10 @@
"subscription"
],
"title": "flow_data_subscription_cancel_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_update": {
"description": "Configuration when `flow_data.type=subscription_update`.",
@@ -86679,7 +89766,10 @@
"subscription"
],
"title": "flow_data_subscription_update_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_update_confirm": {
"description": "Configuration when `flow_data.type=subscription_update_confirm`.",
@@ -86691,18 +89781,27 @@
"coupon": {
"description": "The ID of the coupon to apply to this subscription update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to apply to this subscription update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_update_confirm_discount_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.",
@@ -86716,11 +89815,17 @@
"price": {
"description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -86742,7 +89847,10 @@
"subscription"
],
"title": "flow_data_subscription_update_confirm_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of flow that the customer will go through.",
@@ -86759,7 +89867,10 @@
"type"
],
"title": "flow_data_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"locale": {
"description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.",
@@ -86812,15 +89923,24 @@
"zh-HK",
"zh-TW"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_url": {
"description": "The default URL to redirect customers to when they click on the portal's link to return to your website.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -86868,7 +89988,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -86884,19 +90007,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -86975,7 +90110,10 @@
"undelivered"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -87258,7 +90396,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -87295,7 +90436,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -87316,7 +90460,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -87338,7 +90485,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -87500,19 +90650,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -87532,7 +90694,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -87716,15 +90881,24 @@
"type": "integer"
},
"application_fee": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"application_fee_amount": {
"description": "A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capture": {
"description": "Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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).",
@@ -87733,12 +90907,18 @@
"customer": {
"description": "The ID of an existing customer that will be charged in this request.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"properties": {
@@ -87749,14 +90929,20 @@
},
"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"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"account"
],
"title": "destination_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -87786,7 +90972,10 @@
"on_behalf_of": {
"description": "The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"radar_options": {
"description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
@@ -87794,7 +90983,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -87802,7 +90994,10 @@
},
"receipt_email": {
"description": "The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.",
@@ -87813,32 +91008,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -87847,7 +91060,10 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
@@ -87857,12 +91073,18 @@
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -87870,30 +91092,45 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"source": {
"description": "A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.",
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
"properties": {
"amount": {
"description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -87905,11 +91142,17 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_group": {
"description": "A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -87968,7 +91211,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -87979,7 +91225,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -88188,12 +91437,18 @@
"customer": {
"description": "The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -88259,7 +91514,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -88269,27 +91527,42 @@
"car_class_code": {
"description": "Class code of the car.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_make": {
"description": "Make of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_model": {
"description": "Model of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the rental car company.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_service_phone_number": {
"description": "The customer service phone number of the car rental company.",
"maxLength": 16,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_rented": {
"description": "Number of days the car is being rented.",
@@ -88306,7 +91579,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -88314,25 +91590,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -88350,7 +91641,10 @@
"title": "car_rental_driver",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -88364,11 +91658,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep nor cancel their booking.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_address": {
"description": "Car pick-up address.",
@@ -88376,36 +91676,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -88414,7 +91735,10 @@
},
"rate_amount": {
"description": "Rental rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rate_interval": {
"description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`",
@@ -88423,12 +91747,18 @@
"month",
"week"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"renter_name": {
"description": "The name of the person or entity renting the car.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_address": {
"description": "Car return address.",
@@ -88436,36 +91766,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -88474,7 +91825,10 @@
},
"tax_exempt": {
"description": "Indicates whether the goods or services are tax-exempt or tax is not collected.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -88484,14 +91838,20 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"event_details": {
"description": "Event details for this PaymentIntent",
"properties": {
"access_controlled_venue": {
"description": "Indicates if the tickets are digitally checked when entering the venue.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address": {
"description": "The event location's address.",
@@ -88499,36 +91859,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -88543,12 +91924,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the company",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -88561,7 +91948,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -88569,35 +91959,56 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"genre": {
"description": "Type of the event entertainment (concert, sports event etc)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the event.",
@@ -88607,14 +92018,20 @@
"starts_at": {
"description": "Event start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -88632,17 +92049,26 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
"maxLength": 8,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -88655,7 +92081,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -88663,30 +92092,48 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation.",
@@ -88704,7 +92151,10 @@
"title": "flight_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The individual flight segments associated with the trip.",
@@ -88712,22 +92162,34 @@
"properties": {
"amount": {
"description": "The flight segment amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrival_airport": {
"description": "The International Air Transport Association (IATA) airport code for the arrival airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrives_at": {
"description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departs_at": {
"description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.",
@@ -88737,12 +92199,18 @@
"departure_airport": {
"description": "The International Air Transport Association (IATA) airport code for the departure airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number associated with the segment",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The fare class for the segment.",
@@ -88752,7 +92220,10 @@
"first",
"premium_economy"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -88766,14 +92237,20 @@
"ticket_number": {
"description": "The ticket number associated with the travel reservation.",
"maxLength": 14,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -88784,40 +92261,64 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"adults": {
"description": "The number of adults on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -88832,12 +92333,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
"maxLength": 9,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"category": {
"description": "The lodging category",
@@ -88845,7 +92352,10 @@
"hotel",
"vacation_rental"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"checkin_at": {
"description": "Loding check-in time. Measured in seconds since the Unix epoch.",
@@ -88859,11 +92369,17 @@
},
"customer_service_phone_number": {
"description": "The customer service phone number of the lodging company.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"daily_room_rate_amount": {
"description": "The daily lodging room rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -88876,7 +92392,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -88884,25 +92403,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -88917,24 +92451,39 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fire_safety_act_compliance": {
"description": "Indicates whether the lodging location is compliant with the Fire Safety Act.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the lodging location.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number_of_rooms": {
"description": "The number of rooms on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation",
@@ -88952,28 +92501,46 @@
"title": "lodging_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"property_phone_number": {
"description": "The phone number of the lodging location.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_class": {
"description": "The room class for this purchase.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_nights": {
"description": "The number of room nights",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_room_tax_amount": {
"description": "The total tax amount associating with the room reservation.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_tax_amount": {
"description": "The total tax amount",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -88981,7 +92548,10 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -88999,11 +92569,17 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_interval": {
"description": "Subscription billing details for this purchase.",
@@ -89028,12 +92604,18 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the product on subscription. e.g. Apple Music Subscription",
@@ -89043,14 +92625,20 @@
"starts_at": {
"description": "Subscription start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_details",
@@ -89059,7 +92647,10 @@
"receipt_email": {
"description": "This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.",
@@ -89070,32 +92661,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -89104,7 +92713,10 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
@@ -89114,12 +92726,18 @@
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -89127,7 +92745,10 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_group": {
"description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
@@ -89202,11 +92823,17 @@
"properties": {
"amount": {
"description": "The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"application_fee": {
"description": "An application fee to add on to this charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"application_fee_amount": {
"description": "An application fee amount to add on to this charge, which must be less than or equal to the original amount.",
@@ -89239,7 +92866,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -89249,27 +92879,42 @@
"car_class_code": {
"description": "Class code of the car.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_make": {
"description": "Make of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_model": {
"description": "Model of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the rental car company.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_service_phone_number": {
"description": "The customer service phone number of the car rental company.",
"maxLength": 16,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_rented": {
"description": "Number of days the car is being rented.",
@@ -89286,7 +92931,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -89294,25 +92942,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -89330,7 +92993,10 @@
"title": "car_rental_driver",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -89344,11 +93010,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep nor cancel their booking.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_address": {
"description": "Car pick-up address.",
@@ -89356,36 +93028,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -89394,7 +93087,10 @@
},
"rate_amount": {
"description": "Rental rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rate_interval": {
"description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`",
@@ -89403,12 +93099,18 @@
"month",
"week"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"renter_name": {
"description": "The name of the person or entity renting the car.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_address": {
"description": "Car return address.",
@@ -89416,36 +93118,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -89454,7 +93177,10 @@
},
"tax_exempt": {
"description": "Indicates whether the goods or services are tax-exempt or tax is not collected.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -89464,14 +93190,20 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"event_details": {
"description": "Event details for this PaymentIntent",
"properties": {
"access_controlled_venue": {
"description": "Indicates if the tickets are digitally checked when entering the venue.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address": {
"description": "The event location's address.",
@@ -89479,36 +93211,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -89523,12 +93276,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the company",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -89541,7 +93300,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -89549,35 +93311,56 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"genre": {
"description": "Type of the event entertainment (concert, sports event etc)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the event.",
@@ -89587,14 +93370,20 @@
"starts_at": {
"description": "Event start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -89612,17 +93401,26 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
"maxLength": 8,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -89635,7 +93433,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -89643,30 +93444,48 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation.",
@@ -89684,7 +93503,10 @@
"title": "flight_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The individual flight segments associated with the trip.",
@@ -89692,22 +93514,34 @@
"properties": {
"amount": {
"description": "The flight segment amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrival_airport": {
"description": "The International Air Transport Association (IATA) airport code for the arrival airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrives_at": {
"description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departs_at": {
"description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.",
@@ -89717,12 +93551,18 @@
"departure_airport": {
"description": "The International Air Transport Association (IATA) airport code for the departure airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number associated with the segment",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The fare class for the segment.",
@@ -89732,7 +93572,10 @@
"first",
"premium_economy"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -89746,14 +93589,20 @@
"ticket_number": {
"description": "The ticket number associated with the travel reservation.",
"maxLength": 14,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -89764,40 +93613,64 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"adults": {
"description": "The number of adults on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -89812,12 +93685,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
"maxLength": 9,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"category": {
"description": "The lodging category",
@@ -89825,7 +93704,10 @@
"hotel",
"vacation_rental"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"checkin_at": {
"description": "Loding check-in time. Measured in seconds since the Unix epoch.",
@@ -89839,11 +93721,17 @@
},
"customer_service_phone_number": {
"description": "The customer service phone number of the lodging company.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"daily_room_rate_amount": {
"description": "The daily lodging room rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -89856,7 +93744,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -89864,25 +93755,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -89897,24 +93803,39 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fire_safety_act_compliance": {
"description": "Indicates whether the lodging location is compliant with the Fire Safety Act.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the lodging location.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number_of_rooms": {
"description": "The number of rooms on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation",
@@ -89932,28 +93853,46 @@
"title": "lodging_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"property_phone_number": {
"description": "The phone number of the lodging location.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_class": {
"description": "The room class for this purchase.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_nights": {
"description": "The number of room nights",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_room_tax_amount": {
"description": "The total tax amount associating with the room reservation.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_tax_amount": {
"description": "The total tax amount",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -89961,7 +93900,10 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -89979,11 +93921,17 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_interval": {
"description": "Subscription billing details for this purchase.",
@@ -90008,12 +93956,18 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the product on subscription. e.g. Apple Music Subscription",
@@ -90023,14 +93977,20 @@
"starts_at": {
"description": "Subscription start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_details",
@@ -90038,24 +93998,36 @@
},
"receipt_email": {
"description": "The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
"properties": {
"amount": {
"description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "transfer_data_specs",
@@ -90322,19 +94294,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -90422,7 +94406,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -90470,7 +94457,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -90613,6 +94603,10 @@
"explode": true,
"style": "deepObject"
},
+ "permissions": {
+ "explode": true,
+ "style": "deepObject"
+ },
"phone_number_collection": {
"explode": true,
"style": "deepObject"
@@ -90653,7 +94647,10 @@
"properties": {
"allow_promotion_codes": {
"description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"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.",
@@ -90664,7 +94661,10 @@
"enabled"
],
"title": "recovery_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "after_expiration_params",
@@ -90686,7 +94686,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -90701,7 +94704,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -90726,7 +94732,10 @@
"client_reference_id": {
"description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nsession with your internal systems.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"consent_collection": {
"description": "Configure fields for the Checkout Session to gather active consent from customers.",
@@ -90747,7 +94756,10 @@
"position"
],
"title": "payment_method_reuse_agreement_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotions": {
"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.",
@@ -90755,7 +94767,10 @@
"auto",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terms_of_service": {
"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).",
@@ -90763,7 +94778,10 @@
"none",
"required"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "consent_collection_params",
@@ -90783,7 +94801,10 @@
"default_value": {
"description": "The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"options": {
"description": "The options available for the customer to select. Up to 200 options allowed.",
@@ -90814,7 +94835,10 @@
"options"
],
"title": "custom_field_dropdown_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"key": {
"description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
@@ -90850,23 +94874,38 @@
"default_value": {
"description": "The value that will pre-fill the field on the payment page.",
"maxLength": 255,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"maximum_length": {
"description": "The maximum character length constraint for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_length": {
"description": "The minimum character length requirement for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_field_numeric_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"text": {
"description": "Configuration for `type=text` fields.",
@@ -90874,19 +94913,31 @@
"default_value": {
"description": "The value that will pre-fill the field on the payment page.",
"maxLength": 255,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"maximum_length": {
"description": "The maximum character length constraint for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_length": {
"description": "The minimum character length requirement for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_field_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of the field.",
@@ -90934,7 +94985,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed after the payment confirmation button."
+ "description": "Custom text that should be displayed after the payment confirmation button.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_address": {
"anyOf": [
@@ -90959,7 +95013,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed alongside shipping address collection."
+ "description": "Custom text that should be displayed alongside shipping address collection.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"submit": {
"anyOf": [
@@ -90984,7 +95041,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed alongside the payment confirmation button."
+ "description": "Custom text that should be displayed alongside the payment confirmation button.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terms_of_service_acceptance": {
"anyOf": [
@@ -91009,7 +95069,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed in place of the default terms of service agreement text."
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_text_param",
@@ -91018,7 +95081,10 @@
"customer": {
"description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_creation": {
"description": "Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.\n\nWhen a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout\nwith [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).\n\nSessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)\nin the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.\n\nCan only be set in `payment` and `setup` mode.",
@@ -91030,7 +95096,10 @@
},
"customer_email": {
"description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once a session is\ncomplete, use the `customer` field.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_update": {
"description": "Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.",
@@ -91042,7 +95111,10 @@
"never"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.",
@@ -91051,7 +95123,10 @@
"never"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Describes whether Checkout saves shipping information onto `customer.shipping`.\nTo collect shipping information, use `shipping_address_collection`. Defaults to `never`.",
@@ -91060,7 +95135,10 @@
"never"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_update_params",
@@ -91073,12 +95151,18 @@
"coupon": {
"description": "The ID of the coupon to apply to this Session.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to apply to this Session.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "discount_params",
@@ -91125,7 +95209,10 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with the invoice."
+ "description": "The account tax IDs associated with the invoice.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"custom_fields": {
"anyOf": [
@@ -91159,24 +95246,36 @@
"type": "string"
}
],
- "description": "Default custom fields to be displayed on invoices for this customer."
+ "description": "Default custom fields to be displayed on invoices for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"footer": {
"description": "Default footer to be displayed on invoices for this customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -91191,14 +95290,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rendering_options": {
"anyOf": [
@@ -91211,7 +95316,10 @@
"exclude_tax",
"include_inclusive_tax"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rendering_options_param",
@@ -91224,11 +95332,17 @@
"type": "string"
}
],
- "description": "Default options for invoice PDF rendering for this customer."
+ "description": "Default options for invoice PDF rendering for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -91250,18 +95364,27 @@
},
"maximum": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "adjustable_quantity_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dynamic_tax_rates": {
"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.",
@@ -91269,12 +95392,18 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -91286,7 +95415,10 @@
"product": {
"description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_data": {
"description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.",
@@ -91294,21 +95426,30 @@
"description": {
"description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"images": {
"description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -91318,7 +95459,10 @@
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -91362,7 +95506,10 @@
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -91374,11 +95521,17 @@
"currency"
],
"title": "price_data_with_product_data",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.",
@@ -91386,13 +95539,19 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_item_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"locale": {
"description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.",
@@ -91447,7 +95606,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mode": {
"description": "The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.",
@@ -91456,14 +95618,20 @@
"setup",
"subscription"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_intent_data": {
"description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
"properties": {
"application_fee_amount": {
"description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capture_method": {
"description": "Controls when the funds will be captured from the customer's account.",
@@ -91472,27 +95640,42 @@
"automatic_async",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"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).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"receipt_email": {
"description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"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.",
@@ -91500,7 +95683,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Shipping information for this payment.",
@@ -91511,12 +95697,18 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
@@ -91526,17 +95718,26 @@
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -91548,7 +95749,10 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
@@ -91558,12 +95762,18 @@
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -91571,24 +95781,36 @@
"name"
],
"title": "shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"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).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"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.",
@@ -91599,11 +95821,17 @@
"destination"
],
"title": "transfer_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_group": {
"description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_data_params",
@@ -91632,7 +95860,10 @@
"limited",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_data_param",
@@ -91650,7 +95881,10 @@
"cad",
"usd"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -91667,7 +95901,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_for": {
"description": "List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.",
@@ -91678,12 +95915,18 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -91692,7 +95935,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -91700,11 +95946,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -91713,7 +95965,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -91723,11 +95978,17 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affirm": {
"description": "contains details about the Affirm payment method options.",
@@ -91737,11 +95998,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay": {
"description": "contains details about the Afterpay Clearpay payment method options.",
@@ -91751,11 +96018,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"alipay": {
"description": "contains details about the Alipay payment method options.",
@@ -91765,11 +96038,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay": {
"description": "contains details about the AmazonPay payment method options.",
@@ -91780,11 +96059,17 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"au_becs_debit": {
"description": "contains details about the AU Becs Debit payment method options.",
@@ -91794,11 +96079,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit": {
"description": "contains details about the Bacs Debit payment method options.",
@@ -91810,11 +96101,17 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"description": "contains details about the Bancontact payment method options.",
@@ -91824,18 +96121,27 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"boleto": {
"description": "contains details about the Boleto payment method options.",
"properties": {
"expires_after_days": {
"description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -91844,11 +96150,17 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"description": "contains details about the Card payment method options.",
@@ -91858,11 +96170,17 @@
"properties": {
"enabled": {
"description": "Setting to true enables installments for this Checkout Session.\nSetting to false will prevent any installment plan from applying to a payment.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -91872,7 +96190,10 @@
"challenge"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -91880,21 +96201,33 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kana": {
"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.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kanji": {
"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.",
"maxLength": 17,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cashapp": {
"description": "contains details about the Cashapp Pay payment method options.",
@@ -91906,11 +96239,17 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"description": "contains details about the Customer Balance payment method options.",
@@ -91931,7 +96270,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requested_address_types": {
"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`.",
@@ -91948,7 +96290,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding.",
@@ -91967,25 +96312,37 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
"enum": [
"bank_transfer"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eps": {
"description": "contains details about the EPS payment method options.",
@@ -91995,11 +96352,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fpx": {
"description": "contains details about the FPX payment method options.",
@@ -92009,11 +96372,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"giropay": {
"description": "contains details about the Giropay payment method options.",
@@ -92023,11 +96392,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"grabpay": {
"description": "contains details about the Grabpay payment method options.",
@@ -92037,11 +96412,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal": {
"description": "contains details about the Ideal payment method options.",
@@ -92051,11 +96432,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna": {
"description": "contains details about the Klarna payment method options.",
@@ -92065,29 +96452,44 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"description": "contains details about the Konbini payment method options.",
"properties": {
"expires_after_days": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"description": "contains details about the Link payment method options.",
@@ -92098,11 +96500,17 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "contains details about the Mobilepay payment method options.",
@@ -92112,11 +96520,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"multibanco": {
"description": "contains details about the Multibanco payment method options.",
@@ -92126,29 +96540,44 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"description": "contains details about the OXXO payment method options.",
"properties": {
"expires_after_days": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24": {
"description": "contains details about the P24 payment method options.",
@@ -92158,15 +96587,24 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tos_shown_and_accepted": {
"description": "Confirm that the payer has accepted the P24 terms and conditions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paynow": {
"description": "contains details about the PayNow payment method options.",
@@ -92176,11 +96614,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"description": "contains details about the PayPal payment method options.",
@@ -92191,7 +96635,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.",
@@ -92219,22 +96666,34 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference_id": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"risk_correlation_id": {
"description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.",
"maxLength": 32,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -92243,7 +96702,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -92251,11 +96713,17 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto": {
"description": "contains details about the PayTo payment method options.",
@@ -92265,7 +96733,10 @@
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
@@ -92273,12 +96744,18 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
@@ -92292,11 +96769,17 @@
"semi_annual",
"weekly"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
@@ -92313,16 +96796,25 @@
"tax",
"utility"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -92330,22 +96822,34 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pix": {
"description": "contains details about the Pix payment method options.",
"properties": {
"expires_after_seconds": {
"description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"revolut_pay": {
"description": "contains details about the RevolutPay payment method options.",
@@ -92356,11 +96860,17 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"description": "contains details about the Sepa Debit payment method options.",
@@ -92372,11 +96882,17 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort": {
"description": "contains details about the Sofort payment method options.",
@@ -92386,11 +96902,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"swish": {
"description": "contains details about the Swish payment method options.",
@@ -92398,11 +96920,17 @@
"reference": {
"description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"description": "contains details about the Us Bank Account payment method options.",
@@ -92423,7 +96951,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -92436,11 +96967,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -92449,7 +96986,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -92458,11 +96998,17 @@
"instant"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"wechat_pay": {
"description": "contains details about the WeChat Pay payment method options.",
@@ -92470,7 +97016,10 @@
"app_id": {
"description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"client": {
"description": "The client type that the end customer will pay from",
@@ -92487,14 +97036,20 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -92525,6 +97080,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -92548,6 +97104,34 @@
},
"type": "array"
},
+ "permissions": {
+ "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.",
+ "properties": {
+ "update": {
+ "description": "Permissions for updating the Checkout Session.",
+ "properties": {
+ "shipping_details": {
+ "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.",
+ "enum": [
+ "client_only",
+ "server_only"
+ ],
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "permissions_update_param",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "permissions_param",
+ "type": "object"
+ },
"phone_number_collection": {
"description": "Controls phone number collection settings for the session.\n\nWe recommend that you review your privacy policy and check with your legal contacts\nbefore using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).",
"properties": {
@@ -92574,7 +97158,10 @@
"return_url": {
"description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`\nand redirect-based payment methods are enabled on the session.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"saved_payment_method_options": {
"description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.",
@@ -92589,7 +97176,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_save": {
"description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default.",
@@ -92597,7 +97187,10 @@
"disabled",
"enabled"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "saved_payment_method_options_param",
@@ -92609,18 +97202,27 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The Stripe account for which the setup is intended.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_data_param",
@@ -92889,7 +97491,10 @@
"shipping_rate": {
"description": "The ID of the Shipping Rate to use for this shipping option.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_rate_data": {
"description": "Parameters to be passed to Shipping Rate creation for this shipping option.",
@@ -92921,7 +97526,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -92947,7 +97555,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_estimate",
@@ -92983,7 +97594,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -92993,7 +97607,10 @@
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -93001,14 +97618,20 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
@@ -93028,14 +97651,20 @@
"enum": [
"fixed_amount"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_option_params",
@@ -93058,12 +97687,18 @@
"properties": {
"application_fee_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total 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).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"description": "A future timestamp to anchor the subscription's billing cycle for new subscriptions.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"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.",
@@ -93071,12 +97706,18 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"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 the [customer portal](https://stripe.com/docs/customer-management).",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -93086,7 +97727,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -93101,22 +97745,34 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The account on behalf of which to charge, for each of the subscription's invoices.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.",
@@ -93124,14 +97780,20 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -93142,16 +97804,25 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"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.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_period_days": {
"description": "Integer representing the number of trial period days before the\ncustomer is charged for the first time. Has to be at least 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -93189,7 +97860,10 @@
"success_url": {
"description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_id_collection": {
"description": "Controls tax ID collection during checkout.",
@@ -93331,6 +98005,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
+ "collected_information": {
+ "explode": true,
+ "style": "deepObject"
+ },
"expand": {
"explode": true,
"style": "deepObject"
@@ -93338,11 +98016,94 @@
"metadata": {
"explode": true,
"style": "deepObject"
+ },
+ "shipping_options": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
+ "collected_information": {
+ "description": "Information about the customer collected within the Checkout Session.",
+ "properties": {
+ "shipping_details": {
+ "description": "The shipping details to apply to this Session.",
+ "properties": {
+ "address": {
+ "description": "The address of the customer",
+ "properties": {
+ "city": {
+ "description": "City, district, suburb, town, or village.",
+ "maxLength": 5000,
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "country": {
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "line1": {
+ "description": "Address line 1 (e.g., street, PO Box, or company name).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "line2": {
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
+ "maxLength": 5000,
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "postal_code": {
+ "description": "ZIP or postal code.",
+ "maxLength": 5000,
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "state": {
+ "description": "State, county, province, or region.",
+ "maxLength": 5000,
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "required": [
+ "country",
+ "line1"
+ ],
+ "title": "address",
+ "type": "object"
+ },
+ "name": {
+ "description": "The name of customer",
+ "maxLength": 255,
+ "type": "string"
+ }
+ },
+ "required": [
+ "address",
+ "name"
+ ],
+ "title": "shipping_details_params",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "collected_information_params",
+ "type": "object"
+ },
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
@@ -93367,6 +98128,204 @@
}
],
"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`."
+ },
+ "shipping_options": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "shipping_rate": {
+ "description": "The ID of the Shipping Rate to use for this shipping option.",
+ "maxLength": 5000,
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "shipping_rate_data": {
+ "description": "Parameters to be passed to Shipping Rate creation for this shipping option.",
+ "properties": {
+ "delivery_estimate": {
+ "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.",
+ "properties": {
+ "maximum": {
+ "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.",
+ "properties": {
+ "unit": {
+ "description": "A unit of time.",
+ "enum": [
+ "business_day",
+ "day",
+ "hour",
+ "month",
+ "week"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Must be greater than 0.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "unit",
+ "value"
+ ],
+ "title": "delivery_estimate_bound",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "minimum": {
+ "description": "The lower bound of the estimated range. If empty, represents no lower bound.",
+ "properties": {
+ "unit": {
+ "description": "A unit of time.",
+ "enum": [
+ "business_day",
+ "day",
+ "hour",
+ "month",
+ "week"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Must be greater than 0.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "unit",
+ "value"
+ ],
+ "title": "delivery_estimate_bound",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "delivery_estimate",
+ "type": "object"
+ },
+ "display_name": {
+ "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
+ "maxLength": 100,
+ "type": "string"
+ },
+ "fixed_amount": {
+ "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
+ "properties": {
+ "amount": {
+ "description": "A non-negative integer in cents representing how much to charge.",
+ "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"
+ },
+ "currency_options": {
+ "additionalProperties": {
+ "properties": {
+ "amount": {
+ "description": "A non-negative integer in cents representing how much to charge.",
+ "type": "integer"
+ },
+ "tax_behavior": {
+ "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
+ "enum": [
+ "exclusive",
+ "inclusive",
+ "unspecified"
+ ],
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "required": [
+ "amount"
+ ],
+ "title": "currency_option",
+ "type": "object"
+ },
+ "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).",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "title": "fixed_amount",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "tax_behavior": {
+ "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
+ "enum": [
+ "exclusive",
+ "inclusive",
+ "unspecified"
+ ],
+ "type": "string"
+ },
+ "tax_code": {
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of calculation to use on the shipping rate.",
+ "enum": [
+ "fixed_amount"
+ ],
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "required": [
+ "display_name"
+ ],
+ "title": "method_params",
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "shipping_option_params",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The shipping rate options to apply to this Session. Up to a maximum of 5."
}
},
"type": "object"
@@ -93752,7 +98711,10 @@
"properties": {
"amount": {
"description": "Requested amount of carbon removal units. Either this or `metric_tons` must be specified.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"beneficiary": {
"description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.",
@@ -93767,12 +98729,18 @@
"public_name"
],
"title": "beneficiary_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -93787,12 +98755,18 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metric_tons": {
"description": "Requested number of tons for the order. Either this or `amount` must be specified.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product": {
"description": "Unique identifier of the Climate product.",
@@ -93985,7 +98959,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -94753,19 +99730,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -94927,7 +99916,10 @@
"properties": {
"amount_off": {
"description": "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"applies_to": {
"description": "A hash containing directions for what this Coupon will apply discounts to.",
@@ -94938,7 +99930,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "applies_to_params",
@@ -94946,7 +99941,10 @@
},
"currency": {
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency_options": {
"additionalProperties": {
@@ -94973,11 +99971,17 @@
"repeating",
"variable"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration_in_months": {
"description": "Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -95016,11 +100020,17 @@
"name": {
"description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.",
"maxLength": 40,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_off": {
"description": "A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"redeem_by": {
"description": "Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.",
@@ -95256,7 +100266,10 @@
"name": {
"description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.",
"maxLength": 40,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -95306,19 +100319,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -95375,7 +100400,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -95543,21 +100571,33 @@
"properties": {
"amount": {
"description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_line_item": {
"description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "The line item quantity to credit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_amounts": {
"anyOf": [
@@ -95595,7 +100635,10 @@
"type": "string"
}
],
- "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`."
+ "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -95613,7 +100656,10 @@
"type": "string"
}
],
- "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`."
+ "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`",
@@ -95625,12 +100671,18 @@
},
"unit_amount": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -95639,19 +100691,28 @@
"title": "credit_note_line_item_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"memo": {
"description": "The credit note's memo appears on the credit note PDF.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"out_of_band_amount": {
"description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.",
@@ -95665,7 +100726,10 @@
"order_change",
"product_unsatisfactory"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund": {
"description": "ID of an existing refund to link this credit note to.",
@@ -95681,11 +100745,17 @@
"properties": {
"amount_refunded": {
"description": "Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund": {
"description": "ID of an existing refund to link this credit note to.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "credit_note_refund_params",
@@ -95699,7 +100769,10 @@
"shipping_rate": {
"description": "The ID of the shipping rate to use for this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "credit_note_shipping_cost",
@@ -95826,21 +100899,33 @@
"properties": {
"amount": {
"description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_line_item": {
"description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "The line item quantity to credit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_amounts": {
"anyOf": [
@@ -95878,7 +100963,10 @@
"type": "string"
}
],
- "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`."
+ "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -95896,7 +100984,10 @@
"type": "string"
}
],
- "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`."
+ "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`",
@@ -95908,12 +100999,18 @@
},
"unit_amount": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -95922,7 +101019,10 @@
"title": "credit_note_line_item_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -95933,7 +101033,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -95947,7 +101050,10 @@
"additionalProperties": {
"type": "string"
},
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -95973,7 +101079,10 @@
"order_change",
"product_unsatisfactory"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -96008,11 +101117,17 @@
"properties": {
"amount_refunded": {
"description": "Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund": {
"description": "ID of an existing refund to link this credit note to.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "credit_note_refund_params",
@@ -96033,7 +101148,10 @@
"shipping_rate": {
"description": "The ID of the shipping rate to use for this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "credit_note_shipping_cost",
@@ -96187,21 +101305,33 @@
"properties": {
"amount": {
"description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_line_item": {
"description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "The line item quantity to credit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_amounts": {
"anyOf": [
@@ -96239,7 +101369,10 @@
"type": "string"
}
],
- "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`."
+ "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -96257,7 +101390,10 @@
"type": "string"
}
],
- "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`."
+ "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`",
@@ -96269,12 +101405,18 @@
},
"unit_amount": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -96283,7 +101425,10 @@
"title": "credit_note_line_item_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -96294,7 +101439,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -96308,7 +101456,10 @@
"additionalProperties": {
"type": "string"
},
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -96334,7 +101485,10 @@
"order_change",
"product_unsatisfactory"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -96369,11 +101523,17 @@
"properties": {
"amount_refunded": {
"description": "Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund": {
"description": "ID of an existing refund to link this credit note to.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "credit_note_refund_params",
@@ -96394,7 +101554,10 @@
"shipping_rate": {
"description": "The ID of the shipping rate to use for this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "credit_note_shipping_cost",
@@ -96732,14 +101895,20 @@
"memo": {
"description": "Credit note memo.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -96874,7 +102043,10 @@
"enabled"
],
"title": "buy_button_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_element": {
"description": "Configuration for the Payment Element.",
@@ -96896,7 +102068,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_redisplay": {
"description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.",
@@ -96905,11 +102080,17 @@
"enabled"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_redisplay_limit": {
"description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_remove": {
"description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
@@ -96918,7 +102099,10 @@
"enabled"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_save": {
"description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
@@ -96927,7 +102111,10 @@
"enabled"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_save_usage": {
"description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.",
@@ -96935,18 +102122,27 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "features_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "payment_element_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pricing_table": {
"description": "Configuration for the pricing table.",
@@ -96960,7 +102156,10 @@
"enabled"
],
"title": "pricing_table_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "components",
@@ -97031,19 +102230,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -97063,7 +102274,10 @@
"required": false,
"schema": {
"maxLength": 512,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -97252,32 +102466,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -97309,29 +102541,47 @@
"manual",
"merchant_default"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "balance_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "cash_balance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.",
"maxLength": 512,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -97381,17 +102631,26 @@
"type": "string"
}
],
- "description": "The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields."
+ "description": "The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"footer": {
"description": "Default footer to be displayed on invoices for this customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rendering_options": {
"anyOf": [
@@ -97404,7 +102663,10 @@
"exclude_tax",
"include_inclusive_tax"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_rendering_options_param",
@@ -97417,11 +102679,17 @@
"type": "string"
}
],
- "description": "Default options for invoice PDF rendering for this customer."
+ "description": "Default options for invoice PDF rendering for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -97443,7 +102711,10 @@
"name": {
"description": "The customer's full name or business name.",
"maxLength": 256,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"next_invoice_sequence": {
"description": "The sequence to be used on the customer's next invoice. Defaults to 1.",
@@ -97451,12 +102722,18 @@
},
"payment_method": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The customer's phone number.",
"maxLength": 20,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locales": {
"description": "Customer's preferred languages, ordered by preference.",
@@ -97481,32 +102758,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -97520,7 +102815,10 @@
"phone": {
"description": "Customer phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -97542,7 +102840,10 @@
"source": {
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Tax details about the customer.",
@@ -97559,7 +102860,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"validate_location": {
"description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.",
@@ -97567,7 +102871,10 @@
"deferred",
"immediately"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_param",
@@ -97588,7 +102895,7 @@
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -97622,6 +102929,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -97680,12 +102988,18 @@
"title": "data_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"test_clock": {
"description": "ID of the test clock to attach to the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"validate": {
"type": "boolean"
@@ -97747,7 +103061,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -97758,7 +103075,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -98041,32 +103361,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -98098,34 +103436,55 @@
"manual",
"merchant_default"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "balance_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "cash_balance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_source": {
"description": "If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.\n\nProvide the ID of a payment source already attached to this customer to make it this customer's default payment source.\n\nIf you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.",
"maxLength": 512,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -98175,17 +103534,26 @@
"type": "string"
}
],
- "description": "The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields."
+ "description": "The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"footer": {
"description": "Default footer to be displayed on invoices for this customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rendering_options": {
"anyOf": [
@@ -98198,7 +103566,10 @@
"exclude_tax",
"include_inclusive_tax"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_rendering_options_param",
@@ -98211,11 +103582,17 @@
"type": "string"
}
],
- "description": "Default options for invoice PDF rendering for this customer."
+ "description": "Default options for invoice PDF rendering for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -98237,7 +103614,10 @@
"name": {
"description": "The customer's full name or business name.",
"maxLength": 256,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"next_invoice_sequence": {
"description": "The sequence to be used on the customer's next invoice. Defaults to 1.",
@@ -98246,7 +103626,10 @@
"phone": {
"description": "The customer's phone number.",
"maxLength": 20,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locales": {
"description": "Customer's preferred languages, ordered by preference.",
@@ -98271,32 +103654,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -98310,7 +103711,10 @@
"phone": {
"description": "Customer phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -98332,7 +103736,10 @@
"source": {
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Tax details about the customer.",
@@ -98349,7 +103756,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"validate_location": {
"description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.",
@@ -98357,7 +103767,10 @@
"deferred",
"immediately"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_param",
@@ -98584,7 +103997,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 350,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -98766,7 +104182,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 350,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -98940,11 +104359,17 @@
"manual",
"merchant_default"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "balance_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -99291,7 +104716,10 @@
"country"
],
"title": "eu_bank_account_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requested_address_types": {
"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`.",
@@ -99305,7 +104733,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of the `bank_transfer`",
@@ -99484,6 +104915,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -99504,7 +104936,10 @@
"zip"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -99716,7 +105151,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -99847,7 +105285,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"source": {
"description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
@@ -100098,7 +105539,10 @@
"account_holder_name": {
"description": "The name of the person or business that owns the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_holder_type": {
"description": "The type of entity that holds the account. This can be either `individual` or `company`.",
@@ -100107,47 +105551,74 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_city": {
"description": "City/District/Suburb/Town/Village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_country": {
"description": "Billing address country, if provided when creating card.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_line1": {
"description": "Address line 1 (Street address/PO Box/Company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_line2": {
"description": "Address line 2 (Apartment/Suite/Unit/Building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_state": {
"description": "State/County/Province/Region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_zip": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exp_month": {
"description": "Two digit number representing the card’s expiration month.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exp_year": {
"description": "Four digit number representing the card’s expiration year.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -100177,7 +105648,10 @@
"name": {
"description": "Cardholder name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"properties": {
@@ -100187,54 +105661,87 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "source_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "Owner's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Owner's full name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Owner's phone number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "owner",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -100324,7 +105831,10 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -100536,7 +106046,7 @@
"type": "array"
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -100570,6 +106080,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -100804,7 +106315,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -100820,19 +106334,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -100888,7 +106414,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -101085,63 +106614,102 @@
"access_activity_log": {
"description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. Has a maximum character count of 20,000.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_address": {
"description": "The billing address provided by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_policy": {
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_policy_disclosure": {
"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.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_rebuttal": {
"description": "A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_communication": {
"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.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_email_address": {
"description": "The email address of the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_name": {
"description": "The name of the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_purchase_ip": {
"description": "The IP address that the customer used when making the purchase.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_signature": {
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duplicate_charge_documentation": {
"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.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duplicate_charge_explanation": {
"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.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duplicate_charge_id": {
"description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enhanced_evidence": {
"anyOf": [
@@ -101166,7 +106734,10 @@
"type": "string"
}
],
- "description": "User Account ID used to log into business platform. Must be recognizable by the user."
+ "description": "User Account ID used to log into business platform. Must be recognizable by the user.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_device_fingerprint": {
"anyOf": [
@@ -101181,7 +106752,10 @@
"type": "string"
}
],
- "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters."
+ "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_device_id": {
"anyOf": [
@@ -101196,7 +106770,10 @@
"type": "string"
}
],
- "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters."
+ "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_email_address": {
"anyOf": [
@@ -101211,7 +106788,10 @@
"type": "string"
}
],
- "description": "The email address of the customer."
+ "description": "The email address of the customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_purchase_ip": {
"anyOf": [
@@ -101226,7 +106806,10 @@
"type": "string"
}
],
- "description": "The IP address that the customer used when making the purchase."
+ "description": "The IP address that the customer used when making the purchase.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"merchandise_or_services": {
"description": "Categorization of disputed payment.",
@@ -101234,7 +106817,10 @@
"merchandise",
"services"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -101249,7 +106835,10 @@
"type": "string"
}
],
- "description": "A description of the product or service that was sold."
+ "description": "A description of the product or service that was sold.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_address": {
"description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.",
@@ -101267,7 +106856,10 @@
"type": "string"
}
],
- "description": "City, district, suburb, town, or village."
+ "description": "City, district, suburb, town, or village.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"anyOf": [
@@ -101282,7 +106874,10 @@
"type": "string"
}
],
- "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"anyOf": [
@@ -101297,7 +106892,10 @@
"type": "string"
}
],
- "description": "Address line 1 (e.g., street, PO Box, or company name)."
+ "description": "Address line 1 (e.g., street, PO Box, or company name).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"anyOf": [
@@ -101312,7 +106910,10 @@
"type": "string"
}
],
- "description": "Address line 2 (e.g., apartment, suite, unit, or building)."
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"anyOf": [
@@ -101327,7 +106928,10 @@
"type": "string"
}
],
- "description": "ZIP or postal code."
+ "description": "ZIP or postal code.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"anyOf": [
@@ -101342,15 +106946,24 @@
"type": "string"
}
],
- "description": "State, county, province, or region."
+ "description": "State, county, province, or region.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "visa_compelling_evidence3_disputed_transaction",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prior_undisputed_transactions": {
"description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.",
@@ -101374,7 +106987,10 @@
"type": "string"
}
],
- "description": "User Account ID used to log into business platform. Must be recognizable by the user."
+ "description": "User Account ID used to log into business platform. Must be recognizable by the user.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_device_fingerprint": {
"anyOf": [
@@ -101389,7 +107005,10 @@
"type": "string"
}
],
- "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters."
+ "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_device_id": {
"anyOf": [
@@ -101404,7 +107023,10 @@
"type": "string"
}
],
- "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters."
+ "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_email_address": {
"anyOf": [
@@ -101419,7 +107041,10 @@
"type": "string"
}
],
- "description": "The email address of the customer."
+ "description": "The email address of the customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_purchase_ip": {
"anyOf": [
@@ -101434,7 +107059,10 @@
"type": "string"
}
],
- "description": "The IP address that the customer used when making the purchase."
+ "description": "The IP address that the customer used when making the purchase.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -101449,7 +107077,10 @@
"type": "string"
}
],
- "description": "A description of the product or service that was sold."
+ "description": "A description of the product or service that was sold.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_address": {
"description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.",
@@ -101467,7 +107098,10 @@
"type": "string"
}
],
- "description": "City, district, suburb, town, or village."
+ "description": "City, district, suburb, town, or village.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"anyOf": [
@@ -101482,7 +107116,10 @@
"type": "string"
}
],
- "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"anyOf": [
@@ -101497,7 +107134,10 @@
"type": "string"
}
],
- "description": "Address line 1 (e.g., street, PO Box, or company name)."
+ "description": "Address line 1 (e.g., street, PO Box, or company name).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"anyOf": [
@@ -101512,7 +107152,10 @@
"type": "string"
}
],
- "description": "Address line 2 (e.g., apartment, suite, unit, or building)."
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"anyOf": [
@@ -101527,7 +107170,10 @@
"type": "string"
}
],
- "description": "ZIP or postal code."
+ "description": "ZIP or postal code.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"anyOf": [
@@ -101542,11 +107188,17 @@
"type": "string"
}
],
- "description": "State, county, province, or region."
+ "description": "State, county, province, or region.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -101555,11 +107207,17 @@
"title": "visa_compelling_evidence3_prior_undisputed_transaction",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "visa_compelling_evidence3",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "enhanced_evidence",
@@ -101572,76 +107230,124 @@
"type": "string"
}
],
- "description": "Additional evidence for qualifying evidence programs."
+ "description": "Additional evidence for qualifying evidence programs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"description": "A description of the product or service that was sold. Has a maximum character count of 20,000.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"receipt": {
"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.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_policy": {
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_policy_disclosure": {
"description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_refusal_explanation": {
"description": "A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_date": {
"description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_documentation": {
"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.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_address": {
"description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_date": {
"description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_documentation": {
"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.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"uncategorized_file": {
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"uncategorized_text": {
"description": "Any additional evidence or statements. Has a maximum character count of 20,000.",
"maxLength": 20000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "dispute_evidence_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -101670,7 +107376,10 @@
},
"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": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -101986,7 +107695,10 @@
"name": "archived",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -102033,7 +107745,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -102158,7 +107873,10 @@
"type": "string"
},
"description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The feature's name, for your own purpose, not meant to be displayable to the customer.",
@@ -102331,7 +108049,10 @@
"name": {
"description": "The feature's name, for your own purpose, not meant to be displayable to the customer.",
"maxLength": 80,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -102383,7 +108104,10 @@
"customer": {
"description": "The ID of the Customer you'd like to modify using the resulting ephemeral key.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -102396,17 +108120,26 @@
"issuing_card": {
"description": "The ID of the Issuing Card you'd like to access using the resulting ephemeral key.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nonce": {
"description": "A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_session": {
"description": "The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -102523,19 +108256,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -102627,7 +108372,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
}
@@ -102984,19 +108732,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -103179,10 +108939,13 @@
"expires_at": {
"description": "The link isn't usable after this future timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"file": {
- "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
+ "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"maxLength": 5000,
"type": "string"
},
@@ -103432,19 +109195,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -103510,6 +109285,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -103518,7 +109294,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -103642,13 +109421,16 @@
"description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.",
"properties": {
"create": {
- "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`.",
+ "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`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"type": "boolean"
},
"expires_at": {
"description": "The link isn't available after this future timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -103665,7 +109447,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -103684,6 +109469,7 @@
"customer_signature",
"dispute_evidence",
"identity_document",
+ "issuing_regulatory_reporting",
"pci_document",
"tax_document_user_upload",
"terminal_reader_splashscreen"
@@ -103815,16 +109601,25 @@
"account": {
"description": "The ID of the Stripe account whose accounts will be retrieved.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The ID of the Stripe customer whose accounts will be retrieved.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "accountholder_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -103871,7 +109666,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -104879,12 +110677,18 @@
"account": {
"description": "The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of account holder to collect accounts for.",
@@ -104924,7 +110728,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"countries": {
"description": "List of countries from which to collect accounts.",
@@ -104932,16 +110739,25 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "Stripe ID of the institution with which the customer should be directed to log in.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "filters_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"limits": {
"description": "Settings for configuring Session-specific limits.",
@@ -104955,7 +110771,10 @@
"accounts"
],
"title": "limits_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"manual_entry": {
"description": "Settings for configuring manual entry of account details for this Session.",
@@ -104966,11 +110785,17 @@
"automatic",
"custom"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "manual_entry_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.",
@@ -104998,12 +110823,18 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -105183,19 +111014,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -105226,7 +111069,10 @@
"after"
],
"title": "transaction_refresh_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
}
@@ -105388,23 +111234,38 @@
"properties": {
"gt": {
"description": "Return results where the `created` field is greater than this value.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Return results where the `created` field is greater than or equal to this value.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Return results where the `created` field is less than this value.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Return results where the `created` field is less than or equal to this value.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "created_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -105415,7 +111276,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -105440,7 +111304,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -105451,7 +111318,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -105582,7 +111452,10 @@
"body": {
"description": "The body payload to send to the destination endpoint.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"headers": {
"description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.",
@@ -105606,11 +111479,17 @@
"title": "header_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "request_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"description": "The destination URL for the forwarded request. Must be supported by the config.",
@@ -105871,7 +111750,10 @@
"properties": {
"active": {
"description": "The active state for the new gift card, defaults to false. The active state can be updated after creation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"created_by": {
"description": "Related objects which created this gift card.",
@@ -105904,7 +111786,10 @@
"type"
],
"title": "created_by_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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).",
@@ -105920,14 +111805,20 @@
},
"initial_amount": {
"description": "The initial amount to load onto the new gift card, defaults to 0.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -105995,7 +111886,10 @@
"giftcard_pin": {
"description": "The pin associated with the gift card. Not all gift cards have pins.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -106131,7 +112025,10 @@
"properties": {
"active": {
"description": "The new active state for the gift card.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -106227,7 +112124,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -106259,7 +112159,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -106365,7 +112268,10 @@
},
"confirm": {
"description": "Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the `amount_available` on the gift card. Otherwise, it creates a held transaction that increments the `amount_held` on the gift card.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"created_by": {
"description": "Related objects which created this transaction.",
@@ -106398,7 +112304,10 @@
"type"
],
"title": "created_by_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "The currency of the transaction. This must match the currency of the gift card.",
@@ -106407,7 +112316,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -106427,12 +112339,18 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_group": {
"description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -106571,7 +112489,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -106775,7 +112696,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -106791,19 +112715,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -106874,7 +112810,10 @@
"id_number"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -106885,7 +112824,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -107043,7 +112985,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -107059,19 +113004,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -107126,7 +113083,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -107153,7 +113113,10 @@
"requires_input",
"verified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -107260,7 +113223,10 @@
"client_reference_id": {
"description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -107275,7 +113241,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"options": {
"description": "A set of options for the session’s verification checks.",
@@ -107294,19 +113263,31 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_id_number": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_live_capture": {
"description": "Disable image uploads, identity document images have to be captured using the device’s camera.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_matching_selfie": {
"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).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "document_options",
@@ -107319,35 +113300,56 @@
"type": "string"
}
],
- "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)."
+ "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "session_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"provided_details": {
"description": "Details provided about the user being verified. These details may be shown to the user.",
"properties": {
"email": {
"description": "Email of user being verified",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Phone number of user being verified",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "provided_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"related_customer": {
"description": "Token referencing a Customer resource.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_url": {
"description": "The URL that the user will be redirected to upon completing the verification flow.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.",
@@ -107356,12 +113358,18 @@
"id_number"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_flow": {
"description": "The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -107513,7 +113521,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"options": {
"description": "A set of options for the session’s verification checks.",
@@ -107532,19 +113543,31 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_id_number": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_live_capture": {
"description": "Disable image uploads, identity document images have to be captured using the device’s camera.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_matching_selfie": {
"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).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "document_options",
@@ -107557,26 +113580,41 @@
"type": "string"
}
],
- "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)."
+ "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "session_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"provided_details": {
"description": "Details provided about the user being verified. These details may be shown to the user.",
"properties": {
"email": {
"description": "Email of user being verified",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Phone number of user being verified",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "provided_details_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.",
@@ -107585,7 +113623,10 @@
"id_number"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -107769,19 +113810,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -107801,7 +113854,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -107991,11 +114047,17 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The ID of the customer who will be billed when this invoice item is billed.",
@@ -108005,7 +114067,10 @@
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.",
@@ -108019,7 +114084,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -108052,12 +114120,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -108151,12 +114225,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -108181,7 +114261,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -108454,12 +114537,18 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.",
@@ -108473,7 +114562,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -108506,12 +114598,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -108610,12 +114708,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -108640,7 +114744,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -108771,19 +114878,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -108803,7 +114922,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -108818,19 +114940,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -108904,7 +115038,10 @@
"void"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -108915,7 +115052,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -109096,7 +115236,10 @@
},
"days_until_due": {
"description": "Number of days from when invoice is finalized until the payment is due.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
@@ -109106,7 +115249,10 @@
"due_date": {
"description": "Date on which a payment plan’s payment is due.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -109133,7 +115279,10 @@
},
"auto_advance": {
"description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Settings for automatic tax lookup for this invoice.",
@@ -109147,7 +115296,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -109162,7 +115314,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -109177,7 +115332,10 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "The currency to create this invoice in. Defaults to that of `customer` if not specified.",
@@ -109220,7 +115378,10 @@
"customer": {
"description": "The ID of the customer who will be billed.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.",
@@ -109255,7 +115416,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.",
"maxLength": 1500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -109265,7 +115429,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -109298,12 +115465,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -109392,7 +115565,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -109451,7 +115627,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_options": {
"description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.",
@@ -109469,11 +115648,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -109483,7 +115668,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -109496,7 +115684,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -109510,7 +115701,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -109523,7 +115717,10 @@
"type": "string"
}
],
- "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -109534,7 +115731,10 @@
"properties": {
"enabled": {
"description": "Setting to true enables installments for this invoice.\nSetting to false will prevent any selected plan from applying to a payment.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"anyOf": [
@@ -109542,14 +115742,20 @@
"properties": {
"count": {
"description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
"enum": [
"month"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of installment plan, one of `fixed_count`.",
@@ -109573,11 +115779,17 @@
"type": "string"
}
],
- "description": "The selected installment plan to use for this invoice."
+ "description": "The selected installment plan to use for this invoice.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -109586,7 +115798,10 @@
"automatic",
"challenge"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -109599,7 +115814,10 @@
"type": "string"
}
],
- "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -109621,19 +115839,31 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -109646,7 +115876,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"anyOf": [
@@ -109662,7 +115895,10 @@
"type": "string"
}
],
- "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -109678,7 +115914,10 @@
"type": "string"
}
],
- "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"anyOf": [
@@ -109699,16 +115938,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -109723,7 +115971,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -109736,11 +115987,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -109750,7 +116007,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -109763,11 +116023,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_types": {
"anyOf": [
@@ -109817,7 +116083,10 @@
"type": "string"
}
],
- "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)."
+ "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).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_settings",
@@ -109842,7 +116111,10 @@
"exclude_tax",
"include_inclusive_tax"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pdf": {
"description": "Invoice pdf rendering options",
@@ -109854,11 +116126,17 @@
"auto",
"letter"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rendering_pdf_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rendering_param",
@@ -109870,7 +116148,10 @@
"shipping_rate": {
"description": "The ID of the shipping rate to use for this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_rate_data": {
"description": "Parameters to create a new ad-hoc shipping rate for this order.",
@@ -109902,7 +116183,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -109928,7 +116212,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_estimate",
@@ -109964,7 +116251,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -109974,7 +116264,10 @@
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -109982,14 +116275,20 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
@@ -110009,14 +116308,20 @@
"enum": [
"fixed_amount"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_cost",
@@ -110031,32 +116336,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -110080,7 +116403,10 @@
"type": "string"
}
],
- "description": "Recipient phone (including extension)"
+ "description": "Recipient phone (including extension)",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -110098,14 +116424,20 @@
"subscription": {
"description": "The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -110209,7 +116541,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -110224,7 +116559,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -110245,7 +116583,10 @@
"customer": {
"description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_details": {
"description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
@@ -110257,32 +116598,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -110295,7 +116654,10 @@
"type": "string"
}
],
- "description": "The customer's address."
+ "description": "The customer's address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"anyOf": [
@@ -110307,32 +116669,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -110346,7 +116726,10 @@
"phone": {
"description": "Customer phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -110363,7 +116746,10 @@
"type": "string"
}
],
- "description": "The customer's shipping information. Appears on invoices emailed to this customer."
+ "description": "The customer's shipping information. Appears on invoices emailed to this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Tax details about the customer.",
@@ -110380,11 +116766,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -110394,14 +116786,17 @@
"none",
"reverse"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_ids": {
"description": "The customer's tax IDs.",
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -110435,6 +116830,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -110493,7 +116889,10 @@
"title": "data_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_details_param",
@@ -110507,7 +116906,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -110540,12 +116942,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -110596,20 +117004,32 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of previewed invoice item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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). Only applicable to new invoice items.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -110619,7 +117039,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -110652,12 +117075,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -110692,12 +117121,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the invoice item in the preview."
+ "description": "The coupons to redeem into discounts for the invoice item in the preview.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoiceitem": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -110714,7 +117149,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"period": {
"description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
@@ -110735,12 +117173,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -110765,7 +117209,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -110782,7 +117229,10 @@
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -110791,7 +117241,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
"anyOf": [
@@ -110805,7 +117258,10 @@
"type": "string"
}
],
- "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -110823,16 +117279,25 @@
"type": "string"
}
],
- "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item."
+ "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_item_preview_params",
@@ -110845,7 +117310,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -110912,7 +117380,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -110937,12 +117408,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_end`.",
@@ -110962,7 +117439,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -110979,7 +117459,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -110994,12 +117477,18 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_start`.",
@@ -111028,7 +117517,10 @@
"amendment_start",
"automatic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_actions": {
"description": "Changes to the coupons being redeemed or discounts being applied during the amendment time span.",
@@ -111040,12 +117532,18 @@
"coupon": {
"description": "The coupon code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount for a coupon that was already redeemed.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Details to determine how long the discount should be applied for.",
@@ -111062,20 +117560,32 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The promotion code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the discount to remove.",
@@ -111083,21 +117593,33 @@
"coupon": {
"description": "The coupon code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "The ID of a discount to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -111105,21 +117627,33 @@
"coupon": {
"description": "The coupon code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "An ID of an existing promotion code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of discount action.",
@@ -111137,7 +117671,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"item_actions": {
"description": "Changes to the subscription items during the amendment time span.",
@@ -111153,7 +117690,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -111186,12 +117726,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -111217,14 +117763,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -111233,7 +117785,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
@@ -111241,7 +117796,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -111252,7 +117810,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -111267,14 +117828,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the subscription item to remove.",
@@ -111289,7 +117856,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
@@ -111301,7 +117871,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -111334,12 +117907,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -111365,14 +117944,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -111381,7 +117966,10 @@
},
"quantity": {
"description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.",
@@ -111389,7 +117977,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.",
@@ -111400,7 +117991,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -111415,14 +118009,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of item action.",
@@ -111440,7 +118040,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata_actions": {
"description": "Instructions for how to modify phase metadata",
@@ -111451,7 +118054,10 @@
"type": "string"
},
"description": "Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Keys to remove from schedule phase metadata.",
@@ -111459,7 +118065,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"anyOf": [
@@ -111476,7 +118085,10 @@
"type": "string"
}
],
- "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten."
+ "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to update phase-level `metadata` on subscription schedules.",
@@ -111494,7 +118106,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.",
@@ -111503,7 +118118,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_pause_collection": {
"description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.",
@@ -111525,7 +118143,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -111540,7 +118161,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -111548,7 +118172,10 @@
"amendment_end",
"amendment_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -111562,15 +118189,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -111579,7 +118215,10 @@
"title": "amendment_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -111587,7 +118226,10 @@
"prorate_on_next_phase",
"prorate_up_front"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
@@ -111595,7 +118237,10 @@
"cancel",
"release"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phases": {
"description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.",
@@ -111612,7 +118257,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -111645,12 +118293,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -111681,7 +118335,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -111705,8 +118362,11 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -111723,7 +118383,10 @@
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -111750,11 +118413,17 @@
"class_name": "AddInvoiceItem"
}
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Automatic tax settings for this phase.",
@@ -111768,7 +118437,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -111783,14 +118455,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"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).",
@@ -111798,7 +118476,10 @@
"automatic",
"phase_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_thresholds": {
"anyOf": [
@@ -111806,11 +118487,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -111823,7 +118510,10 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
@@ -111831,21 +118521,33 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -111863,7 +118565,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -111878,7 +118583,10 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -111888,7 +118596,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -111921,12 +118632,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -111961,7 +118678,10 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
+ "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"anyOf": [
@@ -111977,7 +118697,10 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set."
+ "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -111998,18 +118721,27 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."
+ "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -112024,11 +118756,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -112056,7 +118794,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -112066,7 +118807,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -112099,12 +118843,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -112139,24 +118889,36 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
@@ -112205,7 +118967,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -112223,7 +118988,10 @@
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -112241,7 +119009,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -112252,7 +119023,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -112267,7 +119041,10 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "configuration_item_params",
@@ -112277,18 +119054,27 @@
},
"iterations": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"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`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The account on behalf of which to charge, for each of the associated subscription's invoices.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pause_collection": {
"description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).",
@@ -112307,7 +119093,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"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`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -112316,7 +119105,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"anyOf": [
@@ -112332,14 +119124,20 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase."
+ "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -112350,11 +119148,17 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_continuation": {
"description": "Specify trial behavior when crossing phase boundaries",
@@ -112362,7 +119166,10 @@
"continue",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"anyOf": [
@@ -112378,7 +119185,10 @@
"type": "string"
}
],
- "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`"
+ "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`",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -112392,15 +119202,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -112409,7 +119228,10 @@
"title": "phase_configuration_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"anyOf": [
@@ -112431,7 +119253,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -112456,12 +119281,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of several ways to pass the `bill_until` value.",
@@ -112478,11 +119309,17 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"iterations": {
"description": "This is used to determine the number of billing cycles to prebill.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "prebilling_params",
@@ -112497,7 +119334,10 @@
"type": "string"
}
],
- "description": "Provide any time periods to bill in advance."
+ "description": "Provide any time periods to bill in advance.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.",
@@ -112506,7 +119346,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "schedule_details_params",
@@ -112515,7 +119358,10 @@
"subscription": {
"description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_details": {
"description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.",
@@ -112535,7 +119381,10 @@
"type": "integer"
}
],
- "description": "For new subscriptions, 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. For existing subscriptions, the value can only be set to `now` or `unchanged`."
+ "description": "For new subscriptions, 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. For existing subscriptions, the value can only be set to `now` or `unchanged`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_at": {
"anyOf": [
@@ -112550,15 +119399,24 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_at_period_end": {
"description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_now": {
"description": "This simulates the subscription being canceled or expired immediately.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -112576,7 +119434,10 @@
"type": "string"
}
],
- "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set."
+ "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "A list of up to 20 subscription items, each with an attached price.",
@@ -112604,15 +119465,24 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"clear_usage": {
"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`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deleted": {
"description": "A flag that, if set to `true`, will delete the specified item.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -112622,7 +119492,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -112655,12 +119528,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -112695,12 +119574,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "Subscription item to update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -112717,17 +119602,26 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "Plan ID for this item, as a string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -112776,7 +119670,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -112794,7 +119691,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -112812,13 +119712,19 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_item_update_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"description": "The pre-billing to apply to the subscription as a preview.",
@@ -112832,7 +119738,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/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. The default value is `create_prorations`.",
@@ -112841,12 +119750,18 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_date": {
"description": "If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"resume_at": {
"description": "For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.",
@@ -112854,12 +119769,18 @@
"now"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"description": "Date a subscription is intended to start (can be future or past).",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"anyOf": [
@@ -112875,7 +119796,10 @@
"type": "integer"
}
],
- "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required."
+ "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_details_params",
@@ -112938,7 +119862,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -112949,7 +119876,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -113067,7 +119997,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -113082,7 +120015,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -113121,7 +120057,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -113140,32 +120079,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -113178,7 +120135,10 @@
"type": "string"
}
],
- "description": "The customer's address."
+ "description": "The customer's address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"anyOf": [
@@ -113190,32 +120150,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -113229,7 +120207,10 @@
"phone": {
"description": "Customer phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -113246,7 +120227,10 @@
"type": "string"
}
],
- "description": "The customer's shipping information. Appears on invoices emailed to this customer."
+ "description": "The customer's shipping information. Appears on invoices emailed to this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Tax details about the customer.",
@@ -113263,11 +120247,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -113277,14 +120267,17 @@
"none",
"reverse"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_ids": {
"description": "The customer's tax IDs.",
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -113318,6 +120311,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -113376,7 +120370,10 @@
"title": "data_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_details_param",
@@ -113398,7 +120395,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -113431,12 +120431,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -113500,20 +120506,32 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of previewed invoice item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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). Only applicable to new invoice items.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -113523,7 +120541,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -113556,12 +120577,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -113596,12 +120623,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the invoice item in the preview."
+ "description": "The coupons to redeem into discounts for the invoice item in the preview.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoiceitem": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -113618,7 +120651,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"period": {
"description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
@@ -113639,12 +120675,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -113669,7 +120711,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -113686,7 +120731,10 @@
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -113695,7 +120743,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
"anyOf": [
@@ -113709,7 +120760,10 @@
"type": "string"
}
],
- "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -113727,16 +120781,25 @@
"type": "string"
}
],
- "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item."
+ "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_item_preview_params",
@@ -113756,7 +120819,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -113849,7 +120915,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -113874,12 +120943,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_end`.",
@@ -113899,7 +120974,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -113916,7 +120994,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -113931,12 +121012,18 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_start`.",
@@ -113965,7 +121052,10 @@
"amendment_start",
"automatic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_actions": {
"description": "Changes to the coupons being redeemed or discounts being applied during the amendment time span.",
@@ -113977,12 +121067,18 @@
"coupon": {
"description": "The coupon code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount for a coupon that was already redeemed.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Details to determine how long the discount should be applied for.",
@@ -113999,20 +121095,32 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The promotion code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the discount to remove.",
@@ -114020,21 +121128,33 @@
"coupon": {
"description": "The coupon code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "The ID of a discount to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -114042,21 +121162,33 @@
"coupon": {
"description": "The coupon code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "An ID of an existing promotion code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of discount action.",
@@ -114074,7 +121206,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"item_actions": {
"description": "Changes to the subscription items during the amendment time span.",
@@ -114090,7 +121225,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -114123,12 +121261,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -114154,14 +121298,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -114170,7 +121320,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
@@ -114178,7 +121331,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -114189,7 +121345,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -114204,14 +121363,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the subscription item to remove.",
@@ -114226,7 +121391,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
@@ -114238,7 +121406,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -114271,12 +121442,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -114302,14 +121479,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -114318,7 +121501,10 @@
},
"quantity": {
"description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.",
@@ -114326,7 +121512,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.",
@@ -114337,7 +121526,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -114352,14 +121544,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of item action.",
@@ -114377,7 +121575,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata_actions": {
"description": "Instructions for how to modify phase metadata",
@@ -114388,7 +121589,10 @@
"type": "string"
},
"description": "Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Keys to remove from schedule phase metadata.",
@@ -114396,7 +121600,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"anyOf": [
@@ -114413,7 +121620,10 @@
"type": "string"
}
],
- "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten."
+ "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to update phase-level `metadata` on subscription schedules.",
@@ -114431,7 +121641,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.",
@@ -114440,7 +121653,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_pause_collection": {
"description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.",
@@ -114462,7 +121678,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -114477,7 +121696,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -114485,7 +121707,10 @@
"amendment_end",
"amendment_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -114499,15 +121724,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -114516,7 +121750,10 @@
"title": "amendment_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -114524,7 +121761,10 @@
"prorate_on_next_phase",
"prorate_up_front"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
@@ -114532,7 +121772,10 @@
"cancel",
"release"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phases": {
"description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.",
@@ -114549,7 +121792,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -114582,12 +121828,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -114618,7 +121870,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -114642,8 +121897,11 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -114660,7 +121918,10 @@
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -114687,11 +121948,17 @@
"class_name": "AddInvoiceItem"
}
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Automatic tax settings for this phase.",
@@ -114705,7 +121972,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -114720,14 +121990,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"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).",
@@ -114735,7 +122011,10 @@
"automatic",
"phase_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_thresholds": {
"anyOf": [
@@ -114743,11 +122022,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -114760,7 +122045,10 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
@@ -114768,21 +122056,33 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -114800,7 +122100,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -114815,7 +122118,10 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -114825,7 +122131,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -114858,12 +122167,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -114898,7 +122213,10 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
+ "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"anyOf": [
@@ -114914,7 +122232,10 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set."
+ "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -114935,18 +122256,27 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."
+ "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -114961,11 +122291,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -114993,7 +122329,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -115003,7 +122342,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -115036,12 +122378,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -115076,24 +122424,36 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
@@ -115142,7 +122502,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -115160,7 +122523,10 @@
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -115178,7 +122544,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -115189,7 +122558,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -115204,7 +122576,10 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "configuration_item_params",
@@ -115214,18 +122589,27 @@
},
"iterations": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"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`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The account on behalf of which to charge, for each of the associated subscription's invoices.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pause_collection": {
"description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).",
@@ -115244,7 +122628,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"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`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -115253,7 +122640,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"anyOf": [
@@ -115269,14 +122659,20 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase."
+ "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -115287,11 +122683,17 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_continuation": {
"description": "Specify trial behavior when crossing phase boundaries",
@@ -115299,7 +122701,10 @@
"continue",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"anyOf": [
@@ -115315,7 +122720,10 @@
"type": "string"
}
],
- "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`"
+ "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`",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -115329,15 +122737,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -115346,7 +122763,10 @@
"title": "phase_configuration_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"anyOf": [
@@ -115368,7 +122788,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -115393,12 +122816,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of several ways to pass the `bill_until` value.",
@@ -115415,11 +122844,17 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"iterations": {
"description": "This is used to determine the number of billing cycles to prebill.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "prebilling_params",
@@ -115434,7 +122869,10 @@
"type": "string"
}
],
- "description": "Provide any time periods to bill in advance."
+ "description": "Provide any time periods to bill in advance.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.",
@@ -115443,7 +122881,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "schedule_details_params",
@@ -115458,7 +122899,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -115576,7 +123020,10 @@
"type": "integer"
}
],
- "description": "For new subscriptions, 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. For existing subscriptions, the value can only be set to `now` or `unchanged`."
+ "description": "For new subscriptions, 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. For existing subscriptions, the value can only be set to `now` or `unchanged`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_at": {
"anyOf": [
@@ -115591,15 +123038,24 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_at_period_end": {
"description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_now": {
"description": "This simulates the subscription being canceled or expired immediately.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -115617,7 +123073,10 @@
"type": "string"
}
],
- "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set."
+ "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "A list of up to 20 subscription items, each with an attached price.",
@@ -115645,15 +123104,24 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"clear_usage": {
"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`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deleted": {
"description": "A flag that, if set to `true`, will delete the specified item.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -115663,7 +123131,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -115696,12 +123167,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -115736,12 +123213,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "Subscription item to update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -115758,17 +123241,26 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "Plan ID for this item, as a string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -115817,7 +123309,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -115835,7 +123330,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -115853,13 +123351,19 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_item_update_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"description": "The pre-billing to apply to the subscription as a preview.",
@@ -115873,7 +123377,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/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. The default value is `create_prorations`.",
@@ -115882,12 +123389,18 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_date": {
"description": "If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"resume_at": {
"description": "For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.",
@@ -115895,12 +123408,18 @@
"now"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"description": "Date a subscription is intended to start (can be future or past).",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"anyOf": [
@@ -115916,7 +123435,10 @@
"type": "integer"
}
],
- "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required."
+ "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_details_params",
@@ -115955,15 +123477,24 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"clear_usage": {
"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`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deleted": {
"description": "A flag that, if set to `true`, will delete the specified item.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -115973,7 +123504,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -116006,12 +123540,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -116046,12 +123586,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "Subscription item to update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -116068,17 +123614,26 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "Plan ID for this item, as a string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -116127,7 +123682,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -116145,7 +123703,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -116163,7 +123724,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_item_update_params",
@@ -116338,7 +123902,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -116353,7 +123920,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -116392,7 +123962,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -116411,32 +123984,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -116449,7 +124040,10 @@
"type": "string"
}
],
- "description": "The customer's address."
+ "description": "The customer's address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"anyOf": [
@@ -116461,32 +124055,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -116500,7 +124112,10 @@
"phone": {
"description": "Customer phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -116517,7 +124132,10 @@
"type": "string"
}
],
- "description": "The customer's shipping information. Appears on invoices emailed to this customer."
+ "description": "The customer's shipping information. Appears on invoices emailed to this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Tax details about the customer.",
@@ -116534,11 +124152,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_exempt": {
"description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
@@ -116548,14 +124172,17 @@
"none",
"reverse"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_ids": {
"description": "The customer's tax IDs.",
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -116589,6 +124216,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -116647,7 +124275,10 @@
"title": "data_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_details_param",
@@ -116669,7 +124300,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -116702,12 +124336,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -116782,20 +124422,32 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of previewed invoice item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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). Only applicable to new invoice items.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -116805,7 +124457,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -116838,12 +124493,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -116878,12 +124539,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the invoice item in the preview."
+ "description": "The coupons to redeem into discounts for the invoice item in the preview.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoiceitem": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -116900,7 +124567,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"period": {
"description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
@@ -116921,12 +124591,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -116951,7 +124627,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -116968,7 +124647,10 @@
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the invoice item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -116977,7 +124659,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
"anyOf": [
@@ -116991,7 +124676,10 @@
"type": "string"
}
],
- "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -117009,16 +124697,25 @@
"type": "string"
}
],
- "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item."
+ "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_item_preview_params",
@@ -117038,7 +124735,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -117141,7 +124841,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -117166,12 +124869,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_end`.",
@@ -117191,7 +124900,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -117208,7 +124920,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -117223,12 +124938,18 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_start`.",
@@ -117257,7 +124978,10 @@
"amendment_start",
"automatic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_actions": {
"description": "Changes to the coupons being redeemed or discounts being applied during the amendment time span.",
@@ -117269,12 +124993,18 @@
"coupon": {
"description": "The coupon code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount for a coupon that was already redeemed.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Details to determine how long the discount should be applied for.",
@@ -117291,20 +125021,32 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The promotion code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the discount to remove.",
@@ -117312,21 +125054,33 @@
"coupon": {
"description": "The coupon code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "The ID of a discount to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -117334,21 +125088,33 @@
"coupon": {
"description": "The coupon code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "An ID of an existing promotion code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of discount action.",
@@ -117366,7 +125132,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"item_actions": {
"description": "Changes to the subscription items during the amendment time span.",
@@ -117382,7 +125151,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -117415,12 +125187,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -117446,14 +125224,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -117462,7 +125246,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
@@ -117470,7 +125257,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -117481,7 +125271,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -117496,14 +125289,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the subscription item to remove.",
@@ -117518,7 +125317,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
@@ -117530,7 +125332,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -117563,12 +125368,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -117594,14 +125405,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -117610,7 +125427,10 @@
},
"quantity": {
"description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.",
@@ -117618,7 +125438,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.",
@@ -117629,7 +125452,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -117644,14 +125470,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of item action.",
@@ -117669,7 +125501,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata_actions": {
"description": "Instructions for how to modify phase metadata",
@@ -117680,7 +125515,10 @@
"type": "string"
},
"description": "Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Keys to remove from schedule phase metadata.",
@@ -117688,7 +125526,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"anyOf": [
@@ -117705,7 +125546,10 @@
"type": "string"
}
],
- "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten."
+ "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to update phase-level `metadata` on subscription schedules.",
@@ -117723,7 +125567,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.",
@@ -117732,7 +125579,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_pause_collection": {
"description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.",
@@ -117754,7 +125604,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -117769,7 +125622,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -117777,7 +125633,10 @@
"amendment_end",
"amendment_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -117791,15 +125650,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -117808,7 +125676,10 @@
"title": "amendment_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -117816,7 +125687,10 @@
"prorate_on_next_phase",
"prorate_up_front"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
@@ -117824,7 +125698,10 @@
"cancel",
"release"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phases": {
"description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.",
@@ -117841,7 +125718,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -117874,12 +125754,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -117910,7 +125796,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -117934,8 +125823,11 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -117952,7 +125844,10 @@
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -117979,11 +125874,17 @@
"class_name": "AddInvoiceItem"
}
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Automatic tax settings for this phase.",
@@ -117997,7 +125898,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -118012,14 +125916,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"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).",
@@ -118027,7 +125937,10 @@
"automatic",
"phase_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_thresholds": {
"anyOf": [
@@ -118035,11 +125948,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -118052,7 +125971,10 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
@@ -118060,21 +125982,33 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -118092,7 +126026,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -118107,7 +126044,10 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -118117,7 +126057,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -118150,12 +126093,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -118190,7 +126139,10 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
+ "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"anyOf": [
@@ -118206,7 +126158,10 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set."
+ "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -118227,18 +126182,27 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."
+ "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -118253,11 +126217,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -118285,7 +126255,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -118295,7 +126268,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -118328,12 +126304,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -118368,24 +126350,36 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
@@ -118434,7 +126428,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -118452,7 +126449,10 @@
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -118470,7 +126470,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -118481,7 +126484,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -118496,7 +126502,10 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "configuration_item_params",
@@ -118506,18 +126515,27 @@
},
"iterations": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"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`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The account on behalf of which to charge, for each of the associated subscription's invoices.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pause_collection": {
"description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).",
@@ -118536,7 +126554,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"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`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -118545,7 +126566,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"anyOf": [
@@ -118561,14 +126585,20 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase."
+ "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -118579,11 +126609,17 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_continuation": {
"description": "Specify trial behavior when crossing phase boundaries",
@@ -118591,7 +126627,10 @@
"continue",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"anyOf": [
@@ -118607,7 +126646,10 @@
"type": "string"
}
],
- "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`"
+ "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`",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -118621,15 +126663,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -118638,7 +126689,10 @@
"title": "phase_configuration_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"anyOf": [
@@ -118660,7 +126714,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -118685,12 +126742,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of several ways to pass the `bill_until` value.",
@@ -118707,11 +126770,17 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"iterations": {
"description": "This is used to determine the number of billing cycles to prebill.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "prebilling_params",
@@ -118726,7 +126795,10 @@
"type": "string"
}
],
- "description": "Provide any time periods to bill in advance."
+ "description": "Provide any time periods to bill in advance.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.",
@@ -118735,7 +126807,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "schedule_details_params",
@@ -118761,7 +126836,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -118879,7 +126957,10 @@
"type": "integer"
}
],
- "description": "For new subscriptions, 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. For existing subscriptions, the value can only be set to `now` or `unchanged`."
+ "description": "For new subscriptions, 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. For existing subscriptions, the value can only be set to `now` or `unchanged`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_at": {
"anyOf": [
@@ -118894,15 +126975,24 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_at_period_end": {
"description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_now": {
"description": "This simulates the subscription being canceled or expired immediately.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -118920,7 +127010,10 @@
"type": "string"
}
],
- "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set."
+ "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "A list of up to 20 subscription items, each with an attached price.",
@@ -118948,15 +127041,24 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"clear_usage": {
"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`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deleted": {
"description": "A flag that, if set to `true`, will delete the specified item.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -118966,7 +127068,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -118999,12 +127104,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -119039,12 +127150,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "Subscription item to update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -119061,17 +127178,26 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "Plan ID for this item, as a string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -119120,7 +127246,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -119138,7 +127267,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -119156,13 +127288,19 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_item_update_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"description": "The pre-billing to apply to the subscription as a preview.",
@@ -119176,7 +127314,10 @@
"iterations"
],
"title": "prebilling_preview_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/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. The default value is `create_prorations`.",
@@ -119185,12 +127326,18 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_date": {
"description": "If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"resume_at": {
"description": "For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.",
@@ -119198,12 +127345,18 @@
"now"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"description": "Date a subscription is intended to start (can be future or past).",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"anyOf": [
@@ -119219,7 +127372,10 @@
"type": "integer"
}
],
- "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required."
+ "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_details_params",
@@ -119258,15 +127414,24 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"clear_usage": {
"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`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deleted": {
"description": "A flag that, if set to `true`, will delete the specified item.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -119276,7 +127441,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -119309,12 +127477,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -119349,12 +127523,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "Subscription item to update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -119371,17 +127551,26 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "Plan ID for this item, as a string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -119430,7 +127619,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -119448,7 +127640,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -119466,7 +127661,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_item_update_params",
@@ -119901,7 +128099,10 @@
},
"days_until_due": {
"description": "Number of days from when invoice is finalized until the payment is due.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
@@ -119911,7 +128112,10 @@
"due_date": {
"description": "Date on which a payment plan’s payment is due.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -119938,7 +128142,10 @@
},
"auto_advance": {
"description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Settings for automatic tax lookup for this invoice.",
@@ -119952,7 +128159,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -119967,7 +128177,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -119982,7 +128195,10 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"custom_fields": {
"anyOf": [
@@ -120081,7 +128297,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.",
"maxLength": 1500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -120091,7 +128310,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -120124,12 +128346,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -120204,7 +128432,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -120283,7 +128514,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_options": {
"description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.",
@@ -120301,11 +128535,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -120315,7 +128555,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -120328,7 +128571,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -120342,7 +128588,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -120355,7 +128604,10 @@
"type": "string"
}
],
- "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -120366,7 +128618,10 @@
"properties": {
"enabled": {
"description": "Setting to true enables installments for this invoice.\nSetting to false will prevent any selected plan from applying to a payment.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"anyOf": [
@@ -120374,14 +128629,20 @@
"properties": {
"count": {
"description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
"enum": [
"month"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of installment plan, one of `fixed_count`.",
@@ -120405,11 +128666,17 @@
"type": "string"
}
],
- "description": "The selected installment plan to use for this invoice."
+ "description": "The selected installment plan to use for this invoice.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -120418,7 +128685,10 @@
"automatic",
"challenge"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -120431,7 +128701,10 @@
"type": "string"
}
],
- "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -120453,19 +128726,31 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -120478,7 +128763,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"anyOf": [
@@ -120494,7 +128782,10 @@
"type": "string"
}
],
- "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -120510,7 +128801,10 @@
"type": "string"
}
],
- "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"anyOf": [
@@ -120531,16 +128825,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -120555,7 +128858,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -120568,11 +128874,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -120582,7 +128894,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -120595,11 +128910,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_types": {
"anyOf": [
@@ -120649,7 +128970,10 @@
"type": "string"
}
],
- "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)."
+ "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).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_settings",
@@ -120665,7 +128989,10 @@
"exclude_tax",
"include_inclusive_tax"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pdf": {
"description": "Invoice pdf rendering options",
@@ -120677,11 +129004,17 @@
"auto",
"letter"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rendering_pdf_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rendering_param",
@@ -120694,7 +129027,10 @@
"shipping_rate": {
"description": "The ID of the shipping rate to use for this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_rate_data": {
"description": "Parameters to create a new ad-hoc shipping rate for this order.",
@@ -120726,7 +129062,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -120752,7 +129091,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_estimate",
@@ -120788,7 +129130,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -120798,7 +129143,10 @@
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -120806,14 +129154,20 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
@@ -120833,14 +129187,20 @@
"enum": [
"fixed_amount"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_cost",
@@ -120865,32 +129225,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -120914,7 +129292,10 @@
"type": "string"
}
],
- "description": "Recipient phone (including extension)"
+ "description": "Recipient phone (including extension)",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -120944,7 +129325,10 @@
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -121064,12 +129448,18 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.",
@@ -121083,7 +129473,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -121116,12 +129509,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -121161,7 +129560,10 @@
"invoice_item": {
"description": "ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"margins": {
"anyOf": [
@@ -121196,7 +129598,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"period": {
"description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
@@ -121217,12 +129622,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -121234,7 +129645,10 @@
"product": {
"description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_data": {
"description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.",
@@ -121242,21 +129656,30 @@
"description": {
"description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"images": {
"description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -121266,7 +129689,10 @@
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -121286,7 +129712,10 @@
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -121302,7 +129731,10 @@
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the line item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_amounts": {
"anyOf": [
@@ -121319,12 +129751,18 @@
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"display_name": {
"description": "The display name of the tax rate, which will be shown to users.",
@@ -121338,7 +129776,10 @@
"jurisdiction": {
"description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentage": {
"description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.",
@@ -121347,7 +129788,10 @@
"state": {
"description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_type": {
"description": "The high-level tax type, such as `vat` or `sales_tax`.",
@@ -121366,7 +129810,10 @@
"vat"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -121493,7 +129940,10 @@
"properties": {
"amount_requested": {
"description": "The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -121544,7 +129994,10 @@
"payment_reference": {
"description": "The reference for this out of band payment record.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -121553,12 +130006,18 @@
"money_movement_type"
],
"title": "out_of_band_payment",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_intent": {
"description": "The ID of the PaymentIntent to attach to the invoice.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -121621,7 +130080,10 @@
"properties": {
"amount_requested": {
"description": "The portion of the PaymentIntent’s `amount` that should be applied to thisinvoice. Defaults to the entire amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -121700,7 +130162,10 @@
"properties": {
"auto_advance": {
"description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -121947,12 +130412,18 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.",
@@ -121966,7 +130437,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -121999,12 +130473,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -122103,12 +130583,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -122120,7 +130606,10 @@
"product": {
"description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_data": {
"description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.",
@@ -122128,21 +130617,30 @@
"description": {
"description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"images": {
"description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -122152,7 +130650,10 @@
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -122172,7 +130673,10 @@
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -122188,7 +130692,10 @@
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the line item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_amounts": {
"anyOf": [
@@ -122205,12 +130712,18 @@
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"display_name": {
"description": "The display name of the tax rate, which will be shown to users.",
@@ -122224,7 +130737,10 @@
"jurisdiction": {
"description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentage": {
"description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.",
@@ -122233,7 +130749,10 @@
"state": {
"description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_type": {
"description": "The high-level tax type, such as `vat` or `sales_tax`.",
@@ -122252,7 +130771,10 @@
"vat"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -122981,12 +131503,18 @@
"properties": {
"amount": {
"description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discountable": {
"description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.",
@@ -123000,7 +131528,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -123033,12 +131564,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -123113,7 +131650,10 @@
"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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data."
+ "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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"period": {
"description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
@@ -123134,12 +131674,18 @@
"start"
],
"title": "period",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -123151,7 +131697,10 @@
"product": {
"description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_data": {
"description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.",
@@ -123159,21 +131708,30 @@
"description": {
"description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"images": {
"description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -123183,7 +131741,10 @@
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -123203,7 +131764,10 @@
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -123219,7 +131783,10 @@
},
"quantity": {
"description": "Non-negative integer. The quantity of units for the line item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_amounts": {
"anyOf": [
@@ -123236,12 +131803,18 @@
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"display_name": {
"description": "The display name of the tax rate, which will be shown to users.",
@@ -123255,7 +131828,10 @@
"jurisdiction": {
"description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentage": {
"description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.",
@@ -123264,7 +131840,10 @@
"state": {
"description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_type": {
"description": "The high-level tax type, such as `vat` or `sales_tax`.",
@@ -123283,7 +131862,10 @@
"vat"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -123458,7 +132040,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -123469,7 +132054,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -123485,19 +132073,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -123568,7 +132168,10 @@
"pending",
"reversed"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -123835,7 +132438,10 @@
"properties": {
"amount": {
"description": "If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -123999,19 +132605,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -124257,7 +132875,10 @@
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
@@ -124267,7 +132888,10 @@
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -124292,7 +132916,10 @@
"tax_id": {
"description": "The entity's business ID number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "company_param",
@@ -124300,7 +132927,10 @@
},
"email": {
"description": "The cardholder's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -124322,11 +132952,17 @@
"date": {
"description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -124341,15 +132977,24 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms."
+ "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "terms_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_issuing_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dob": {
"description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.",
@@ -124373,15 +133018,24 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name": {
"description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name": {
"description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "Government-issued ID document for this cardholder.",
@@ -124392,20 +133046,32 @@
"back": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_param",
@@ -124416,7 +133082,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.",
@@ -124424,7 +133093,10 @@
},
"phone_number": {
"description": "The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.\n While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locales": {
"description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.",
@@ -124746,7 +133418,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"allowed_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.",
@@ -124754,7 +133429,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_categories": {
"description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.",
@@ -125059,7 +133737,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.",
@@ -125067,7 +133748,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"spending_limits": {
"description": "Limit spending with amount-based rules that apply across this cardholder's cards.",
@@ -125380,7 +134064,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Interval (or event) to which the amount applies.",
@@ -125402,11 +134089,17 @@
"title": "spending_limits_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"spending_limits_currency": {
"description": "Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "authorization_controls_param_v2",
@@ -125606,7 +134299,10 @@
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
@@ -125616,7 +134312,10 @@
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -125633,7 +134332,10 @@
"address"
],
"title": "billing_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "Additional information about a `company` cardholder.",
@@ -125641,7 +134343,10 @@
"tax_id": {
"description": "The entity's business ID number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "company_param",
@@ -125649,7 +134354,10 @@
},
"email": {
"description": "The cardholder's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -125671,11 +134379,17 @@
"date": {
"description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -125690,15 +134404,24 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms."
+ "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "terms_acceptance_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_issuing_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dob": {
"description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.",
@@ -125722,15 +134445,24 @@
"year"
],
"title": "date_of_birth_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name": {
"description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name": {
"description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "Government-issued ID document for this cardholder.",
@@ -125741,20 +134473,32 @@
"back": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_param",
@@ -125765,11 +134509,17 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone_number": {
"description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locales": {
"description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.",
@@ -126091,7 +134841,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"allowed_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.",
@@ -126099,7 +134852,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_categories": {
"description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.",
@@ -126404,7 +135160,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.",
@@ -126412,7 +135171,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"spending_limits": {
"description": "Limit spending with amount-based rules that apply across this cardholder's cards.",
@@ -126725,7 +135487,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Interval (or event) to which the amount applies.",
@@ -126747,11 +135512,17 @@
"title": "spending_limits_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"spending_limits_currency": {
"description": "Currency of amounts within `spending_limits`. Defaults to your merchant country's currency.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "authorization_controls_param_v2",
@@ -126808,7 +135579,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -126824,19 +135598,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -126963,7 +135749,10 @@
"physical",
"virtual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -127078,7 +135867,10 @@
"cardholder": {
"description": "The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "The currency for the card.",
@@ -127100,7 +135892,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"personalization_design": {
"description": "The personalization design object belonging to this card.",
@@ -127113,7 +135908,10 @@
"encrypted_number": {
"description": "The card's desired new PIN, encrypted under Stripe's public key.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "encrypted_pin_param",
@@ -127174,7 +135972,10 @@
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
@@ -127184,7 +135985,10 @@
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -127213,7 +136017,10 @@
"mode"
],
"title": "address_validation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customs": {
"description": "Customs information for the shipment.",
@@ -127221,11 +136028,17 @@
"eori_number": {
"description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name printed on the shipping label when shipping the card.",
@@ -127234,11 +136047,17 @@
},
"phone_number": {
"description": "Phone number of the recipient of the shipment.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_signature": {
"description": "Whether a signature is required for card delivery.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service": {
"description": "Shipment service.",
@@ -127248,7 +136067,10 @@
"standard"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Packaging options.",
@@ -127256,7 +136078,10 @@
"bulk",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -127572,7 +136397,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"allowed_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.",
@@ -127580,7 +136408,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_categories": {
"description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.",
@@ -127885,7 +136716,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.",
@@ -127893,7 +136727,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"spending_limits": {
"description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).",
@@ -128206,7 +137043,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Interval (or event) to which the amount applies.",
@@ -128228,7 +137068,10 @@
"title": "spending_limits_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "authorization_controls_param",
@@ -128240,7 +137083,10 @@
"active",
"inactive"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of card to issue. Possible values are `physical` or `virtual`.",
@@ -128402,7 +137248,10 @@
"stolen"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -128439,7 +137288,10 @@
"encrypted_number": {
"description": "The card's desired new PIN, encrypted under Stripe's public key.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "encrypted_pin_param",
@@ -128469,7 +137321,10 @@
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
@@ -128479,7 +137334,10 @@
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -128508,7 +137366,10 @@
"mode"
],
"title": "address_validation_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customs": {
"description": "Customs information for the shipment.",
@@ -128516,11 +137377,17 @@
"eori_number": {
"description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name printed on the shipping label when shipping the card.",
@@ -128529,11 +137396,17 @@
},
"phone_number": {
"description": "Phone number of the recipient of the shipment.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_signature": {
"description": "Whether a signature is required for card delivery.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service": {
"description": "Shipment service.",
@@ -128543,7 +137416,10 @@
"standard"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Packaging options.",
@@ -128551,7 +137427,10 @@
"bulk",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -128867,7 +137746,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"allowed_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.",
@@ -128875,7 +137757,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_categories": {
"description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.",
@@ -129180,7 +138065,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blocked_merchant_countries": {
"description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.",
@@ -129188,7 +138076,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"spending_limits": {
"description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).",
@@ -129501,7 +138392,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Interval (or event) to which the amount applies.",
@@ -129523,7 +138417,10 @@
"title": "spending_limits_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "authorization_controls_param",
@@ -129537,7 +138434,10 @@
"inactive"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -129791,7 +138691,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -129897,14 +138800,20 @@
},
"currency": {
"description": "The currency of the credit approved, will default to the Account's Issuing currency.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"amount"
],
"title": "credit_limit_approved_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"credit_limit_decreased": {
"description": "Details about the credit limit decreased.",
@@ -129915,12 +138824,18 @@
},
"currency": {
"description": "The currency of the credit approved, will default to the Account's Issuing currency.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reason_other_explanation": {
"description": "Details about the `reasons.other` when present.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reasons": {
"description": "List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.",
@@ -130008,7 +138923,10 @@
"reasons"
],
"title": "credit_limit_decreased_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"credit_line_closed": {
"description": "Details about the credit line closed.",
@@ -130016,7 +138934,10 @@
"reason_other_explanation": {
"description": "Details about the `reasons.other` when present.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reasons": {
"description": "List of reasons why the credit line was closed, up to 4 reasons, in order of importance.",
@@ -130103,7 +139024,10 @@
"reasons"
],
"title": "credit_line_closed_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Outcome of the decision.",
@@ -130135,7 +139059,15 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).",
+ "maxLength": 5000,
+ "type": "string"
},
"underwriting_exception": {
"description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.",
@@ -130350,7 +139282,10 @@
"submitted_at"
],
"title": "application_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"credit_user": {
"description": "Information about the company or person applying or holding the account.",
@@ -130370,12 +139305,18 @@
"name"
],
"title": "credit_user_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"decided_at": {
"description": "Date when a decision was made.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"decision": {
"description": "Details about the decision.",
@@ -130386,7 +139327,10 @@
"reason_other_explanation": {
"description": "Details about the `reasons.other` when present.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reasons": {
"description": "List of reasons why the application was rejected, up to 4 reasons, in order of importance.",
@@ -130465,7 +139409,10 @@
"reasons"
],
"title": "application_rejected_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"credit_limit_approved": {
"description": "Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)",
@@ -130476,14 +139423,20 @@
},
"currency": {
"description": "The currency of the credit approved, will default to the Account's Issuing currency.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"amount"
],
"title": "credit_limit_approved_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"credit_limit_decreased": {
"description": "Details about the credit limit decreased.",
@@ -130494,12 +139447,18 @@
},
"currency": {
"description": "The currency of the credit approved, will default to the Account's Issuing currency.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reason_other_explanation": {
"description": "Details about the `reasons.other` when present.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reasons": {
"description": "List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.",
@@ -130587,7 +139546,10 @@
"reasons"
],
"title": "credit_limit_decreased_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"credit_line_closed": {
"description": "Details about the credit line closed.",
@@ -130595,7 +139557,10 @@
"reason_other_explanation": {
"description": "Details about the `reasons.other` when present.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reasons": {
"description": "List of reasons why the credit line was closed, up to 4 reasons, in order of importance.",
@@ -130682,7 +139647,10 @@
"reasons"
],
"title": "credit_line_closed_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Outcome of the decision.",
@@ -130702,7 +139670,10 @@
"type"
],
"title": "correct_decision_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -130717,7 +139688,15 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions). Optional if previously provided and no changes are needed.",
+ "maxLength": 5000,
+ "type": "string"
},
"underwriting_exception": {
"description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.",
@@ -130833,7 +139812,10 @@
"reason_other_explanation": {
"description": "Details about the `reasons.other` when present.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reasons": {
"description": "List of reasons why the application was rejected, up to 4 reasons, in order of importance.",
@@ -130912,7 +139894,10 @@
"reasons"
],
"title": "application_rejected_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"credit_limit_approved": {
"description": "Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)",
@@ -130923,14 +139908,20 @@
},
"currency": {
"description": "The currency of the credit approved, will default to the Account's Issuing currency.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"amount"
],
"title": "credit_limit_approved_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Outcome of the decision.",
@@ -130962,7 +139953,15 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "regulatory_reporting_file": {
+ "description": "File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).",
+ "maxLength": 5000,
+ "type": "string"
},
"underwriting_exception": {
"description": "If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.",
@@ -131045,19 +140044,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -131141,7 +140152,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -131268,7 +140282,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"canceled_at": {
"anyOf": [
@@ -131283,7 +140300,10 @@
"type": "string"
}
],
- "description": "Date when order was canceled."
+ "description": "Date when order was canceled.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_policy_provided": {
"anyOf": [
@@ -131297,7 +140317,10 @@
"type": "string"
}
],
- "description": "Whether the cardholder was provided with a cancellation policy."
+ "description": "Whether the cardholder was provided with a cancellation policy.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_reason": {
"anyOf": [
@@ -131312,7 +140335,10 @@
"type": "string"
}
],
- "description": "Reason for canceling the order."
+ "description": "Reason for canceling the order.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expected_at": {
"anyOf": [
@@ -131327,7 +140353,10 @@
"type": "string"
}
],
- "description": "Date when the cardholder expected to receive the product."
+ "description": "Date when the cardholder expected to receive the product.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131342,7 +140371,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -131357,7 +140389,10 @@
"type": "string"
}
],
- "description": "Description of the merchandise or service that was purchased."
+ "description": "Description of the merchandise or service that was purchased.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -131366,7 +140401,10 @@
"merchandise",
"service"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_status": {
"description": "Result of cardholder's attempt to return the product.",
@@ -131375,7 +140413,10 @@
"merchant_rejected",
"successful"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"returned_at": {
"anyOf": [
@@ -131390,7 +140431,10 @@
"type": "string"
}
],
- "description": "Date when the product was returned or attempted to be returned."
+ "description": "Date when the product was returned or attempted to be returned.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "canceled",
@@ -131403,7 +140447,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'canceled'."
+ "description": "Evidence provided when `reason` is 'canceled'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duplicate": {
"anyOf": [
@@ -131421,7 +140468,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_statement": {
"anyOf": [
@@ -131435,7 +140485,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cash_receipt": {
"anyOf": [
@@ -131449,7 +140502,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"check_image": {
"anyOf": [
@@ -131463,7 +140519,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131478,12 +140537,18 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"original_transaction": {
"description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "duplicate",
@@ -131496,7 +140561,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'duplicate'."
+ "description": "Evidence provided when `reason` is 'duplicate'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fraudulent": {
"anyOf": [
@@ -131514,7 +140582,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131529,7 +140600,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fraudulent",
@@ -131542,7 +140616,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'fraudulent'."
+ "description": "Evidence provided when `reason` is 'fraudulent'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"merchandise_not_as_described": {
"anyOf": [
@@ -131560,7 +140637,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131575,7 +140655,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"received_at": {
"anyOf": [
@@ -131590,7 +140673,10 @@
"type": "string"
}
],
- "description": "Date when the product was received."
+ "description": "Date when the product was received.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_description": {
"anyOf": [
@@ -131605,7 +140691,10 @@
"type": "string"
}
],
- "description": "Description of the cardholder's attempt to return the product."
+ "description": "Description of the cardholder's attempt to return the product.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_status": {
"description": "Result of cardholder's attempt to return the product.",
@@ -131614,7 +140703,10 @@
"merchant_rejected",
"successful"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"returned_at": {
"anyOf": [
@@ -131629,7 +140721,10 @@
"type": "string"
}
],
- "description": "Date when the product was returned or attempted to be returned."
+ "description": "Date when the product was returned or attempted to be returned.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "merchandise_not_as_described",
@@ -131642,7 +140737,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'merchandise_not_as_described'."
+ "description": "Evidence provided when `reason` is 'merchandise_not_as_described'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_valid_authorization": {
"anyOf": [
@@ -131660,7 +140758,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131675,7 +140776,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "no_valid_authorization",
@@ -131688,7 +140792,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'no_valid_authorization'."
+ "description": "Evidence provided when `reason` is 'no_valid_authorization'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"not_received": {
"anyOf": [
@@ -131706,7 +140813,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expected_at": {
"anyOf": [
@@ -131721,7 +140831,10 @@
"type": "string"
}
],
- "description": "Date when the cardholder expected to receive the product."
+ "description": "Date when the cardholder expected to receive the product.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131736,7 +140849,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -131751,7 +140867,10 @@
"type": "string"
}
],
- "description": "Description of the merchandise or service that was purchased."
+ "description": "Description of the merchandise or service that was purchased.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -131760,7 +140879,10 @@
"merchandise",
"service"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "not_received",
@@ -131773,7 +140895,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'not_received'."
+ "description": "Evidence provided when `reason` is 'not_received'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"other": {
"anyOf": [
@@ -131791,7 +140916,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131806,7 +140934,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -131821,7 +140952,10 @@
"type": "string"
}
],
- "description": "Description of the merchandise or service that was purchased."
+ "description": "Description of the merchandise or service that was purchased.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -131830,7 +140964,10 @@
"merchandise",
"service"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "other",
@@ -131843,7 +140980,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'other'."
+ "description": "Evidence provided when `reason` is 'other'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reason": {
"description": "The reason for filing the dispute. The evidence should be submitted in the field of the same name.",
@@ -131858,7 +140998,10 @@
"service_not_as_described"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_not_as_described": {
"anyOf": [
@@ -131876,7 +141019,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"canceled_at": {
"anyOf": [
@@ -131891,7 +141037,10 @@
"type": "string"
}
],
- "description": "Date when order was canceled."
+ "description": "Date when order was canceled.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_reason": {
"anyOf": [
@@ -131906,7 +141055,10 @@
"type": "string"
}
],
- "description": "Reason for canceling the order."
+ "description": "Reason for canceling the order.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -131921,7 +141073,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"received_at": {
"anyOf": [
@@ -131936,7 +141091,10 @@
"type": "string"
}
],
- "description": "Date when the product was received."
+ "description": "Date when the product was received.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "service_not_as_described",
@@ -131949,11 +141107,17 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'service_not_as_described'."
+ "description": "Evidence provided when `reason` is 'service_not_as_described'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "evidence_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -131968,12 +141132,18 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction": {
"description": "The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"treasury": {
"description": "Params for disputes related to Treasury FinancialAccounts",
@@ -132146,7 +141316,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"canceled_at": {
"anyOf": [
@@ -132161,7 +141334,10 @@
"type": "string"
}
],
- "description": "Date when order was canceled."
+ "description": "Date when order was canceled.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_policy_provided": {
"anyOf": [
@@ -132175,7 +141351,10 @@
"type": "string"
}
],
- "description": "Whether the cardholder was provided with a cancellation policy."
+ "description": "Whether the cardholder was provided with a cancellation policy.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_reason": {
"anyOf": [
@@ -132190,7 +141369,10 @@
"type": "string"
}
],
- "description": "Reason for canceling the order."
+ "description": "Reason for canceling the order.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expected_at": {
"anyOf": [
@@ -132205,7 +141387,10 @@
"type": "string"
}
],
- "description": "Date when the cardholder expected to receive the product."
+ "description": "Date when the cardholder expected to receive the product.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132220,7 +141405,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -132235,7 +141423,10 @@
"type": "string"
}
],
- "description": "Description of the merchandise or service that was purchased."
+ "description": "Description of the merchandise or service that was purchased.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -132244,7 +141435,10 @@
"merchandise",
"service"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_status": {
"description": "Result of cardholder's attempt to return the product.",
@@ -132253,7 +141447,10 @@
"merchant_rejected",
"successful"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"returned_at": {
"anyOf": [
@@ -132268,7 +141465,10 @@
"type": "string"
}
],
- "description": "Date when the product was returned or attempted to be returned."
+ "description": "Date when the product was returned or attempted to be returned.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "canceled",
@@ -132281,7 +141481,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'canceled'."
+ "description": "Evidence provided when `reason` is 'canceled'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duplicate": {
"anyOf": [
@@ -132299,7 +141502,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_statement": {
"anyOf": [
@@ -132313,7 +141519,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cash_receipt": {
"anyOf": [
@@ -132327,7 +141536,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"check_image": {
"anyOf": [
@@ -132341,7 +141553,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132356,12 +141571,18 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"original_transaction": {
"description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "duplicate",
@@ -132374,7 +141595,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'duplicate'."
+ "description": "Evidence provided when `reason` is 'duplicate'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fraudulent": {
"anyOf": [
@@ -132392,7 +141616,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132407,7 +141634,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fraudulent",
@@ -132420,7 +141650,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'fraudulent'."
+ "description": "Evidence provided when `reason` is 'fraudulent'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"merchandise_not_as_described": {
"anyOf": [
@@ -132438,7 +141671,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132453,7 +141689,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"received_at": {
"anyOf": [
@@ -132468,7 +141707,10 @@
"type": "string"
}
],
- "description": "Date when the product was received."
+ "description": "Date when the product was received.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_description": {
"anyOf": [
@@ -132483,7 +141725,10 @@
"type": "string"
}
],
- "description": "Description of the cardholder's attempt to return the product."
+ "description": "Description of the cardholder's attempt to return the product.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_status": {
"description": "Result of cardholder's attempt to return the product.",
@@ -132492,7 +141737,10 @@
"merchant_rejected",
"successful"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"returned_at": {
"anyOf": [
@@ -132507,7 +141755,10 @@
"type": "string"
}
],
- "description": "Date when the product was returned or attempted to be returned."
+ "description": "Date when the product was returned or attempted to be returned.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "merchandise_not_as_described",
@@ -132520,7 +141771,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'merchandise_not_as_described'."
+ "description": "Evidence provided when `reason` is 'merchandise_not_as_described'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_valid_authorization": {
"anyOf": [
@@ -132538,7 +141792,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132553,7 +141810,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "no_valid_authorization",
@@ -132566,7 +141826,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'no_valid_authorization'."
+ "description": "Evidence provided when `reason` is 'no_valid_authorization'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"not_received": {
"anyOf": [
@@ -132584,7 +141847,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expected_at": {
"anyOf": [
@@ -132599,7 +141865,10 @@
"type": "string"
}
],
- "description": "Date when the cardholder expected to receive the product."
+ "description": "Date when the cardholder expected to receive the product.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132614,7 +141883,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -132629,7 +141901,10 @@
"type": "string"
}
],
- "description": "Description of the merchandise or service that was purchased."
+ "description": "Description of the merchandise or service that was purchased.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -132638,7 +141913,10 @@
"merchandise",
"service"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "not_received",
@@ -132651,7 +141929,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'not_received'."
+ "description": "Evidence provided when `reason` is 'not_received'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"other": {
"anyOf": [
@@ -132669,7 +141950,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132684,7 +141968,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -132699,7 +141986,10 @@
"type": "string"
}
],
- "description": "Description of the merchandise or service that was purchased."
+ "description": "Description of the merchandise or service that was purchased.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -132708,7 +141998,10 @@
"merchandise",
"service"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "other",
@@ -132721,7 +142014,10 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'other'."
+ "description": "Evidence provided when `reason` is 'other'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reason": {
"description": "The reason for filing the dispute. The evidence should be submitted in the field of the same name.",
@@ -132736,7 +142032,10 @@
"service_not_as_described"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_not_as_described": {
"anyOf": [
@@ -132754,7 +142053,10 @@
"type": "string"
}
],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"canceled_at": {
"anyOf": [
@@ -132769,7 +142071,10 @@
"type": "string"
}
],
- "description": "Date when order was canceled."
+ "description": "Date when order was canceled.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_reason": {
"anyOf": [
@@ -132784,7 +142089,10 @@
"type": "string"
}
],
- "description": "Reason for canceling the order."
+ "description": "Reason for canceling the order.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"explanation": {
"anyOf": [
@@ -132799,7 +142107,10 @@
"type": "string"
}
],
- "description": "Explanation of why the cardholder is disputing this transaction."
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"received_at": {
"anyOf": [
@@ -132814,7 +142125,10 @@
"type": "string"
}
],
- "description": "Date when the product was received."
+ "description": "Date when the product was received.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "service_not_as_described",
@@ -132827,11 +142141,17 @@
"type": "string"
}
],
- "description": "Evidence provided when `reason` is 'service_not_as_described'."
+ "description": "Evidence provided when `reason` is 'service_not_as_described'.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "evidence_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -133029,7 +142349,10 @@
"maxLength": 200,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -133043,15 +142366,24 @@
"properties": {
"is_default": {
"description": "Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"is_platform_default": {
"description": "Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "preferences_list_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -133078,7 +142410,10 @@
"rejected",
"review"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -133184,7 +142519,10 @@
"properties": {
"card_logo": {
"description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier_text": {
"description": "Hash containing carrier text, for use with physical bundles that support carrier text.",
@@ -133202,7 +142540,10 @@
"type": "string"
}
],
- "description": "The footer body text of the carrier letter."
+ "description": "The footer body text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"footer_title": {
"anyOf": [
@@ -133217,7 +142558,10 @@
"type": "string"
}
],
- "description": "The footer title text of the carrier letter."
+ "description": "The footer title text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"header_body": {
"anyOf": [
@@ -133232,7 +142576,10 @@
"type": "string"
}
],
- "description": "The header body text of the carrier letter."
+ "description": "The header body text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"header_title": {
"anyOf": [
@@ -133247,11 +142594,17 @@
"type": "string"
}
],
- "description": "The header title text of the carrier letter."
+ "description": "The header title text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "carrier_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -133264,19 +142617,28 @@
"lookup_key": {
"description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Friendly display name.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"physical_bundle": {
"description": "The physical bundle object belonging to this personalization design.",
@@ -133295,11 +142657,17 @@
"is_default"
],
"title": "preferences_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_lookup_key": {
"description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -133484,7 +142852,10 @@
"type": "string"
}
],
- "description": "The footer body text of the carrier letter."
+ "description": "The footer body text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"footer_title": {
"anyOf": [
@@ -133499,7 +142870,10 @@
"type": "string"
}
],
- "description": "The footer title text of the carrier letter."
+ "description": "The footer title text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"header_body": {
"anyOf": [
@@ -133514,7 +142888,10 @@
"type": "string"
}
],
- "description": "The header body text of the carrier letter."
+ "description": "The header body text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"header_title": {
"anyOf": [
@@ -133529,7 +142906,10 @@
"type": "string"
}
],
- "description": "The header title text of the carrier letter."
+ "description": "The header title text of the carrier letter.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "carrier_text_param",
@@ -133572,7 +142952,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -133592,7 +142975,10 @@
"physical_bundle": {
"description": "The physical bundle object belonging to this personalization design.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferences": {
"description": "Information on whether this personalization design is used to create cards when one is not specified.",
@@ -133606,11 +142992,17 @@
"is_default"
],
"title": "preferences_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_lookup_key": {
"description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -133706,7 +143098,10 @@
"inactive",
"review"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -133720,7 +143115,10 @@
"custom",
"standard"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -133894,19 +143292,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -133978,7 +143388,10 @@
"requested",
"suspended"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -134212,7 +143625,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -134223,7 +143639,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -134239,19 +143658,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -134632,7 +144063,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -134833,50 +144267,80 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"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\".",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "validated_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "The billing email provided by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The billing name provided by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The billing phone number provided by the customer.",
"maxLength": 20,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details",
@@ -134899,7 +144363,10 @@
"gift_card": {
"description": "The gift card to apply to the order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of credit to apply to the order, only `gift_card` currently supported.",
@@ -134933,12 +144400,18 @@
"customer": {
"description": "The customer associated with this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -134948,7 +144421,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -135004,7 +144480,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -135036,12 +144515,18 @@
"properties": {
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product": {
"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 specified.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -135054,7 +144539,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -135068,7 +144556,10 @@
"product": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_data": {
"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.",
@@ -135125,7 +144616,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -135188,7 +144682,10 @@
"type": "string"
}
],
- "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"anyOf": [
@@ -135214,7 +144711,10 @@
},
"quantity": {
"description": "The quantity of the line item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -135245,7 +144745,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment": {
"description": "Payment information associated with the order, including payment settings.",
@@ -135255,7 +144758,10 @@
"properties": {
"application_fee_amount": {
"description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_options": {
"description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.",
@@ -135278,12 +144784,18 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -135292,7 +144804,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -135300,11 +144815,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135314,7 +144835,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -135324,11 +144848,17 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay": {
"description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.",
@@ -135340,23 +144870,35 @@
"automatic_async",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
"maxLength": 128,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"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`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "afterpay_clearpay_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"alipay": {
"description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.",
@@ -135368,11 +144910,17 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.",
@@ -135385,7 +144933,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135394,11 +144945,17 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.",
@@ -135410,7 +144967,10 @@
"automatic_async",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"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`.",
@@ -135419,11 +144979,17 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"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.",
@@ -135444,7 +145010,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requested_address_types": {
"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`.",
@@ -135461,7 +145030,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"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`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -135480,25 +145052,37 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
"enum": [
"bank_transfer"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal": {
"description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.",
@@ -135510,11 +145094,17 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna": {
"description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.",
@@ -135525,7 +145115,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Klarna authorization page that the customer is redirected to",
@@ -135578,7 +145171,10 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135586,11 +145182,17 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.",
@@ -135601,12 +145203,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135615,29 +145223,44 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.",
"properties": {
"expires_after_days": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24": {
"description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.",
@@ -135647,15 +145270,24 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tos_shown_and_accepted": {
"description": "Confirm that the payer has accepted the P24 terms and conditions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"description": "If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.",
@@ -135666,7 +145298,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.",
@@ -135694,22 +145329,34 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference_id": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"risk_correlation_id": {
"description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.",
"maxLength": 32,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135718,7 +145365,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -135726,11 +145376,17 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"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.",
@@ -135739,7 +145395,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135749,11 +145408,17 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort": {
"description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.",
@@ -135770,7 +145435,10 @@
"nl",
"pl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -135779,11 +145447,17 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"wechat_pay": {
"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.",
@@ -135791,7 +145465,10 @@
"app_id": {
"description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"client": {
"description": "The client type that the end customer will pay from",
@@ -135808,18 +145485,27 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"client"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_types": {
"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).",
@@ -135849,28 +145535,43 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_url": {
"description": "The URL to redirect the customer to after they authenticate their payment.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
"description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "Provides configuration for completing a transfer for the order after it is paid.",
"properties": {
"amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of the Connected account receiving the transfer.",
@@ -135881,7 +145582,10 @@
"destination"
],
"title": "transfer_data",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "create_params",
@@ -135892,7 +145596,10 @@
"settings"
],
"title": "create_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_cost": {
"anyOf": [
@@ -135901,7 +145608,10 @@
"shipping_rate": {
"description": "The ID of the shipping rate to use for this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_rate_data": {
"description": "Parameters to create a new ad-hoc shipping rate for this order.",
@@ -135933,7 +145643,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -135959,7 +145672,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_estimate",
@@ -135995,7 +145711,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -136005,7 +145724,10 @@
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -136013,14 +145735,20 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
@@ -136040,14 +145768,20 @@
"enum": [
"fixed_amount"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_cost",
@@ -136072,32 +145806,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"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\".",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "validated_optional_fields_address",
@@ -136121,7 +145873,10 @@
"type": "string"
}
],
- "description": "The phone number (including extension) for the recipient of the order."
+ "description": "The phone number (including extension) for the recipient of the order.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -136151,14 +145906,17 @@
"none",
"reverse"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_ids": {
"description": "The purchaser's tax IDs to be used for this order.",
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -136192,6 +145950,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -136250,7 +146009,10 @@
"title": "data_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_details",
@@ -136453,50 +146215,80 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"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\".",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "validated_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "The billing email provided by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The billing name provided by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The billing phone number provided by the customer.",
"maxLength": 20,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details",
@@ -136519,7 +146311,10 @@
"gift_card": {
"description": "The gift card to apply to the order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of credit to apply to the order, only `gift_card` currently supported.",
@@ -136548,12 +146343,18 @@
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The customer associated with this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -136578,7 +146379,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -136634,7 +146438,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -136659,7 +146466,10 @@
"id": {
"description": "The ID of an existing line item on the order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"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.",
@@ -136671,12 +146481,18 @@
"properties": {
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product": {
"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 specified.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -136689,7 +146505,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -136703,7 +146522,10 @@
"product": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_data": {
"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.",
@@ -136760,7 +146582,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -136823,7 +146648,10 @@
"type": "string"
}
],
- "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"anyOf": [
@@ -136849,7 +146677,10 @@
},
"quantity": {
"description": "The quantity of the line item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -136873,7 +146704,10 @@
"title": "update_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -136910,7 +146744,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_options": {
"description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.",
@@ -136934,12 +146771,18 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -136948,7 +146791,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -136956,11 +146802,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -136970,7 +146822,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -136980,7 +146835,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -136993,7 +146851,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay": {
"anyOf": [
@@ -137006,19 +146867,28 @@
"automatic_async",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
"maxLength": 128,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"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`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "afterpay_clearpay_payment_method_options_param",
@@ -137031,7 +146901,10 @@
"type": "string"
}
],
- "description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"alipay": {
"anyOf": [
@@ -137044,7 +146917,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137057,7 +146933,10 @@
"type": "string"
}
],
- "description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -137071,7 +146950,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -137080,7 +146962,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137093,7 +146978,10 @@
"type": "string"
}
],
- "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -137106,7 +146994,10 @@
"automatic_async",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"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`.",
@@ -137115,7 +147006,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_payment_method_options",
@@ -137128,7 +147022,10 @@
"type": "string"
}
],
- "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -137150,7 +147047,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requested_address_types": {
"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`.",
@@ -137167,7 +147067,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"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`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -137186,21 +147089,30 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
"enum": [
"bank_transfer"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -137213,7 +147125,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal": {
"anyOf": [
@@ -137226,7 +147141,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137239,7 +147157,10 @@
"type": "string"
}
],
- "description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna": {
"anyOf": [
@@ -137251,7 +147172,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Klarna authorization page that the customer is redirected to",
@@ -137304,7 +147228,10 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -137312,7 +147239,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137325,7 +147255,10 @@
"type": "string"
}
],
- "description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"anyOf": [
@@ -137337,12 +147270,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -137351,7 +147290,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -137364,7 +147306,10 @@
"type": "string"
}
],
- "description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"anyOf": [
@@ -137372,14 +147317,20 @@
"properties": {
"expires_after_days": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137392,7 +147343,10 @@
"type": "string"
}
],
- "description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24": {
"anyOf": [
@@ -137403,11 +147357,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tos_shown_and_accepted": {
"description": "Confirm that the payer has accepted the P24 terms and conditions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137420,7 +147380,10 @@
"type": "string"
}
],
- "description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"anyOf": [
@@ -137432,7 +147395,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.",
@@ -137460,22 +147426,34 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference_id": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"risk_correlation_id": {
"description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.",
"maxLength": 32,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -137484,7 +147462,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -137492,7 +147473,10 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137505,7 +147489,10 @@
"type": "string"
}
],
- "description": "If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -137515,7 +147502,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -137525,7 +147515,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -137538,7 +147531,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort": {
"anyOf": [
@@ -137556,7 +147552,10 @@
"nl",
"pl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -137565,7 +147564,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -137578,7 +147580,10 @@
"type": "string"
}
],
- "description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent."
+ "description": "If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"wechat_pay": {
"anyOf": [
@@ -137587,7 +147592,10 @@
"app_id": {
"description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"client": {
"description": "The client type that the end customer will pay from",
@@ -137604,7 +147612,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -137620,11 +147631,17 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_types": {
"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).",
@@ -137654,7 +147671,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_url": {
"anyOf": [
@@ -137668,17 +147688,26 @@
"type": "string"
}
],
- "description": "The URL to redirect the customer to after they authenticate their payment."
+ "description": "The URL to redirect the customer to after they authenticate their payment.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
"description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"anyOf": [
@@ -137686,7 +147715,10 @@
"properties": {
"amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of the Connected account receiving the transfer.",
@@ -137706,7 +147738,10 @@
"type": "string"
}
],
- "description": "Provides configuration for completing a transfer for the order after it is paid."
+ "description": "Provides configuration for completing a transfer for the order after it is paid.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "update_params",
@@ -137717,7 +147752,10 @@
"settings"
],
"title": "update_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_cost": {
"anyOf": [
@@ -137726,7 +147764,10 @@
"shipping_rate": {
"description": "The ID of the shipping rate to use for this order.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_rate_data": {
"description": "Parameters to create a new ad-hoc shipping rate for this order.",
@@ -137758,7 +147799,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -137784,7 +147828,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_estimate",
@@ -137820,7 +147867,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -137830,7 +147880,10 @@
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -137838,14 +147891,20 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
@@ -137865,14 +147924,20 @@
"enum": [
"fixed_amount"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"display_name"
],
"title": "method_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_cost",
@@ -137897,32 +147962,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"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\".",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "validated_optional_fields_address",
@@ -137946,7 +148029,10 @@
"type": "string"
}
],
- "description": "The phone number (including extension) for the recipient of the order."
+ "description": "The phone number (including extension) for the recipient of the order.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -137976,14 +148062,17 @@
"none",
"reverse"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_ids": {
"description": "The purchaser's tax IDs to be used for this order.",
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -138017,6 +148106,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -138075,7 +148165,10 @@
"title": "data_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tax_details",
@@ -138473,19 +148566,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -138505,7 +148610,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -138729,11 +148837,17 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_param",
@@ -138748,7 +148862,10 @@
"always",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"description": "Whether this feature is enabled.",
@@ -138759,7 +148876,10 @@
"enabled"
],
"title": "automatic_payment_methods_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"capture_method": {
"description": "Controls when the funds will be captured from the customer's account.",
@@ -138772,7 +148892,10 @@
},
"confirm": {
"description": "Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"confirmation_method": {
"description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.",
@@ -138792,14 +148915,20 @@
"type": "string"
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"error_on_requires_action": {
"description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
@@ -138828,13 +148957,19 @@
"accepted_at": {
"description": "The time at which the customer accepted the Mandate.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"offline": {
"description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
"properties": {},
"title": "offline_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"online": {
"description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
@@ -138854,7 +148989,10 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -138893,7 +149031,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"off_session": {
"anyOf": [
@@ -138934,7 +149075,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -138944,27 +149088,42 @@
"car_class_code": {
"description": "Class code of the car.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_make": {
"description": "Make of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_model": {
"description": "Model of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the rental car company.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_service_phone_number": {
"description": "The customer service phone number of the car rental company.",
"maxLength": 16,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_rented": {
"description": "Number of days the car is being rented.",
@@ -138981,7 +149140,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -138989,25 +149151,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -139025,7 +149202,10 @@
"title": "car_rental_driver",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -139039,11 +149219,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep nor cancel their booking.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_address": {
"description": "Car pick-up address.",
@@ -139051,36 +149237,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -139089,7 +149296,10 @@
},
"rate_amount": {
"description": "Rental rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rate_interval": {
"description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`",
@@ -139098,12 +149308,18 @@
"month",
"week"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"renter_name": {
"description": "The name of the person or entity renting the car.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_address": {
"description": "Car return address.",
@@ -139111,36 +149327,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -139149,7 +149386,10 @@
},
"tax_exempt": {
"description": "Indicates whether the goods or services are tax-exempt or tax is not collected.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -139159,14 +149399,20 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"event_details": {
"description": "Event details for this PaymentIntent",
"properties": {
"access_controlled_venue": {
"description": "Indicates if the tickets are digitally checked when entering the venue.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address": {
"description": "The event location's address.",
@@ -139174,36 +149420,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -139218,12 +149485,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the company",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -139236,7 +149509,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -139244,35 +149520,56 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"genre": {
"description": "Type of the event entertainment (concert, sports event etc)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the event.",
@@ -139282,14 +149579,20 @@
"starts_at": {
"description": "Event start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -139307,17 +149610,26 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
"maxLength": 8,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -139330,7 +149642,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -139338,30 +149653,48 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation.",
@@ -139379,7 +149712,10 @@
"title": "flight_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The individual flight segments associated with the trip.",
@@ -139387,22 +149723,34 @@
"properties": {
"amount": {
"description": "The flight segment amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrival_airport": {
"description": "The International Air Transport Association (IATA) airport code for the arrival airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrives_at": {
"description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departs_at": {
"description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.",
@@ -139412,12 +149760,18 @@
"departure_airport": {
"description": "The International Air Transport Association (IATA) airport code for the departure airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number associated with the segment",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The fare class for the segment.",
@@ -139427,7 +149781,10 @@
"first",
"premium_economy"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -139441,14 +149798,20 @@
"ticket_number": {
"description": "The ticket number associated with the travel reservation.",
"maxLength": 14,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -139459,40 +149822,64 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"adults": {
"description": "The number of adults on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -139507,12 +149894,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
"maxLength": 9,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"category": {
"description": "The lodging category",
@@ -139520,7 +149913,10 @@
"hotel",
"vacation_rental"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"checkin_at": {
"description": "Loding check-in time. Measured in seconds since the Unix epoch.",
@@ -139534,11 +149930,17 @@
},
"customer_service_phone_number": {
"description": "The customer service phone number of the lodging company.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"daily_room_rate_amount": {
"description": "The daily lodging room rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -139551,7 +149953,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -139559,25 +149964,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -139592,24 +150012,39 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fire_safety_act_compliance": {
"description": "Indicates whether the lodging location is compliant with the Fire Safety Act.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the lodging location.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number_of_rooms": {
"description": "The number of rooms on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation",
@@ -139627,28 +150062,46 @@
"title": "lodging_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"property_phone_number": {
"description": "The phone number of the lodging location.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_class": {
"description": "The room class for this purchase.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_nights": {
"description": "The number of room nights",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_room_tax_amount": {
"description": "The total tax amount associating with the room reservation.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_tax_amount": {
"description": "The total tax amount",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -139656,7 +150109,10 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -139674,11 +150130,17 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_interval": {
"description": "Subscription billing details for this purchase.",
@@ -139703,12 +150165,18 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the product on subscription. e.g. Apple Music Subscription",
@@ -139718,14 +150186,20 @@
"starts_at": {
"description": "Subscription start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_details",
@@ -139734,7 +150208,10 @@
"payment_method": {
"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 you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_configuration": {
"description": "The ID of the payment method configuration to use with this PaymentIntent.",
@@ -139831,12 +150308,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -139858,32 +150341,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -139896,7 +150397,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -139910,7 +150414,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -139925,7 +150432,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -139940,11 +150450,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -140015,7 +150531,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -140031,7 +150550,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -140106,7 +150628,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -140143,7 +150668,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -140161,12 +150689,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -140220,7 +150757,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -140244,17 +150784,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -140278,7 +150827,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -140396,6 +150948,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -140427,12 +150980,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -140440,17 +150999,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -140497,12 +151065,18 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -140511,7 +151085,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -140519,11 +151096,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140533,7 +151116,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -140543,7 +151129,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -140556,7 +151145,10 @@
"type": "string"
}
],
- "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options."
+ "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affirm": {
"anyOf": [
@@ -140568,19 +151160,28 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Affirm authorization page that the customer is redirected to.",
"maxLength": 30,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -140593,7 +151194,10 @@
"type": "string"
}
],
- "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options."
+ "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay": {
"anyOf": [
@@ -140605,12 +151209,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.",
"maxLength": 128,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140618,7 +151228,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -140631,7 +151244,10 @@
"type": "string"
}
],
- "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options."
+ "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"alipay": {
"anyOf": [
@@ -140644,7 +151260,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -140657,7 +151276,10 @@
"type": "string"
}
],
- "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options."
+ "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay": {
"anyOf": [
@@ -140669,7 +151291,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -140678,7 +151303,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -140691,7 +151319,10 @@
"type": "string"
}
],
- "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options."
+ "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"au_becs_debit": {
"anyOf": [
@@ -140705,7 +151336,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -140718,7 +151352,10 @@
"type": "string"
}
],
- "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options."
+ "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit": {
"anyOf": [
@@ -140728,7 +151365,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140738,7 +151378,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -140751,7 +151394,10 @@
"type": "string"
}
],
- "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options."
+ "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -140765,7 +151411,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140774,7 +151423,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -140787,7 +151439,10 @@
"type": "string"
}
],
- "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options."
+ "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"anyOf": [
@@ -140796,7 +151451,10 @@
"code": {
"description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140805,7 +151463,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -140818,7 +151479,10 @@
"type": "string"
}
],
- "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options."
+ "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"boleto": {
"anyOf": [
@@ -140826,7 +151490,10 @@
"properties": {
"expires_after_days": {
"description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -140836,7 +151503,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -140849,7 +151519,10 @@
"type": "string"
}
],
- "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options."
+ "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -140861,19 +151534,28 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc_token": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"installments": {
"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).",
"properties": {
"enabled": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"anyOf": [
@@ -140881,14 +151563,20 @@
"properties": {
"count": {
"description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
"enum": [
"month"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of installment plan, one of `fixed_count`.",
@@ -140912,11 +151600,17 @@
"type": "string"
}
],
- "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation."
+ "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Configuration options for setting up an eMandate for cards issued in India.",
@@ -140936,12 +151630,18 @@
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"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.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
@@ -140956,7 +151656,10 @@
},
"interval_count": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "Unique identifier for the mandate or subscription.",
@@ -140976,7 +151679,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -140987,11 +151693,17 @@
"start_date"
],
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.",
@@ -141011,7 +151723,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_decremental_authorization": {
"description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.",
@@ -141019,7 +151734,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_extended_authorization": {
"description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
@@ -141027,7 +151745,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_incremental_authorization": {
"description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
@@ -141035,7 +151756,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_multicapture": {
"description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
@@ -141043,7 +151767,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_overcapture": {
"description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
@@ -141051,7 +151778,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -141061,11 +151791,17 @@
"challenge"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_cvc_recollection": {
"description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -141075,7 +151811,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kana": {
"anyOf": [
@@ -141090,7 +151829,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kanji": {
"anyOf": [
@@ -141105,7 +151847,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_details": {
"anyOf": [
@@ -141117,41 +151862,65 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "statement_details_address_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Phone number (e.g., a toll-free number that customers can call)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "statement_details_param",
@@ -141164,7 +151933,10 @@
"type": "string"
}
],
- "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements."
+ "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"three_d_secure": {
"description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.",
@@ -141180,7 +151952,10 @@
"U",
"Y"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cryptogram": {
"description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
@@ -141197,7 +151972,10 @@
"07"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exemption_indicator": {
"description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
@@ -141205,7 +151983,10 @@
"low_risk",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_options": {
"description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
@@ -141228,27 +152009,42 @@
"cb_exemption": {
"description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cb_score": {
"description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_id": {
"description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
@@ -141272,7 +152068,10 @@
"version"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_param",
@@ -141285,7 +152084,10 @@
"type": "string"
}
],
- "description": "Configuration for any card payments attempted on this PaymentIntent."
+ "description": "Configuration for any card payments attempted on this PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_present": {
"anyOf": [
@@ -141293,11 +152095,17 @@
"properties": {
"request_extended_authorization": {
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_incremental_authorization_support": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing": {
"description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.",
@@ -141308,11 +152116,17 @@
"domestic",
"international"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "routing_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141325,7 +152139,10 @@
"type": "string"
}
],
- "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
+ "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cashapp": {
"anyOf": [
@@ -141337,7 +152154,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -141347,7 +152167,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -141360,7 +152183,10 @@
"type": "string"
}
],
- "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options."
+ "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -141382,7 +152208,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requested_address_types": {
"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`.",
@@ -141399,7 +152228,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"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`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -141418,21 +152250,30 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
"enum": [
"bank_transfer"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -141445,7 +152286,10 @@
"type": "string"
}
],
- "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options."
+ "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eps": {
"anyOf": [
@@ -141456,7 +152300,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -141469,7 +152316,10 @@
"type": "string"
}
],
- "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options."
+ "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fpx": {
"anyOf": [
@@ -141480,7 +152330,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141493,7 +152346,10 @@
"type": "string"
}
],
- "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options."
+ "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"giropay": {
"anyOf": [
@@ -141504,7 +152360,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141517,7 +152376,10 @@
"type": "string"
}
],
- "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options."
+ "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"grabpay": {
"anyOf": [
@@ -141528,7 +152390,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141541,7 +152406,10 @@
"type": "string"
}
],
- "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options."
+ "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal": {
"anyOf": [
@@ -141554,7 +152422,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141567,7 +152438,10 @@
"type": "string"
}
],
- "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options."
+ "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interac_present": {
"anyOf": [
@@ -141583,7 +152457,10 @@
"type": "string"
}
],
- "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
+ "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna": {
"anyOf": [
@@ -141595,7 +152472,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Klarna authorization page that the customer is redirected to",
@@ -141648,7 +152528,10 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -141656,7 +152539,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141669,7 +152555,10 @@
"type": "string"
}
],
- "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options."
+ "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"anyOf": [
@@ -141688,7 +152577,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_after_days": {
"anyOf": [
@@ -141702,7 +152594,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_at": {
"anyOf": [
@@ -141717,7 +152612,10 @@
"type": "string"
}
],
- "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
+ "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -141732,14 +152630,20 @@
"type": "string"
}
],
- "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
+ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141752,7 +152656,10 @@
"type": "string"
}
],
- "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options."
+ "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"anyOf": [
@@ -141764,12 +152671,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -141778,7 +152691,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -141791,7 +152707,40 @@
"type": "string"
}
],
- "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
+ "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "mb_way": {
+ "anyOf": [
+ {
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
+ "enum": [
+ "none"
+ ],
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"anyOf": [
@@ -141803,14 +152752,20 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141823,7 +152778,10 @@
"type": "string"
}
],
- "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options."
+ "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"multibanco": {
"anyOf": [
@@ -141834,7 +152792,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141847,7 +152808,10 @@
"type": "string"
}
],
- "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options."
+ "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"anyOf": [
@@ -141855,14 +152819,20 @@
"properties": {
"expires_after_days": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141875,7 +152845,10 @@
"type": "string"
}
],
- "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options."
+ "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24": {
"anyOf": [
@@ -141886,11 +152859,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tos_shown_and_accepted": {
"description": "Confirm that the payer has accepted the P24 terms and conditions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141903,7 +152882,10 @@
"type": "string"
}
],
- "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options."
+ "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paynow": {
"anyOf": [
@@ -141914,7 +152896,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -141927,7 +152912,10 @@
"type": "string"
}
],
- "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options."
+ "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"anyOf": [
@@ -141939,7 +152927,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.",
@@ -141967,22 +152958,34 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference_id": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"risk_correlation_id": {
"description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.",
"maxLength": 32,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -141991,7 +152994,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -141999,7 +153005,10 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142012,7 +153021,10 @@
"type": "string"
}
],
- "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options."
+ "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto": {
"anyOf": [
@@ -142023,7 +153035,10 @@
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
@@ -142031,12 +153046,18 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
@@ -142050,11 +153071,17 @@
"semi_annual",
"weekly"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
@@ -142071,11 +153098,17 @@
"tax",
"utility"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -142084,7 +153117,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -142097,7 +153133,10 @@
"type": "string"
}
],
- "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options."
+ "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pix": {
"anyOf": [
@@ -142105,19 +153144,28 @@
"properties": {
"expires_after_seconds": {
"description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_at": {
"description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142130,7 +153178,10 @@
"type": "string"
}
],
- "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options."
+ "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promptpay": {
"anyOf": [
@@ -142141,7 +153192,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142154,7 +153208,10 @@
"type": "string"
}
],
- "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
+ "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rechnung": {
"anyOf": [
@@ -142170,7 +153227,10 @@
"type": "string"
}
],
- "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options."
+ "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"revolut_pay": {
"anyOf": [
@@ -142182,7 +153242,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -142191,7 +153254,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142204,7 +153270,10 @@
"type": "string"
}
],
- "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options."
+ "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -142214,7 +153283,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -142224,7 +153296,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -142237,7 +153312,10 @@
"type": "string"
}
],
- "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options."
+ "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort": {
"anyOf": [
@@ -142255,7 +153333,10 @@
"nl",
"pl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -142264,7 +153345,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142277,7 +153361,10 @@
"type": "string"
}
],
- "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options."
+ "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"swish": {
"anyOf": [
@@ -142296,14 +153383,20 @@
"type": "string"
}
],
- "description": "The order ID displayed in the Swish app after the payment is authorized."
+ "description": "The order ID displayed in the Swish app after the payment is authorized.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -142316,7 +153409,10 @@
"type": "string"
}
],
- "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options."
+ "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"twint": {
"anyOf": [
@@ -142327,7 +153423,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142340,7 +153439,10 @@
"type": "string"
}
],
- "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options."
+ "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"anyOf": [
@@ -142362,16 +153464,25 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -142389,7 +153500,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -142404,7 +153518,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -142417,16 +153534,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -142438,11 +153564,17 @@
"paper"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Additional fields for network related functions",
@@ -142456,11 +153588,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_settlement_speed": {
"description": "Preferred transaction settlement speed",
@@ -142469,7 +153607,10 @@
"fastest",
"standard"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -142479,7 +153620,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -142489,7 +153633,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -142502,7 +153649,10 @@
"type": "string"
}
],
- "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options."
+ "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"wechat_pay": {
"anyOf": [
@@ -142511,7 +153661,10 @@
"app_id": {
"description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"client": {
"description": "The client type that the end customer will pay from",
@@ -142528,7 +153681,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -142544,7 +153700,10 @@
"type": "string"
}
],
- "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options."
+ "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"zip": {
"anyOf": [
@@ -142555,7 +153714,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142568,7 +153730,10 @@
"type": "string"
}
],
- "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options."
+ "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -142588,7 +153753,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -142596,7 +153764,10 @@
},
"receipt_email": {
"description": "Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_url": {
"description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
@@ -142616,7 +153787,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Shipping information for this PaymentIntent.",
@@ -142627,32 +153801,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -142661,7 +153853,10 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
@@ -142671,12 +153866,18 @@
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -142684,24 +153885,36 @@
"name"
],
"title": "optional_fields_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The parameters that you can use to automatically create a Transfer.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"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.",
@@ -142783,7 +153996,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -142794,7 +154010,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -143041,7 +154260,10 @@
"properties": {
"amount": {
"description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"application_fee_amount": {
"anyOf": [
@@ -143086,11 +154308,17 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_param",
@@ -143107,17 +154335,26 @@
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -143138,12 +154375,18 @@
"properties": {
"ip_address": {
"description": "The IP address from which the Mandate was accepted by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the Mandate was accepted by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "online_param",
@@ -143172,7 +154415,8 @@
"title": "client_key_param",
"type": "object",
"x-stripeParam": {
- "class_name": "MandateDataPublishableKey"
+ "class_name": "MandateDataPublishableKey",
+ "most_common": true
}
},
"metadata": {
@@ -143212,7 +154456,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -143222,27 +154469,42 @@
"car_class_code": {
"description": "Class code of the car.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_make": {
"description": "Make of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_model": {
"description": "Model of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the rental car company.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_service_phone_number": {
"description": "The customer service phone number of the car rental company.",
"maxLength": 16,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_rented": {
"description": "Number of days the car is being rented.",
@@ -143259,7 +154521,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -143267,25 +154532,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -143303,7 +154583,10 @@
"title": "car_rental_driver",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -143317,11 +154600,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep nor cancel their booking.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_address": {
"description": "Car pick-up address.",
@@ -143329,36 +154618,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -143367,7 +154677,10 @@
},
"rate_amount": {
"description": "Rental rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rate_interval": {
"description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`",
@@ -143376,12 +154689,18 @@
"month",
"week"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"renter_name": {
"description": "The name of the person or entity renting the car.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_address": {
"description": "Car return address.",
@@ -143389,36 +154708,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -143427,7 +154767,10 @@
},
"tax_exempt": {
"description": "Indicates whether the goods or services are tax-exempt or tax is not collected.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -143437,14 +154780,20 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"event_details": {
"description": "Event details for this PaymentIntent",
"properties": {
"access_controlled_venue": {
"description": "Indicates if the tickets are digitally checked when entering the venue.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address": {
"description": "The event location's address.",
@@ -143452,36 +154801,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -143496,12 +154866,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the company",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -143514,7 +154890,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -143522,35 +154901,56 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"genre": {
"description": "Type of the event entertainment (concert, sports event etc)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the event.",
@@ -143560,14 +154960,20 @@
"starts_at": {
"description": "Event start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -143585,17 +154991,26 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
"maxLength": 8,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -143608,7 +155023,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -143616,30 +155034,48 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation.",
@@ -143657,7 +155093,10 @@
"title": "flight_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The individual flight segments associated with the trip.",
@@ -143665,22 +155104,34 @@
"properties": {
"amount": {
"description": "The flight segment amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrival_airport": {
"description": "The International Air Transport Association (IATA) airport code for the arrival airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrives_at": {
"description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departs_at": {
"description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.",
@@ -143690,12 +155141,18 @@
"departure_airport": {
"description": "The International Air Transport Association (IATA) airport code for the departure airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number associated with the segment",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The fare class for the segment.",
@@ -143705,7 +155162,10 @@
"first",
"premium_economy"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -143719,14 +155179,20 @@
"ticket_number": {
"description": "The ticket number associated with the travel reservation.",
"maxLength": 14,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -143737,40 +155203,64 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"adults": {
"description": "The number of adults on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -143785,12 +155275,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
"maxLength": 9,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"category": {
"description": "The lodging category",
@@ -143798,7 +155294,10 @@
"hotel",
"vacation_rental"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"checkin_at": {
"description": "Loding check-in time. Measured in seconds since the Unix epoch.",
@@ -143812,11 +155311,17 @@
},
"customer_service_phone_number": {
"description": "The customer service phone number of the lodging company.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"daily_room_rate_amount": {
"description": "The daily lodging room rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -143829,7 +155334,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -143837,25 +155345,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -143870,24 +155393,39 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fire_safety_act_compliance": {
"description": "Indicates whether the lodging location is compliant with the Fire Safety Act.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the lodging location.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number_of_rooms": {
"description": "The number of rooms on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation",
@@ -143905,28 +155443,46 @@
"title": "lodging_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"property_phone_number": {
"description": "The phone number of the lodging location.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_class": {
"description": "The room class for this purchase.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_nights": {
"description": "The number of room nights",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_room_tax_amount": {
"description": "The total tax amount associating with the room reservation.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_tax_amount": {
"description": "The total tax amount",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -143934,7 +155490,10 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -143952,11 +155511,17 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_interval": {
"description": "Subscription billing details for this purchase.",
@@ -143981,12 +155546,18 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the product on subscription. e.g. Apple Music Subscription",
@@ -143996,14 +155567,20 @@
"starts_at": {
"description": "Subscription start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_details",
@@ -144020,7 +155597,10 @@
},
"payment_method": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_configuration": {
"description": "The ID of the payment method configuration to use with this PaymentIntent.",
@@ -144117,12 +155697,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -144144,32 +155730,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -144182,7 +155786,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -144196,7 +155803,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -144211,7 +155821,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -144226,11 +155839,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -144301,7 +155920,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -144317,7 +155939,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -144392,7 +156017,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -144429,7 +156057,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -144447,12 +156078,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -144506,7 +156146,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -144530,17 +156173,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -144564,7 +156216,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -144682,6 +156337,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -144713,12 +156369,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -144726,17 +156388,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -144783,12 +156454,18 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -144797,7 +156474,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -144805,11 +156485,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -144819,7 +156505,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -144829,7 +156518,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -144842,7 +156534,10 @@
"type": "string"
}
],
- "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options."
+ "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affirm": {
"anyOf": [
@@ -144854,19 +156549,28 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Affirm authorization page that the customer is redirected to.",
"maxLength": 30,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -144879,7 +156583,10 @@
"type": "string"
}
],
- "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options."
+ "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay": {
"anyOf": [
@@ -144891,12 +156598,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.",
"maxLength": 128,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -144904,7 +156617,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -144917,7 +156633,10 @@
"type": "string"
}
],
- "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options."
+ "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"alipay": {
"anyOf": [
@@ -144930,7 +156649,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -144943,7 +156665,10 @@
"type": "string"
}
],
- "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options."
+ "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay": {
"anyOf": [
@@ -144955,7 +156680,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -144964,7 +156692,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -144977,7 +156708,10 @@
"type": "string"
}
],
- "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options."
+ "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"au_becs_debit": {
"anyOf": [
@@ -144991,7 +156725,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -145004,7 +156741,10 @@
"type": "string"
}
],
- "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options."
+ "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit": {
"anyOf": [
@@ -145014,7 +156754,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145024,7 +156767,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -145037,7 +156783,10 @@
"type": "string"
}
],
- "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options."
+ "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -145051,7 +156800,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145060,7 +156812,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145073,7 +156828,10 @@
"type": "string"
}
],
- "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options."
+ "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"anyOf": [
@@ -145082,7 +156840,10 @@
"code": {
"description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145091,7 +156852,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -145104,7 +156868,10 @@
"type": "string"
}
],
- "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options."
+ "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"boleto": {
"anyOf": [
@@ -145112,7 +156879,10 @@
"properties": {
"expires_after_days": {
"description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145122,7 +156892,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145135,7 +156908,10 @@
"type": "string"
}
],
- "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options."
+ "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -145147,19 +156923,28 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc_token": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"installments": {
"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).",
"properties": {
"enabled": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"anyOf": [
@@ -145167,14 +156952,20 @@
"properties": {
"count": {
"description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
"enum": [
"month"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of installment plan, one of `fixed_count`.",
@@ -145198,11 +156989,17 @@
"type": "string"
}
],
- "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation."
+ "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Configuration options for setting up an eMandate for cards issued in India.",
@@ -145222,12 +157019,18 @@
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"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.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
@@ -145242,7 +157045,10 @@
},
"interval_count": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "Unique identifier for the mandate or subscription.",
@@ -145262,7 +157068,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -145273,11 +157082,17 @@
"start_date"
],
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.",
@@ -145297,7 +157112,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_decremental_authorization": {
"description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.",
@@ -145305,7 +157123,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_extended_authorization": {
"description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
@@ -145313,7 +157134,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_incremental_authorization": {
"description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
@@ -145321,7 +157145,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_multicapture": {
"description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
@@ -145329,7 +157156,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_overcapture": {
"description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
@@ -145337,7 +157167,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -145347,11 +157180,17 @@
"challenge"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_cvc_recollection": {
"description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145361,7 +157200,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kana": {
"anyOf": [
@@ -145376,7 +157218,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kanji": {
"anyOf": [
@@ -145391,7 +157236,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_details": {
"anyOf": [
@@ -145403,41 +157251,65 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "statement_details_address_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Phone number (e.g., a toll-free number that customers can call)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "statement_details_param",
@@ -145450,7 +157322,10 @@
"type": "string"
}
],
- "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements."
+ "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"three_d_secure": {
"description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.",
@@ -145466,7 +157341,10 @@
"U",
"Y"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cryptogram": {
"description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
@@ -145483,7 +157361,10 @@
"07"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exemption_indicator": {
"description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
@@ -145491,7 +157372,10 @@
"low_risk",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_options": {
"description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
@@ -145514,27 +157398,42 @@
"cb_exemption": {
"description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cb_score": {
"description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_id": {
"description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
@@ -145558,7 +157457,10 @@
"version"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_param",
@@ -145571,7 +157473,10 @@
"type": "string"
}
],
- "description": "Configuration for any card payments attempted on this PaymentIntent."
+ "description": "Configuration for any card payments attempted on this PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_present": {
"anyOf": [
@@ -145579,11 +157484,17 @@
"properties": {
"request_extended_authorization": {
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_incremental_authorization_support": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing": {
"description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.",
@@ -145594,11 +157505,17 @@
"domestic",
"international"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "routing_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145611,7 +157528,10 @@
"type": "string"
}
],
- "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
+ "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cashapp": {
"anyOf": [
@@ -145623,7 +157543,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145633,7 +157556,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -145646,7 +157572,10 @@
"type": "string"
}
],
- "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options."
+ "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -145668,7 +157597,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requested_address_types": {
"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`.",
@@ -145685,7 +157617,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"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`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -145704,21 +157639,30 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
"enum": [
"bank_transfer"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -145731,7 +157675,10 @@
"type": "string"
}
],
- "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options."
+ "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eps": {
"anyOf": [
@@ -145742,7 +157689,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -145755,7 +157705,10 @@
"type": "string"
}
],
- "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options."
+ "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fpx": {
"anyOf": [
@@ -145766,7 +157719,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145779,7 +157735,10 @@
"type": "string"
}
],
- "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options."
+ "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"giropay": {
"anyOf": [
@@ -145790,7 +157749,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145803,7 +157765,10 @@
"type": "string"
}
],
- "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options."
+ "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"grabpay": {
"anyOf": [
@@ -145814,7 +157779,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145827,7 +157795,10 @@
"type": "string"
}
],
- "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options."
+ "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal": {
"anyOf": [
@@ -145840,7 +157811,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145853,7 +157827,10 @@
"type": "string"
}
],
- "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options."
+ "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interac_present": {
"anyOf": [
@@ -145869,7 +157846,10 @@
"type": "string"
}
],
- "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
+ "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna": {
"anyOf": [
@@ -145881,7 +157861,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Klarna authorization page that the customer is redirected to",
@@ -145934,7 +157917,10 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -145942,7 +157928,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -145955,7 +157944,10 @@
"type": "string"
}
],
- "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options."
+ "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"anyOf": [
@@ -145974,7 +157966,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_after_days": {
"anyOf": [
@@ -145988,7 +157983,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_at": {
"anyOf": [
@@ -146003,7 +158001,10 @@
"type": "string"
}
],
- "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
+ "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -146018,14 +158019,20 @@
"type": "string"
}
],
- "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
+ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146038,7 +158045,10 @@
"type": "string"
}
],
- "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options."
+ "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"anyOf": [
@@ -146050,12 +158060,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146064,7 +158080,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -146077,7 +158096,40 @@
"type": "string"
}
],
- "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
+ "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "mb_way": {
+ "anyOf": [
+ {
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
+ "enum": [
+ "none"
+ ],
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"anyOf": [
@@ -146089,14 +158141,20 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146109,7 +158167,10 @@
"type": "string"
}
],
- "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options."
+ "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"multibanco": {
"anyOf": [
@@ -146120,7 +158181,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146133,7 +158197,10 @@
"type": "string"
}
],
- "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options."
+ "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"anyOf": [
@@ -146141,14 +158208,20 @@
"properties": {
"expires_after_days": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146161,7 +158234,10 @@
"type": "string"
}
],
- "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options."
+ "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24": {
"anyOf": [
@@ -146172,11 +158248,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tos_shown_and_accepted": {
"description": "Confirm that the payer has accepted the P24 terms and conditions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146189,7 +158271,10 @@
"type": "string"
}
],
- "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options."
+ "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paynow": {
"anyOf": [
@@ -146200,7 +158285,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146213,7 +158301,10 @@
"type": "string"
}
],
- "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options."
+ "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"anyOf": [
@@ -146225,7 +158316,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.",
@@ -146253,22 +158347,34 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference_id": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"risk_correlation_id": {
"description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.",
"maxLength": 32,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146277,7 +158383,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -146285,7 +158394,10 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146298,7 +158410,10 @@
"type": "string"
}
],
- "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options."
+ "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto": {
"anyOf": [
@@ -146309,7 +158424,10 @@
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
@@ -146317,12 +158435,18 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
@@ -146336,11 +158460,17 @@
"semi_annual",
"weekly"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
@@ -146357,11 +158487,17 @@
"tax",
"utility"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146370,7 +158506,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -146383,7 +158522,10 @@
"type": "string"
}
],
- "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options."
+ "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pix": {
"anyOf": [
@@ -146391,19 +158533,28 @@
"properties": {
"expires_after_seconds": {
"description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_at": {
"description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146416,7 +158567,10 @@
"type": "string"
}
],
- "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options."
+ "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promptpay": {
"anyOf": [
@@ -146427,7 +158581,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146440,7 +158597,10 @@
"type": "string"
}
],
- "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
+ "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rechnung": {
"anyOf": [
@@ -146456,7 +158616,10 @@
"type": "string"
}
],
- "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options."
+ "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"revolut_pay": {
"anyOf": [
@@ -146468,7 +158631,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -146477,7 +158643,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146490,7 +158659,10 @@
"type": "string"
}
],
- "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options."
+ "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -146500,7 +158672,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146510,7 +158685,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -146523,7 +158701,10 @@
"type": "string"
}
],
- "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options."
+ "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort": {
"anyOf": [
@@ -146541,7 +158722,10 @@
"nl",
"pl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146550,7 +158734,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146563,7 +158750,10 @@
"type": "string"
}
],
- "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options."
+ "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"swish": {
"anyOf": [
@@ -146582,14 +158772,20 @@
"type": "string"
}
],
- "description": "The order ID displayed in the Swish app after the payment is authorized."
+ "description": "The order ID displayed in the Swish app after the payment is authorized.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -146602,7 +158798,10 @@
"type": "string"
}
],
- "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options."
+ "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"twint": {
"anyOf": [
@@ -146613,7 +158812,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146626,7 +158828,10 @@
"type": "string"
}
],
- "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options."
+ "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"anyOf": [
@@ -146648,16 +158853,25 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -146675,7 +158889,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -146690,7 +158907,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -146703,16 +158923,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -146724,11 +158953,17 @@
"paper"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Additional fields for network related functions",
@@ -146742,11 +158977,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_settlement_speed": {
"description": "Preferred transaction settlement speed",
@@ -146755,7 +158996,10 @@
"fastest",
"standard"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -146765,7 +159009,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -146775,7 +159022,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -146788,7 +159038,10 @@
"type": "string"
}
],
- "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options."
+ "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"wechat_pay": {
"anyOf": [
@@ -146797,7 +159050,10 @@
"app_id": {
"description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"client": {
"description": "The client type that the end customer will pay from",
@@ -146814,7 +159070,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -146830,7 +159089,10 @@
"type": "string"
}
],
- "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options."
+ "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"zip": {
"anyOf": [
@@ -146841,7 +159103,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146854,7 +159119,10 @@
"type": "string"
}
],
- "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options."
+ "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -146889,7 +159157,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"anyOf": [
@@ -146901,32 +159172,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -146935,7 +159224,10 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
@@ -146945,12 +159237,18 @@
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -146970,21 +159268,30 @@
"description": "Shipping information for this PaymentIntent."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "transfer_data_update_params",
@@ -147055,11 +159362,17 @@
"properties": {
"amount": {
"description": "Amount that you intend to apply to this PaymentIntent from the customer’s cash balance.\n\nA positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency).\n\nThe maximum amount is the amount of the PaymentIntent.\n\nWhen you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -147138,7 +159451,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -147225,7 +159541,10 @@
"properties": {
"amount_to_capture": {
"description": "The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"application_fee_amount": {
"description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
@@ -147260,11 +159579,17 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_param",
@@ -147319,7 +159644,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -147329,27 +159657,42 @@
"car_class_code": {
"description": "Class code of the car.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_make": {
"description": "Make of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_model": {
"description": "Model of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the rental car company.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_service_phone_number": {
"description": "The customer service phone number of the car rental company.",
"maxLength": 16,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_rented": {
"description": "Number of days the car is being rented.",
@@ -147366,7 +159709,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -147374,25 +159720,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -147410,7 +159771,10 @@
"title": "car_rental_driver",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -147424,11 +159788,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep nor cancel their booking.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_address": {
"description": "Car pick-up address.",
@@ -147436,36 +159806,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -147474,7 +159865,10 @@
},
"rate_amount": {
"description": "Rental rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rate_interval": {
"description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`",
@@ -147483,12 +159877,18 @@
"month",
"week"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"renter_name": {
"description": "The name of the person or entity renting the car.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_address": {
"description": "Car return address.",
@@ -147496,36 +159896,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -147534,7 +159955,10 @@
},
"tax_exempt": {
"description": "Indicates whether the goods or services are tax-exempt or tax is not collected.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -147544,14 +159968,20 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"event_details": {
"description": "Event details for this PaymentIntent",
"properties": {
"access_controlled_venue": {
"description": "Indicates if the tickets are digitally checked when entering the venue.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address": {
"description": "The event location's address.",
@@ -147559,36 +159989,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -147603,12 +160054,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the company",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -147621,7 +160078,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -147629,35 +160089,56 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"genre": {
"description": "Type of the event entertainment (concert, sports event etc)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the event.",
@@ -147667,14 +160148,20 @@
"starts_at": {
"description": "Event start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -147692,17 +160179,26 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
"maxLength": 8,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -147715,7 +160211,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -147723,30 +160222,48 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation.",
@@ -147764,7 +160281,10 @@
"title": "flight_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The individual flight segments associated with the trip.",
@@ -147772,22 +160292,34 @@
"properties": {
"amount": {
"description": "The flight segment amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrival_airport": {
"description": "The International Air Transport Association (IATA) airport code for the arrival airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrives_at": {
"description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departs_at": {
"description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.",
@@ -147797,12 +160329,18 @@
"departure_airport": {
"description": "The International Air Transport Association (IATA) airport code for the departure airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number associated with the segment",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The fare class for the segment.",
@@ -147812,7 +160350,10 @@
"first",
"premium_economy"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -147826,14 +160367,20 @@
"ticket_number": {
"description": "The ticket number associated with the travel reservation.",
"maxLength": 14,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -147844,40 +160391,64 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"adults": {
"description": "The number of adults on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -147892,12 +160463,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
"maxLength": 9,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"category": {
"description": "The lodging category",
@@ -147905,7 +160482,10 @@
"hotel",
"vacation_rental"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"checkin_at": {
"description": "Loding check-in time. Measured in seconds since the Unix epoch.",
@@ -147919,11 +160499,17 @@
},
"customer_service_phone_number": {
"description": "The customer service phone number of the lodging company.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"daily_room_rate_amount": {
"description": "The daily lodging room rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -147936,7 +160522,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -147944,25 +160533,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -147977,24 +160581,39 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fire_safety_act_compliance": {
"description": "Indicates whether the lodging location is compliant with the Fire Safety Act.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the lodging location.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number_of_rooms": {
"description": "The number of rooms on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation",
@@ -148012,28 +160631,46 @@
"title": "lodging_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"property_phone_number": {
"description": "The phone number of the lodging location.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_class": {
"description": "The room class for this purchase.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_nights": {
"description": "The number of room nights",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_room_tax_amount": {
"description": "The total tax amount associating with the room reservation.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_tax_amount": {
"description": "The total tax amount",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -148041,7 +160678,10 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -148059,11 +160699,17 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_interval": {
"description": "Subscription billing details for this purchase.",
@@ -148088,12 +160734,18 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the product on subscription. e.g. Apple Music Subscription",
@@ -148103,14 +160755,20 @@
"starts_at": {
"description": "Subscription start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_details",
@@ -148126,12 +160784,12 @@
"description": "Provides industry-specific information about the charge."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -148140,7 +160798,10 @@
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "transfer_data_update_params",
@@ -148292,11 +160953,17 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_param",
@@ -148343,13 +161010,19 @@
"accepted_at": {
"description": "The time at which the customer accepted the Mandate.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"offline": {
"description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
"properties": {},
"title": "offline_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"online": {
"description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
@@ -148369,7 +161042,10 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -148411,12 +161087,18 @@
"properties": {
"ip_address": {
"description": "The IP address from which the Mandate was accepted by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the Mandate was accepted by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "online_param",
@@ -148486,7 +161168,10 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the car rental.",
@@ -148496,27 +161181,42 @@
"car_class_code": {
"description": "Class code of the car.",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_make": {
"description": "Make of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"car_model": {
"description": "Model of the car.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the rental car company.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_service_phone_number": {
"description": "The customer service phone number of the car rental company.",
"maxLength": 16,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_rented": {
"description": "Number of days the car is being rented.",
@@ -148533,7 +161233,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -148541,25 +161244,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"drivers": {
"description": "The details of the passengers in the travel reservation",
@@ -148577,7 +161295,10 @@
"title": "car_rental_driver",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -148591,11 +161312,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep nor cancel their booking.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_address": {
"description": "Car pick-up address.",
@@ -148603,36 +161330,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pickup_at": {
"description": "Car pick-up time. Measured in seconds since the Unix epoch.",
@@ -148641,7 +161389,10 @@
},
"rate_amount": {
"description": "Rental rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rate_interval": {
"description": "The frequency at which the rate amount is applied. One of `day`, `week` or `month`",
@@ -148650,12 +161401,18 @@
"month",
"week"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"renter_name": {
"description": "The name of the person or entity renting the car.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_address": {
"description": "Car return address.",
@@ -148663,36 +161420,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_at": {
"description": "Car return time. Measured in seconds since the Unix epoch.",
@@ -148701,7 +161479,10 @@
},
"tax_exempt": {
"description": "Indicates whether the goods or services are tax-exempt or tax is not collected.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -148711,14 +161492,20 @@
"return_at"
],
"title": "car_rental",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"event_details": {
"description": "Event details for this PaymentIntent",
"properties": {
"access_controlled_venue": {
"description": "Indicates if the tickets are digitally checked when entering the venue.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address": {
"description": "The event location's address.",
@@ -148726,36 +161513,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -148770,12 +161578,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "The name of the company",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -148788,7 +161602,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -148796,35 +161613,56 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Event end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"genre": {
"description": "Type of the event entertainment (concert, sports event etc)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the event.",
@@ -148834,14 +161672,20 @@
"starts_at": {
"description": "Event start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "event",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Flight reservation details for this PaymentIntent",
@@ -148859,17 +161703,26 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"agency_number": {
"description": "The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking.",
"maxLength": 8,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -148882,7 +161735,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -148890,30 +161746,48 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the person or entity on the reservation.",
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation.",
@@ -148931,7 +161805,10 @@
"title": "flight_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The individual flight segments associated with the trip.",
@@ -148939,22 +161816,34 @@
"properties": {
"amount": {
"description": "The flight segment amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrival_airport": {
"description": "The International Air Transport Association (IATA) airport code for the arrival airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"arrives_at": {
"description": "The arrival time for the flight segment. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departs_at": {
"description": "The departure time for the flight segment. Measured in seconds since the Unix epoch.",
@@ -148964,12 +161853,18 @@
"departure_airport": {
"description": "The International Air Transport Association (IATA) airport code for the departure airport.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number associated with the segment",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The fare class for the segment.",
@@ -148979,7 +161874,10 @@
"first",
"premium_economy"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -148993,14 +161891,20 @@
"ticket_number": {
"description": "The ticket number associated with the travel reservation.",
"maxLength": 14,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"segments"
],
"title": "flight",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Lodging reservation details for this PaymentIntent",
@@ -149011,40 +161915,64 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"adults": {
"description": "The number of adults on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affiliate": {
"description": "Affiliate details for this purchase.",
@@ -149059,12 +161987,18 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"booking_number": {
"description": "The booking number associated with the lodging reservation.",
"maxLength": 9,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"category": {
"description": "The lodging category",
@@ -149072,7 +162006,10 @@
"hotel",
"vacation_rental"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"checkin_at": {
"description": "Loding check-in time. Measured in seconds since the Unix epoch.",
@@ -149086,11 +162023,17 @@
},
"customer_service_phone_number": {
"description": "The customer service phone number of the lodging company.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"daily_room_rate_amount": {
"description": "The daily lodging room rate.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"delivery": {
"description": "Delivery details for this purchase.",
@@ -149103,7 +162046,10 @@
"pickup",
"post"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recipient": {
"description": "Details of the recipient.",
@@ -149111,25 +162057,40 @@
"email": {
"description": "The email of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The phone number of the recipient the ticket is delivered to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_recipient",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"extra_charges": {
"description": "List of additional charges being billed.",
@@ -149144,24 +162105,39 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fire_safety_act_compliance": {
"description": "Indicates whether the lodging location is compliant with the Fire Safety Act.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The name of the lodging location.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no_show": {
"description": "Indicates if the customer did not keep their booking while failing to cancel the reservation.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number_of_rooms": {
"description": "The number of rooms on the booking",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passengers": {
"description": "The details of the passengers in the travel reservation",
@@ -149179,28 +162155,46 @@
"title": "lodging_passenger",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"property_phone_number": {
"description": "The phone number of the lodging location.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_class": {
"description": "The room class for this purchase.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"room_nights": {
"description": "The number of room nights",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_room_tax_amount": {
"description": "The total tax amount associating with the room reservation.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total_tax_amount": {
"description": "The total tax amount",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -149208,7 +162202,10 @@
"checkout_at"
],
"title": "lodging",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "Subscription details for this PaymentIntent",
@@ -149226,11 +162223,17 @@
"name"
],
"title": "affiliate",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"auto_renewal": {
"description": "Info whether the subscription will be auto renewed upon expiry.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_interval": {
"description": "Subscription billing details for this purchase.",
@@ -149255,12 +162258,18 @@
"interval"
],
"title": "subscription_billing_interval",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Subscription end time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the product on subscription. e.g. Apple Music Subscription",
@@ -149270,14 +162279,20 @@
"starts_at": {
"description": "Subscription start time. Measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"name"
],
"title": "subscription",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_details",
@@ -149295,7 +162310,10 @@
"payment_method": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_data": {
"description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.",
@@ -149387,12 +162405,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -149414,32 +162438,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -149452,7 +162494,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -149466,7 +162511,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -149481,7 +162529,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -149496,11 +162547,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -149571,7 +162628,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -149587,7 +162647,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -149662,7 +162725,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -149699,7 +162765,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -149717,12 +162786,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -149776,7 +162854,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -149800,17 +162881,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -149834,7 +162924,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -149952,6 +163045,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -149983,12 +163077,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -149996,17 +163096,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -150053,12 +163162,18 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -150067,7 +163182,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -150075,11 +163193,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150089,7 +163213,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -150099,7 +163226,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -150112,7 +163242,10 @@
"type": "string"
}
],
- "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options."
+ "description": "If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affirm": {
"anyOf": [
@@ -150124,19 +163257,28 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Affirm authorization page that the customer is redirected to.",
"maxLength": 30,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -150149,7 +163291,10 @@
"type": "string"
}
],
- "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options."
+ "description": "If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"afterpay_clearpay": {
"anyOf": [
@@ -150161,12 +163306,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.",
"maxLength": 128,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150174,7 +163325,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -150187,7 +163341,10 @@
"type": "string"
}
],
- "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options."
+ "description": "If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"alipay": {
"anyOf": [
@@ -150200,7 +163357,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -150213,7 +163373,10 @@
"type": "string"
}
],
- "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options."
+ "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay": {
"anyOf": [
@@ -150225,7 +163388,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -150234,7 +163400,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -150247,7 +163416,10 @@
"type": "string"
}
],
- "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options."
+ "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"au_becs_debit": {
"anyOf": [
@@ -150261,7 +163433,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -150274,7 +163449,10 @@
"type": "string"
}
],
- "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options."
+ "description": "If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit": {
"anyOf": [
@@ -150284,7 +163462,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150294,7 +163475,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -150307,7 +163491,10 @@
"type": "string"
}
],
- "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options."
+ "description": "If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -150321,7 +163508,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150330,7 +163520,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -150343,7 +163536,10 @@
"type": "string"
}
],
- "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options."
+ "description": "If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"anyOf": [
@@ -150352,7 +163548,10 @@
"code": {
"description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150361,7 +163560,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -150374,7 +163576,10 @@
"type": "string"
}
],
- "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options."
+ "description": "If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"boleto": {
"anyOf": [
@@ -150382,7 +163587,10 @@
"properties": {
"expires_after_days": {
"description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150392,7 +163600,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -150405,7 +163616,10 @@
"type": "string"
}
],
- "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options."
+ "description": "If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -150417,19 +163631,28 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc_token": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"installments": {
"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).",
"properties": {
"enabled": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"anyOf": [
@@ -150437,14 +163660,20 @@
"properties": {
"count": {
"description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
"enum": [
"month"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of installment plan, one of `fixed_count`.",
@@ -150468,11 +163697,17 @@
"type": "string"
}
],
- "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation."
+ "description": "The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "installments_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Configuration options for setting up an eMandate for cards issued in India.",
@@ -150492,12 +163727,18 @@
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"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.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
@@ -150512,7 +163753,10 @@
},
"interval_count": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "Unique identifier for the mandate or subscription.",
@@ -150532,7 +163776,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -150543,11 +163790,17 @@
"start_date"
],
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"description": "Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.",
@@ -150567,7 +163820,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_decremental_authorization": {
"description": "Request ability to [decrement the authorization](https://stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.",
@@ -150575,7 +163831,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_extended_authorization": {
"description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
@@ -150583,7 +163842,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_incremental_authorization": {
"description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
@@ -150591,7 +163853,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_multicapture": {
"description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
@@ -150599,7 +163864,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_overcapture": {
"description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
@@ -150607,7 +163875,10 @@
"if_available",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -150617,11 +163888,17 @@
"challenge"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"require_cvc_recollection": {
"description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150631,7 +163908,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kana": {
"anyOf": [
@@ -150646,7 +163926,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix_kanji": {
"anyOf": [
@@ -150661,7 +163944,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_details": {
"anyOf": [
@@ -150673,41 +163959,65 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "statement_details_address_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Phone number (e.g., a toll-free number that customers can call)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "statement_details_param",
@@ -150720,7 +164030,10 @@
"type": "string"
}
],
- "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements."
+ "description": "Statement details for this payment intent. You can use this to override the merchant details shown on your customers' statements.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"three_d_secure": {
"description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.",
@@ -150736,7 +164049,10 @@
"U",
"Y"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cryptogram": {
"description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
@@ -150753,7 +164069,10 @@
"07"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exemption_indicator": {
"description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
@@ -150761,7 +164080,10 @@
"low_risk",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_options": {
"description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
@@ -150784,27 +164106,42 @@
"cb_exemption": {
"description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cb_score": {
"description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_id": {
"description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
@@ -150828,7 +164165,10 @@
"version"
],
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_param",
@@ -150841,7 +164181,10 @@
"type": "string"
}
],
- "description": "Configuration for any card payments attempted on this PaymentIntent."
+ "description": "Configuration for any card payments attempted on this PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_present": {
"anyOf": [
@@ -150849,11 +164192,17 @@
"properties": {
"request_extended_authorization": {
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_incremental_authorization_support": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing": {
"description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.",
@@ -150864,11 +164213,17 @@
"domestic",
"international"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "routing_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -150881,7 +164236,10 @@
"type": "string"
}
],
- "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
+ "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cashapp": {
"anyOf": [
@@ -150893,7 +164251,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -150903,7 +164264,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -150916,7 +164280,10 @@
"type": "string"
}
],
- "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options."
+ "description": "If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -150938,7 +164305,10 @@
"country"
],
"title": "eu_bank_transfer_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requested_address_types": {
"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`.",
@@ -150955,7 +164325,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"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`, `mx_bank_transfer`, or `us_bank_transfer`.",
@@ -150974,21 +164347,30 @@
"type"
],
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
"enum": [
"bank_transfer"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -151001,7 +164383,10 @@
"type": "string"
}
],
- "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options."
+ "description": "If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eps": {
"anyOf": [
@@ -151012,7 +164397,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -151025,7 +164413,10 @@
"type": "string"
}
],
- "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options."
+ "description": "If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fpx": {
"anyOf": [
@@ -151036,7 +164427,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151049,7 +164443,10 @@
"type": "string"
}
],
- "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options."
+ "description": "If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"giropay": {
"anyOf": [
@@ -151060,7 +164457,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151073,7 +164473,10 @@
"type": "string"
}
],
- "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options."
+ "description": "If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"grabpay": {
"anyOf": [
@@ -151084,7 +164487,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151097,7 +164503,10 @@
"type": "string"
}
],
- "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options."
+ "description": "If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ideal": {
"anyOf": [
@@ -151110,7 +164519,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151123,7 +164535,10 @@
"type": "string"
}
],
- "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options."
+ "description": "If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interac_present": {
"anyOf": [
@@ -151139,7 +164554,10 @@
"type": "string"
}
],
- "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options."
+ "description": "If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"klarna": {
"anyOf": [
@@ -151151,7 +164569,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "Preferred language of the Klarna authorization page that the customer is redirected to",
@@ -151204,7 +164625,10 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151212,7 +164636,10 @@
"none"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151225,7 +164652,10 @@
"type": "string"
}
],
- "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options."
+ "description": "If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"anyOf": [
@@ -151244,7 +164674,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_after_days": {
"anyOf": [
@@ -151258,7 +164691,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_at": {
"anyOf": [
@@ -151273,7 +164709,10 @@
"type": "string"
}
],
- "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
+ "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_description": {
"anyOf": [
@@ -151288,14 +164727,20 @@
"type": "string"
}
],
- "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
+ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151308,7 +164753,10 @@
"type": "string"
}
],
- "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options."
+ "description": "If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"anyOf": [
@@ -151320,12 +164768,18 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151334,7 +164788,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -151347,7 +164804,40 @@
"type": "string"
}
],
- "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options."
+ "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ },
+ "mb_way": {
+ "anyOf": [
+ {
+ "properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
+ "enum": [
+ "none"
+ ],
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `mb_way` PaymentMethod, this sub-hash contains details about the MB WAY payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"anyOf": [
@@ -151359,14 +164849,20 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151379,7 +164875,10 @@
"type": "string"
}
],
- "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options."
+ "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"multibanco": {
"anyOf": [
@@ -151390,7 +164889,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151403,7 +164905,10 @@
"type": "string"
}
],
- "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options."
+ "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"anyOf": [
@@ -151411,14 +164916,20 @@
"properties": {
"expires_after_days": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151431,7 +164942,10 @@
"type": "string"
}
],
- "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options."
+ "description": "If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"p24": {
"anyOf": [
@@ -151442,11 +164956,17 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tos_shown_and_accepted": {
"description": "Confirm that the payer has accepted the P24 terms and conditions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151459,7 +164979,10 @@
"type": "string"
}
],
- "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options."
+ "description": "If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paynow": {
"anyOf": [
@@ -151470,7 +164993,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151483,7 +165009,10 @@
"type": "string"
}
],
- "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options."
+ "description": "If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"anyOf": [
@@ -151495,7 +165024,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_locale": {
"description": "[Preferred locale](https://stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.",
@@ -151523,22 +165055,34 @@
"sv-SE"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference_id": {
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
"maxLength": 127,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"risk_correlation_id": {
"description": "The risk correlation ID for an on-session payment using a saved PayPal payment method.",
"maxLength": 32,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151547,7 +165091,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -151555,7 +165102,10 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151568,7 +165118,10 @@
"type": "string"
}
],
- "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options."
+ "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto": {
"anyOf": [
@@ -151579,7 +165132,10 @@
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
@@ -151587,12 +165143,18 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
@@ -151606,11 +165168,17 @@
"semi_annual",
"weekly"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
@@ -151627,11 +165195,17 @@
"tax",
"utility"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151640,7 +165214,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -151653,7 +165230,10 @@
"type": "string"
}
],
- "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options."
+ "description": "If this is a `payto` PaymentMethod, this sub-hash contains details about the PayTo payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pix": {
"anyOf": [
@@ -151661,19 +165241,28 @@
"properties": {
"expires_after_seconds": {
"description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expires_at": {
"description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151686,7 +165275,10 @@
"type": "string"
}
],
- "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options."
+ "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promptpay": {
"anyOf": [
@@ -151697,7 +165289,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151710,7 +165305,10 @@
"type": "string"
}
],
- "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
+ "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rechnung": {
"anyOf": [
@@ -151726,7 +165324,10 @@
"type": "string"
}
],
- "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options."
+ "description": "If this is a `rechnung` PaymentMethod, this sub-hash contains details about the Rechnung payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"revolut_pay": {
"anyOf": [
@@ -151738,7 +165339,10 @@
"",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
@@ -151747,7 +165351,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151760,7 +165367,10 @@
"type": "string"
}
],
- "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options."
+ "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -151770,7 +165380,10 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151780,7 +165393,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -151793,7 +165409,10 @@
"type": "string"
}
],
- "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options."
+ "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sofort": {
"anyOf": [
@@ -151811,7 +165430,10 @@
"nl",
"pl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -151820,7 +165442,10 @@
"none",
"off_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151833,7 +165458,10 @@
"type": "string"
}
],
- "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options."
+ "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"swish": {
"anyOf": [
@@ -151852,14 +165480,20 @@
"type": "string"
}
],
- "description": "The order ID displayed in the Swish app after the payment is authorized."
+ "description": "The order ID displayed in the Swish app after the payment is authorized.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -151872,7 +165506,10 @@
"type": "string"
}
],
- "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options."
+ "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"twint": {
"anyOf": [
@@ -151883,7 +165520,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -151896,7 +165536,10 @@
"type": "string"
}
],
- "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options."
+ "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"anyOf": [
@@ -151918,16 +165561,25 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -151945,7 +165597,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -151960,7 +165615,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -151973,16 +165631,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -151994,11 +165661,17 @@
"paper"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Additional fields for network related functions",
@@ -152012,11 +165685,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"preferred_settlement_speed": {
"description": "Preferred transaction settlement speed",
@@ -152025,7 +165704,10 @@
"fastest",
"standard"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
@@ -152035,7 +165717,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -152045,7 +165730,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_payment_method_options_param",
@@ -152058,7 +165746,10 @@
"type": "string"
}
],
- "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options."
+ "description": "If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"wechat_pay": {
"anyOf": [
@@ -152067,7 +165758,10 @@
"app_id": {
"description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"client": {
"description": "The client type that the end customer will pay from",
@@ -152084,7 +165778,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -152100,7 +165797,10 @@
"type": "string"
}
],
- "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options."
+ "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"zip": {
"anyOf": [
@@ -152111,7 +165811,10 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -152124,7 +165827,10 @@
"type": "string"
}
],
- "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options."
+ "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -152144,7 +165850,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -152175,7 +165884,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"anyOf": [
@@ -152187,32 +165899,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -152221,7 +165951,10 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
@@ -152231,12 +165964,18 @@
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -152367,11 +166106,17 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_param",
@@ -152380,7 +166125,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -152395,14 +166143,20 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "transfer_data_update_params",
@@ -152519,11 +166273,17 @@
"calculation"
],
"title": "async_workflows_inputs_tax_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_inputs_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "async_workflows_param",
@@ -152532,7 +166292,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -152547,19 +166310,28 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "transfer_data_update_params",
@@ -152636,12 +166408,18 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"descriptor_code": {
"description": "A six-character code starting with SM present in the microdeposit sent to the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -152693,7 +166471,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -152909,11 +166690,17 @@
"custom_message": {
"description": "A custom message to display to the customer after the purchase is complete.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "after_completion_confirmation_page_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"redirect": {
"description": "Configuration when `type=redirect`.",
@@ -152928,7 +166715,10 @@
"url"
],
"title": "after_completion_redirect_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.",
@@ -152969,7 +166759,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -152984,7 +166777,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -153020,7 +166816,10 @@
"position"
],
"title": "payment_method_reuse_agreement_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotions": {
"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.",
@@ -153028,7 +166827,10 @@
"auto",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terms_of_service": {
"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).",
@@ -153036,7 +166838,10 @@
"none",
"required"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "consent_collection_params",
@@ -153082,7 +166887,10 @@
"options"
],
"title": "custom_field_dropdown_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"key": {
"description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
@@ -153117,34 +166925,55 @@
"properties": {
"maximum_length": {
"description": "The maximum character length constraint for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_length": {
"description": "The minimum character length requirement for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_field_numeric_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"text": {
"description": "Configuration for `type=text` fields.",
"properties": {
"maximum_length": {
"description": "The maximum character length constraint for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_length": {
"description": "The minimum character length requirement for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_field_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of the field.",
@@ -153192,7 +167021,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed after the payment confirmation button."
+ "description": "Custom text that should be displayed after the payment confirmation button.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_address": {
"anyOf": [
@@ -153217,7 +167049,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed alongside shipping address collection."
+ "description": "Custom text that should be displayed alongside shipping address collection.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"submit": {
"anyOf": [
@@ -153242,7 +167077,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed alongside the payment confirmation button."
+ "description": "Custom text that should be displayed alongside the payment confirmation button.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terms_of_service_acceptance": {
"anyOf": [
@@ -153267,7 +167105,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed in place of the default terms of service agreement text."
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_text_param",
@@ -153320,7 +167161,10 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with the invoice."
+ "description": "The account tax IDs associated with the invoice.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"custom_fields": {
"anyOf": [
@@ -153354,24 +167198,36 @@
"type": "string"
}
],
- "description": "Default custom fields to be displayed on invoices for this customer."
+ "description": "Default custom fields to be displayed on invoices for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"footer": {
"description": "Default footer to be displayed on invoices for this customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -153386,7 +167242,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -153403,7 +167262,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rendering_options": {
"anyOf": [
@@ -153416,7 +167278,10 @@
"exclude_tax",
"include_inclusive_tax"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rendering_options_param",
@@ -153429,11 +167294,17 @@
"type": "string"
}
],
- "description": "Default options for invoice PDF rendering for this customer."
+ "description": "Default options for invoice PDF rendering for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -153455,18 +167326,27 @@
},
"maximum": {
"description": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "adjustable_quantity_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.",
@@ -153492,7 +167372,10 @@
"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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The account on behalf of which to charge.",
@@ -153508,19 +167391,28 @@
"automatic_async",
"manual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"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.",
@@ -153528,22 +167420,34 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_group": {
"description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_data_params",
@@ -153902,7 +167806,10 @@
"shipping_rate": {
"description": "The ID of the Shipping Rate to use for this shipping option.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_option_params",
@@ -153926,7 +167833,10 @@
"description": {
"description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -153936,7 +167846,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -153951,22 +167864,34 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_data_invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_period_days": {
"description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -153995,7 +167920,10 @@
"end_behavior"
],
"title": "trial_settings_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_data_params",
@@ -154020,7 +167948,10 @@
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"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.",
@@ -154219,7 +168150,10 @@
"properties": {
"active": {
"description": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"after_completion": {
"description": "Behavior after the purchase is complete.",
@@ -154230,11 +168164,17 @@
"custom_message": {
"description": "A custom message to display to the customer after the purchase is complete.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "after_completion_confirmation_page_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"redirect": {
"description": "Configuration when `type=redirect`.",
@@ -154249,7 +168189,10 @@
"url"
],
"title": "after_completion_redirect_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.",
@@ -154282,7 +168225,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -154297,7 +168243,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -154351,7 +168300,10 @@
"options"
],
"title": "custom_field_dropdown_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"key": {
"description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
@@ -154386,34 +168338,55 @@
"properties": {
"maximum_length": {
"description": "The maximum character length constraint for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_length": {
"description": "The minimum character length requirement for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_field_numeric_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"text": {
"description": "Configuration for `type=text` fields.",
"properties": {
"maximum_length": {
"description": "The maximum character length constraint for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_length": {
"description": "The minimum character length requirement for the customer's input.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_field_text_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of the field.",
@@ -154470,7 +168443,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed after the payment confirmation button."
+ "description": "Custom text that should be displayed after the payment confirmation button.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_address": {
"anyOf": [
@@ -154495,7 +168471,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed alongside shipping address collection."
+ "description": "Custom text that should be displayed alongside shipping address collection.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"submit": {
"anyOf": [
@@ -154520,7 +168499,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed alongside the payment confirmation button."
+ "description": "Custom text that should be displayed alongside the payment confirmation button.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terms_of_service_acceptance": {
"anyOf": [
@@ -154545,7 +168527,10 @@
"type": "string"
}
],
- "description": "Custom text that should be displayed in place of the default terms of service agreement text."
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "custom_text_param",
@@ -154608,7 +168593,10 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with the invoice."
+ "description": "The account tax IDs associated with the invoice.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"custom_fields": {
"anyOf": [
@@ -154642,24 +168630,36 @@
"type": "string"
}
],
- "description": "Default custom fields to be displayed on invoices for this customer."
+ "description": "Default custom fields to be displayed on invoices for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"footer": {
"description": "Default footer to be displayed on invoices for this customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -154674,7 +168674,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -154691,7 +168694,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"rendering_options": {
"anyOf": [
@@ -154704,7 +168710,10 @@
"exclude_tax",
"include_inclusive_tax"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rendering_options_param",
@@ -154717,11 +168726,17 @@
"type": "string"
}
],
- "description": "Default options for invoice PDF rendering for this customer."
+ "description": "Default options for invoice PDF rendering for this customer.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -154743,18 +168758,27 @@
},
"maximum": {
"description": "The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "adjustable_quantity_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "The ID of an existing line item on the payment link.",
@@ -154763,7 +168787,10 @@
},
"quantity": {
"description": "The quantity of the line item being purchased.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -154772,14 +168799,20 @@
"title": "line_items_update_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_intent_data": {
"description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
@@ -154797,7 +168830,10 @@
"type": "string"
}
],
- "description": "An arbitrary string attached to the object. Often useful for displaying to users."
+ "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -154814,7 +168850,10 @@
"type": "string"
}
],
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values."
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
"anyOf": [
@@ -154829,7 +168868,10 @@
"type": "string"
}
],
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor_suffix": {
"anyOf": [
@@ -154844,7 +168886,10 @@
"type": "string"
}
],
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_group": {
"anyOf": [
@@ -154859,7 +168904,10 @@
"type": "string"
}
],
- "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/connect/separate-charges-and-transfers) for details."
+ "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/connect/separate-charges-and-transfers) for details.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_intent_data_update_params",
@@ -155238,7 +169286,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -155253,11 +169304,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_data_invoice_settings_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -155274,7 +169331,10 @@
"type": "string"
}
],
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values."
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"anyOf": [
@@ -155313,7 +169373,10 @@
"type": "string"
}
],
- "description": "Settings related to subscription trials."
+ "description": "Settings related to subscription trials.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_data_update_params",
@@ -155843,11 +169906,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -155866,11 +169935,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -155889,11 +169964,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -155912,11 +169993,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -155935,11 +170022,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -155958,11 +170051,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -155981,11 +170080,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156004,11 +170109,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156027,11 +170138,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156050,11 +170167,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156073,11 +170196,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156096,11 +170225,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156119,11 +170254,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156142,11 +170283,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156165,11 +170312,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156188,11 +170341,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156211,11 +170370,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156242,11 +170407,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156265,11 +170436,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156288,11 +170465,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156311,11 +170494,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156334,11 +170523,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156357,11 +170552,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156380,11 +170581,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156403,11 +170610,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156426,11 +170639,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156449,11 +170668,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156472,11 +170697,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156485,7 +170716,10 @@
"name": {
"description": "Configuration name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.",
@@ -156500,11 +170734,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156523,11 +170763,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156536,7 +170782,10 @@
"parent": {
"description": "Configuration's parent configuration. Specify to create a child configuration.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paynow": {
"description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.",
@@ -156551,11 +170800,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156574,11 +170829,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156597,11 +170858,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156620,11 +170887,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156643,11 +170916,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156666,11 +170945,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156689,11 +170974,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156712,11 +171003,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156735,11 +171032,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156758,11 +171061,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156781,11 +171090,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -156804,11 +171119,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157120,11 +171441,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157132,7 +171459,10 @@
},
"active": {
"description": "Whether the configuration can be used for new payments.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"affirm": {
"description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.",
@@ -157147,11 +171477,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157170,11 +171506,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157193,11 +171535,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157216,11 +171564,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157239,11 +171593,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157262,11 +171622,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157285,11 +171651,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157308,11 +171680,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157331,11 +171709,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157354,11 +171738,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157377,11 +171767,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157400,11 +171796,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157423,11 +171825,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157446,11 +171854,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157469,11 +171883,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157492,11 +171912,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157523,11 +171949,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157546,11 +171978,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157569,11 +172007,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157592,11 +172036,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157615,11 +172065,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157638,11 +172094,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157661,11 +172123,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157684,11 +172152,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157707,11 +172181,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157730,11 +172210,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157753,11 +172239,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157766,7 +172258,10 @@
"name": {
"description": "Configuration name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"oxxo": {
"description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.",
@@ -157781,11 +172276,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157804,11 +172305,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157827,11 +172334,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157850,11 +172363,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157873,11 +172392,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157896,11 +172421,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157919,11 +172450,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157942,11 +172479,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157965,11 +172508,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -157988,11 +172537,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -158011,11 +172566,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -158034,11 +172595,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -158057,11 +172624,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -158080,11 +172653,17 @@
"off",
"on"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "display_preference_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -158133,7 +172712,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -158143,7 +172725,10 @@
"name": "enabled",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -158289,7 +172874,10 @@
},
"enabled": {
"description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -158429,7 +173017,10 @@
"properties": {
"enabled": {
"description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -158626,6 +173217,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -158646,7 +173238,10 @@
"zip"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -158826,6 +173421,10 @@
"explode": true,
"style": "deepObject"
},
+ "mb_way": {
+ "explode": true,
+ "style": "deepObject"
+ },
"metadata": {
"explode": true,
"style": "deepObject"
@@ -158997,12 +173596,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -159024,32 +173629,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -159062,7 +173685,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -159076,7 +173702,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -159091,7 +173720,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -159106,11 +173738,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -159140,7 +173778,10 @@
"cvc": {
"description": "The card's CVC. It is highly recommended to always include this value.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exp_month": {
"description": "Two-digit number representing the card's expiration month.",
@@ -159160,11 +173801,17 @@
"mastercard",
"visa"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number": {
"description": "The card number, as a string without any separators.",
@@ -159213,7 +173860,10 @@
"customer": {
"description": "The `Customer` to whom the original PaymentMethod is attached.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.",
@@ -159257,7 +173907,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -159281,7 +173934,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -159356,7 +174012,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -159393,7 +174052,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -159411,12 +174073,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -159470,7 +174141,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -159499,17 +174173,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -159533,7 +174216,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -159652,6 +174338,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -159683,12 +174370,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -159696,17 +174389,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -159865,10 +174567,6 @@
"explode": true,
"style": "deepObject"
},
- "rechnung": {
- "explode": true,
- "style": "deepObject"
- },
"us_bank_account": {
"explode": true,
"style": "deepObject"
@@ -159896,32 +174594,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -159934,7 +174650,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -159948,7 +174667,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -159963,7 +174685,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -159978,22 +174703,34 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"description": "If this is a `card` PaymentMethod, this hash contains the user's card details.",
"properties": {
"exp_month": {
"description": "Two-digit number representing the card's expiration month.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exp_year": {
"description": "Four-digit number representing the card's expiration year.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Contains information about card networks used to process the payment.",
@@ -160006,11 +174743,17 @@
"mastercard",
"visa"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_update_api_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "update_api_param",
@@ -160053,53 +174796,28 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
- }
- },
- "title": "param",
- "type": "object"
- },
- "rechnung": {
- "description": "If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.",
- "properties": {
- "dob": {
- "description": "Customer's date of birth",
- "properties": {
- "day": {
- "description": "The day of birth, between 1 and 31.",
- "type": "integer"
- },
- "month": {
- "description": "The month of birth, between 1 and 12.",
- "type": "integer"
- },
- "year": {
- "description": "The four-digit year of birth.",
- "type": "integer"
- }
- },
- "required": [
- "day",
- "month",
- "year"
- ],
- "title": "date_of_birth",
- "type": "object"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
- "required": [
- "dob"
- ],
"title": "param",
"type": "object"
},
@@ -160112,7 +174830,10 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Bank account type.",
@@ -160120,7 +174841,10 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "update_param",
@@ -160316,19 +175040,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -160353,19 +175089,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -160442,7 +175190,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -160549,7 +175300,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.",
@@ -160568,7 +175322,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"method": {
"description": "The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).",
@@ -160595,7 +175352,10 @@
"description": "A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.",
"maxLength": 22,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -160898,7 +175658,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -160942,7 +175705,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -160958,19 +175724,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -161026,7 +175804,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -161148,7 +175929,10 @@
"properties": {
"active": {
"description": "Whether the plan is currently available for new subscriptions. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"aggregate_usage": {
"description": "Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.",
@@ -161162,7 +175946,10 @@
},
"amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_decimal": {
"description": "Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.",
@@ -161233,7 +176020,10 @@
"nickname": {
"description": "A brief description of the plan, hidden from customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product": {
"anyOf": [
@@ -161242,20 +176032,29 @@
"properties": {
"active": {
"description": "Whether the product is currently available for purchase. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"deprecated": true,
"description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -161265,17 +176064,26 @@
"statement_descriptor": {
"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.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_label": {
"description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.",
"maxLength": 12,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -161297,21 +176105,33 @@
"properties": {
"flat_amount": {
"description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flat_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"description": "The per unit billing amount for each individual unit for which this tier applies.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"up_to": {
"anyOf": [
@@ -161566,7 +176386,10 @@
"properties": {
"active": {
"description": "Whether the plan is currently available for new subscriptions.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -161596,7 +176419,10 @@
"nickname": {
"description": "A brief description of the plan, hidden from customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product": {
"description": "The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.",
@@ -161649,7 +176475,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -161665,19 +176494,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -161696,7 +176537,10 @@
"name": "currency",
"required": false,
"schema": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -161758,7 +176602,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -161778,12 +176625,18 @@
"week",
"year"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"meter": {
"description": "Filter by the price's meter.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"usage_type": {
"description": "Filter by the usage type for this price. Can be either `metered` or `licensed`.",
@@ -161791,7 +176644,10 @@
"licensed",
"metered"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "all_prices_recurring_params",
@@ -161820,7 +176676,10 @@
"one_time",
"recurring"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -161943,7 +176802,10 @@
"properties": {
"active": {
"description": "Whether the price can be used for new purchases. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_scheme": {
"description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.",
@@ -161977,7 +176839,10 @@
},
"preset": {
"description": "The starting unit amount which can be updated by the customer.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -162001,21 +176866,33 @@
"properties": {
"flat_amount": {
"description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flat_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"description": "The per unit billing amount for each individual unit for which this tier applies.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"up_to": {
"anyOf": [
@@ -162043,7 +176920,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -162074,7 +176954,10 @@
},
"preset": {
"description": "The starting unit amount which can be updated by the customer.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -162101,37 +176984,55 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nickname": {
"description": "A brief description of the price, hidden from customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product": {
"description": "The ID of the product that this price will belong to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"product_data": {
"description": "These fields can be used to create a new product that this price will belong to.",
"properties": {
"active": {
"description": "Whether the product is currently available for purchase. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"deprecated": true,
"description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -162141,17 +177042,26 @@
"statement_descriptor": {
"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.",
"maxLength": 22,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_label": {
"description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.",
"maxLength": 12,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -162171,7 +177081,10 @@
"max",
"sum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
@@ -162190,11 +177103,17 @@
"meter": {
"description": "The meter tracking the usage of a metered price",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_period_days": {
"description": "Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"usage_type": {
"description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.",
@@ -162202,14 +177121,20 @@
"licensed",
"metered"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"interval"
],
"title": "recurring",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -162226,21 +177151,33 @@
"properties": {
"flat_amount": {
"description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flat_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"description": "The per unit billing amount for each individual unit for which this tier applies.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"up_to": {
"anyOf": [
@@ -162303,7 +177240,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -162370,7 +177310,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -162381,7 +177324,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -162585,7 +177531,10 @@
"properties": {
"active": {
"description": "Whether the price can be used for new purchases. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency_options": {
"anyOf": [
@@ -162609,7 +177558,10 @@
},
"preset": {
"description": "The starting unit amount which can be updated by the customer.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -162633,21 +177585,33 @@
"properties": {
"flat_amount": {
"description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flat_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"description": "The per unit billing amount for each individual unit for which this tier applies.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"up_to": {
"anyOf": [
@@ -162675,7 +177639,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -162741,7 +177708,10 @@
"effective_after": {
"description": "The time after which subscriptions should start using the new price.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -162768,7 +177738,10 @@
"nickname": {
"description": "A brief description of the price, hidden from customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -162825,7 +177798,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -162841,19 +177817,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -163078,7 +178066,10 @@
"properties": {
"active": {
"description": "Whether the product is currently available for purchase. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.",
@@ -163107,7 +178098,10 @@
},
"preset": {
"description": "The starting unit amount which can be updated by the customer.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -163131,21 +178125,33 @@
"properties": {
"flat_amount": {
"description": "The flat billing amount for an entire tier, regardless of the number of units in the tier.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flat_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount": {
"description": "The per unit billing amount for each individual unit for which this tier applies.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"up_to": {
"anyOf": [
@@ -163173,7 +178179,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -163185,7 +178194,10 @@
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"recurring": {
"description": "The recurring components of a price such as `interval` and `interval_count`.",
@@ -163209,7 +178221,10 @@
"interval"
],
"title": "recurring_adhoc",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
@@ -163222,7 +178237,10 @@
},
"unit_amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -163239,7 +178257,10 @@
"description": {
"description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
"maxLength": 40000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -163252,7 +178273,10 @@
"id": {
"description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"images": {
"description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
@@ -163284,7 +178308,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The product's name, meant to be displayable to the customer.",
@@ -163340,7 +178367,10 @@
"currency"
],
"title": "fixed_amount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The specific type of gift_card provisioning, only `fixed_amount` currently supported.",
@@ -163354,7 +178384,10 @@
"type"
],
"title": "gift_card_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of provisioning, only `gift_card` currently supported.",
@@ -163461,7 +178494,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -163472,7 +178508,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -163747,12 +178786,18 @@
"properties": {
"active": {
"description": "Whether the product is available for purchase.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_price": {
"description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -163842,7 +178887,10 @@
"name": {
"description": "The product's name, meant to be displayable to the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"package_dimensions": {
"anyOf": [
@@ -164364,19 +179412,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -164550,7 +179610,10 @@
"code": {
"description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"description": "The coupon for this promotion code.",
@@ -164584,7 +179647,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"restrictions": {
"description": "Settings that restrict the redemption of the promotion code.",
@@ -164594,26 +179660,41 @@
"properties": {
"minimum_amount": {
"description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_option",
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_time_transaction": {
"description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_amount": {
"description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum_amount_currency": {
"description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "restrictions_params",
@@ -164792,14 +179873,20 @@
"properties": {
"minimum_amount": {
"description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_option",
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "restrictions_params",
@@ -165187,7 +180274,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -165263,7 +180353,10 @@
"open",
"stale"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -165418,10 +180511,6 @@
"explode": true,
"style": "deepObject"
},
- "phases": {
- "explode": true,
- "style": "deepObject"
- },
"subscription_data": {
"explode": true,
"style": "deepObject"
@@ -165482,7 +180571,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -165497,7 +180589,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -165560,7 +180655,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -165593,12 +180691,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -165668,7 +180772,10 @@
"properties": {
"is_revision": {
"description": "Whether this quote is a revision of the previous quote.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quote": {
"description": "The `id` of the quote that will be cloned.",
@@ -165702,14 +180809,20 @@
"properties": {
"days_until_due": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -165724,7 +180837,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "quote_param",
@@ -165742,7 +180858,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -165775,12 +180894,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -165820,7 +180945,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -165869,7 +180997,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -165886,7 +181017,10 @@
},
"quantity": {
"description": "The quantity of the line item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -165910,7 +181044,10 @@
"title": "line_item_create_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lines": {
"description": "A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.",
@@ -165926,12 +181063,18 @@
"coupon": {
"description": "The coupon code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount for a coupon that was already redeemed.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Details to determine how long the discount should be applied for.",
@@ -165948,20 +181091,32 @@
"type"
],
"title": "line_discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The promotion code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"add_item": {
"description": "Details for the `add_item` type.",
@@ -165973,7 +181128,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -166006,12 +181164,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -166037,14 +181201,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -166053,7 +181223,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
@@ -166061,7 +181234,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -166072,7 +181248,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -166087,21 +181266,30 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"add_metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Details for the `add_metadata` type: specify a hash of key-value pairs.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove_discount": {
"description": "Details for the `remove_discount` type.",
@@ -166109,21 +181297,33 @@
"coupon": {
"description": "The coupon code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "The ID of a discount to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove_item": {
"description": "Details for the `remove_item` type.",
@@ -166138,7 +181338,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove_metadata": {
"description": "Details for the `remove_metadata` type: specify an array of metadata keys.",
@@ -166146,7 +181349,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_discounts": {
"description": "Details for the `set_discounts` type.",
@@ -166155,23 +181361,35 @@
"coupon": {
"description": "The coupon code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "An ID of an existing promotion code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "set_discount_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_items": {
"description": "Details for the `set_items` type.",
@@ -166184,7 +181402,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -166217,12 +181438,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -166248,14 +181475,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -166264,7 +181497,10 @@
},
"quantity": {
"description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.",
@@ -166272,7 +181508,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.",
@@ -166283,7 +181522,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -166298,7 +181540,10 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -166307,7 +181552,10 @@
"title": "set_item_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_metadata": {
"anyOf": [
@@ -166324,7 +181572,10 @@
"type": "string"
}
],
- "description": "Details for the `set_metadata` type: specify an array of key-value pairs."
+ "description": "Details for the `set_metadata` type: specify an array of key-value pairs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of action the quote line performs.",
@@ -166350,7 +181601,10 @@
"title": "action_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"applies_to": {
"description": "Details to identify the subscription schedule the quote line applies to.",
@@ -166358,12 +181612,18 @@
"new_reference": {
"description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_schedule": {
"description": "The ID of the schedule the line applies to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Describes whether the quote line is affecting a new schedule or an existing schedule.",
@@ -166378,7 +181638,10 @@
"type"
],
"title": "applies_to_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"description": "For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.",
@@ -166386,7 +181649,10 @@
"automatic",
"line_starts_at"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_subscription_schedule": {
"description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.",
@@ -166400,18 +181666,27 @@
},
"invoice_now": {
"description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prorate": {
"description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cancel_at"
],
"title": "cancel_subscription_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.",
@@ -166429,7 +181704,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for the quote line starting from the `starts_at` date.",
@@ -166454,12 +181732,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select a way to pass in `ends_at`.",
@@ -166479,7 +181763,10 @@
"type"
],
"title": "ends_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.",
@@ -166488,7 +181775,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_pause_collection": {
"description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.",
@@ -166510,7 +181800,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -166525,7 +181818,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_schedule_end": {
"description": "Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.",
@@ -166533,7 +181829,10 @@
"line_ends_at",
"line_starts_at"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"starts_at": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -166551,23 +181850,35 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line_ends_at": {
"description": "The timestamp the given line ends at.",
"properties": {
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select a way to pass in `starts_at`.",
@@ -166587,7 +181898,10 @@
"type"
],
"title": "starts_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -166601,15 +181915,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "quote_line_create_specs",
@@ -166622,7 +181945,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"anyOf": [
@@ -166638,362 +181964,6 @@
],
"description": "The account on behalf of which to charge."
},
- "phases": {
- "description": "List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons.",
- "items": {
- "properties": {
- "billing_cycle_anchor": {
- "description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.",
- "enum": [
- "reset"
- ],
- "type": "string"
- },
- "collection_method": {
- "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
- "enum": [
- "charge_automatically",
- "send_invoice"
- ],
- "type": "string"
- },
- "default_tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "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."
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
- },
- "end_date": {
- "description": "The date at which this phase of the quote ends. If set, `iterations` must not be set.",
- "format": "unix-time",
- "type": "integer"
- },
- "invoice_settings": {
- "description": "All invoices will be billed using the specified settings.",
- "properties": {
- "days_until_due": {
- "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
- }
- },
- "title": "phase_invoice_settings_params",
- "type": "object"
- },
- "iterations": {
- "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.",
- "type": "integer"
- },
- "line_items": {
- "description": "A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost.",
- "items": {
- "properties": {
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The discounts applied to this line item."
- },
- "price": {
- "description": "The ID of the price object. One of `price` or `price_data` is required.",
- "maxLength": 5000,
- "type": "string"
- },
- "price_data": {
- "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
- "properties": {
- "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"
- },
- "product": {
- "description": "The ID of the product that this price will belong to.",
- "maxLength": 5000,
- "type": "string"
- },
- "recurring": {
- "description": "The recurring components of a price such as `interval` and `interval_count`.",
- "properties": {
- "interval": {
- "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).",
- "type": "integer"
- }
- },
- "required": [
- "interval"
- ],
- "title": "recurring_adhoc",
- "type": "object"
- },
- "tax_behavior": {
- "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
- },
- "unit_amount_decimal": {
- "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.",
- "format": "decimal",
- "type": "string"
- }
- },
- "required": [
- "currency",
- "product"
- ],
- "title": "price_data",
- "type": "object"
- },
- "quantity": {
- "description": "The quantity of the line item.",
- "type": "integer"
- },
- "tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "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."
- }
- },
- "title": "line_item_create_params",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted.",
- "type": "object"
- },
- "proration_behavior": {
- "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.",
- "enum": [
- "always_invoice",
- "create_prorations",
- "none"
- ],
- "type": "string"
- },
- "trial": {
- "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
- },
- "trial_end": {
- "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`.",
- "format": "unix-time",
- "type": "integer"
- }
- },
- "required": [
- "line_items"
- ],
- "title": "quote_phase_params",
- "type": "object"
- },
- "type": "array"
- },
"subscription_data": {
"description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.",
"properties": {
@@ -167009,20 +181979,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_from` time.",
@@ -167040,7 +182022,10 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -167068,7 +182053,10 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -167076,20 +182064,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_until` time.",
@@ -167107,11 +182107,17 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bill_on_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -167119,7 +182125,10 @@
"prorate_on_next_phase",
"prorate_up_front"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.",
@@ -167127,12 +182136,18 @@
"",
"reset"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"effective_date": {
"anyOf": [
@@ -167154,7 +182169,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends.",
@@ -167162,24 +182180,28 @@
"cancel",
"release"
],
- "type": "string"
- },
- "from_schedule": {
- "description": "The id of a subscription schedule the quote will update. The quote will inherit the state of the subscription schedule, such as `phases`. Cannot be combined with other parameters.",
- "maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"from_subscription": {
"description": "The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"anyOf": [
@@ -167203,7 +182225,10 @@
"type": "string"
}
],
- "description": "If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`."
+ "description": "If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.",
@@ -167212,7 +182237,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_period_days": {
"anyOf": [
@@ -167226,7 +182254,10 @@
"type": "string"
}
],
- "description": "Integer representing the number of trial period days before the customer is charged for the first time."
+ "description": "Integer representing the number of trial period days before the customer is charged for the first time.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_data_create_params",
@@ -167242,12 +182273,18 @@
"new_reference": {
"description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_schedule": {
"description": "The ID of the schedule the line applies to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Describes whether the quote line is affecting a new schedule or an existing schedule.",
@@ -167276,20 +182313,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_from` time.",
@@ -167307,7 +182356,10 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -167335,7 +182387,10 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -167343,20 +182398,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_until` time.",
@@ -167374,11 +182441,17 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bill_on_acceptance_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -167386,17 +182459,26 @@
"prorate_on_next_phase",
"prorate_up_front"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends.",
@@ -167404,7 +182486,10 @@
"cancel",
"release"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.",
@@ -167413,7 +182498,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -167435,11 +182523,17 @@
"properties": {
"amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total 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.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -167634,10 +182728,6 @@
"explode": true,
"style": "deepObject"
},
- "phases": {
- "explode": true,
- "style": "deepObject"
- },
"subscription_data": {
"explode": true,
"style": "deepObject"
@@ -167698,7 +182788,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -167713,7 +182806,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -167776,7 +182872,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -167809,12 +182908,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -167899,14 +183004,20 @@
"properties": {
"days_until_due": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -167921,7 +183032,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "quote_param",
@@ -167939,7 +183053,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -167972,12 +183089,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -168017,12 +183140,18 @@
"id": {
"description": "The ID of an existing line item on the quote.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -168071,7 +183200,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -168088,7 +183220,10 @@
},
"quantity": {
"description": "The quantity of the line item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -168112,7 +183247,10 @@
"title": "line_item_update_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lines": {
"description": "A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.",
@@ -168128,12 +183266,18 @@
"coupon": {
"description": "The coupon code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount for a coupon that was already redeemed.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Details to determine how long the discount should be applied for.",
@@ -168150,20 +183294,32 @@
"type"
],
"title": "line_discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The promotion code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"add_item": {
"description": "Details for the `add_item` type.",
@@ -168175,7 +183331,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -168208,12 +183367,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -168239,14 +183404,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -168255,7 +183426,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
@@ -168263,7 +183437,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -168274,7 +183451,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -168289,21 +183469,30 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"add_metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Details for the `add_metadata` type: specify a hash of key-value pairs.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove_discount": {
"description": "Details for the `remove_discount` type.",
@@ -168311,21 +183500,33 @@
"coupon": {
"description": "The coupon code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "The ID of a discount to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove_item": {
"description": "Details for the `remove_item` type.",
@@ -168340,7 +183541,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove_metadata": {
"description": "Details for the `remove_metadata` type: specify an array of metadata keys.",
@@ -168348,7 +183552,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_discounts": {
"description": "Details for the `set_discounts` type.",
@@ -168357,23 +183564,35 @@
"coupon": {
"description": "The coupon code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "An ID of an existing promotion code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "set_discount_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_items": {
"description": "Details for the `set_items` type.",
@@ -168386,7 +183605,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -168419,12 +183641,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -168450,14 +183678,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -168466,7 +183700,10 @@
},
"quantity": {
"description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.",
@@ -168474,7 +183711,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.",
@@ -168485,7 +183725,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -168500,7 +183743,10 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -168509,7 +183755,10 @@
"title": "set_item_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_metadata": {
"anyOf": [
@@ -168526,7 +183775,10 @@
"type": "string"
}
],
- "description": "Details for the `set_metadata` type: specify an array of key-value pairs."
+ "description": "Details for the `set_metadata` type: specify an array of key-value pairs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of action the quote line performs.",
@@ -168552,7 +183804,10 @@
"title": "action_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"applies_to": {
"description": "Details to identify the subscription schedule the quote line applies to.",
@@ -168560,12 +183815,18 @@
"new_reference": {
"description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_schedule": {
"description": "The ID of the schedule the line applies to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Describes whether the quote line is affecting a new schedule or an existing schedule.",
@@ -168580,7 +183841,10 @@
"type"
],
"title": "applies_to_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"description": "For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.",
@@ -168588,7 +183852,10 @@
"automatic",
"line_starts_at"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancel_subscription_schedule": {
"description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.",
@@ -168602,18 +183869,27 @@
},
"invoice_now": {
"description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prorate": {
"description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cancel_at"
],
"title": "cancel_subscription_schedule_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ends_at": {
"description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.",
@@ -168631,7 +183907,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for the quote line starting from the `starts_at` date.",
@@ -168656,12 +183935,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select a way to pass in `ends_at`.",
@@ -168681,12 +183966,18 @@
"type"
],
"title": "ends_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "The ID of an existing line on the quote.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.",
@@ -168695,7 +183986,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_pause_collection": {
"description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.",
@@ -168717,7 +184011,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -168732,7 +184029,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_schedule_end": {
"description": "Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.",
@@ -168740,7 +184040,10 @@
"line_ends_at",
"line_starts_at"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"starts_at": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -168758,7 +184061,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line_ends_at": {
"description": "The timestamp the given line ends at.",
@@ -168766,20 +184072,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select a way to pass in `starts_at`.",
@@ -168799,7 +184117,10 @@
"type"
],
"title": "starts_at_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -168813,15 +184134,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "quote_line_update_specs",
@@ -168834,7 +184164,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"anyOf": [
@@ -168850,362 +184183,6 @@
],
"description": "The account on behalf of which to charge."
},
- "phases": {
- "description": "List representing phases of the Quote. Each phase can be customized to have different durations, prices, and coupons.",
- "items": {
- "properties": {
- "billing_cycle_anchor": {
- "description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.",
- "enum": [
- "reset"
- ],
- "type": "string"
- },
- "collection_method": {
- "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
- "enum": [
- "charge_automatically",
- "send_invoice"
- ],
- "type": "string"
- },
- "default_tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "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."
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
- },
- "end_date": {
- "description": "The date at which this phase of the quote ends. If set, `iterations` must not be set.",
- "format": "unix-time",
- "type": "integer"
- },
- "invoice_settings": {
- "description": "All invoices will be billed using the specified settings.",
- "properties": {
- "days_until_due": {
- "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
- }
- },
- "title": "phase_invoice_settings_params",
- "type": "object"
- },
- "iterations": {
- "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.",
- "type": "integer"
- },
- "line_items": {
- "description": "A list of line items the customer is being quoted for within this phase. Each line item includes information about the product, the quantity, and the resulting cost.",
- "items": {
- "properties": {
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "description": "ID of the coupon to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
- "maxLength": 5000,
- "type": "string"
- },
- "discount_end": {
- "description": "Details to determine how long the discount should be applied for.",
- "properties": {
- "duration": {
- "description": "Time span for the redeemed discount.",
- "properties": {
- "interval": {
- "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.",
- "type": "integer"
- }
- },
- "required": [
- "interval",
- "interval_count"
- ],
- "title": "discount_end_duration_specs",
- "type": "object"
- },
- "timestamp": {
- "description": "A precise Unix timestamp for the discount to end. Must be in the future.",
- "format": "unix-time",
- "type": "integer"
- },
- "type": {
- "description": "The type of calculation made to determine when the discount ends.",
- "enum": [
- "duration",
- "timestamp"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "discount_end",
- "type": "object"
- },
- "promotion_code": {
- "description": "ID of the promotion code to create a new discount for.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The discounts applied to this line item."
- },
- "price": {
- "description": "The ID of the price object. One of `price` or `price_data` is required.",
- "maxLength": 5000,
- "type": "string"
- },
- "price_data": {
- "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
- "properties": {
- "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"
- },
- "product": {
- "description": "The ID of the product that this price will belong to.",
- "maxLength": 5000,
- "type": "string"
- },
- "recurring": {
- "description": "The recurring components of a price such as `interval` and `interval_count`.",
- "properties": {
- "interval": {
- "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).",
- "type": "integer"
- }
- },
- "required": [
- "interval"
- ],
- "title": "recurring_adhoc",
- "type": "object"
- },
- "tax_behavior": {
- "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
- },
- "unit_amount_decimal": {
- "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.",
- "format": "decimal",
- "type": "string"
- }
- },
- "required": [
- "currency",
- "product"
- ],
- "title": "price_data",
- "type": "object"
- },
- "quantity": {
- "description": "The quantity of the line item.",
- "type": "integer"
- },
- "tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "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."
- }
- },
- "title": "line_item_create_params",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on the subscription schedule's phases when the quote is accepted. After a quote has been finalized, this field can be updated by specifying an identical set of quote phases to what was on the quote originally, excluding changes in metadata and phases that are now in the past.",
- "type": "object"
- },
- "proration_behavior": {
- "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.",
- "enum": [
- "always_invoice",
- "create_prorations",
- "none"
- ],
- "type": "string"
- },
- "trial": {
- "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
- },
- "trial_end": {
- "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`.",
- "format": "unix-time",
- "type": "integer"
- }
- },
- "required": [
- "line_items"
- ],
- "title": "quote_phase_params",
- "type": "object"
- },
- "type": "array"
- },
"subscription_data": {
"description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.",
"properties": {
@@ -169222,20 +184199,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_from` time.",
@@ -169253,7 +184242,10 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -169281,7 +184273,10 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -169289,20 +184284,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_until` time.",
@@ -169320,7 +184327,10 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bill_on_acceptance_specs",
@@ -169333,7 +184343,10 @@
"type": "string"
}
],
- "description": "Describes the period to bill for upon accepting the quote."
+ "description": "Describes the period to bill for upon accepting the quote.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -169341,7 +184354,10 @@
"prorate_on_next_phase",
"prorate_up_front"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"description": "When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.",
@@ -169349,7 +184365,10 @@
"",
"reset"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -169364,7 +184383,10 @@
"type": "string"
}
],
- "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"effective_date": {
"anyOf": [
@@ -169386,7 +184408,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends.",
@@ -169394,14 +184419,20 @@
"cancel",
"release"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"anyOf": [
@@ -169425,7 +184456,10 @@
"type": "string"
}
],
- "description": "If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`."
+ "description": "If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.",
@@ -169434,7 +184468,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_period_days": {
"anyOf": [
@@ -169448,7 +184485,10 @@
"type": "string"
}
],
- "description": "Integer representing the number of trial period days before the customer is charged for the first time."
+ "description": "Integer representing the number of trial period days before the customer is charged for the first time.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_data_update_params",
@@ -169465,12 +184505,18 @@
"new_reference": {
"description": "A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription_schedule": {
"description": "The ID of the schedule the line applies to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Describes whether the quote line is affecting a new schedule or an existing schedule.",
@@ -169500,20 +184546,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_from` time.",
@@ -169531,7 +184589,10 @@
"type"
],
"title": "bill_from_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bill_until": {
"description": "The end of the period to bill until when the Quote is accepted.",
@@ -169559,7 +184620,10 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line_ends_at": {
"description": "Details of a Quote line item from which to bill until.",
@@ -169567,20 +184631,32 @@
"id": {
"description": "The ID of a quote line.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "line_index_id_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of method to specify the `bill_until` time.",
@@ -169598,7 +184674,10 @@
"type"
],
"title": "bill_until_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bill_on_acceptance_specs",
@@ -169611,7 +184690,10 @@
"type": "string"
}
],
- "description": "Describes the period to bill for upon accepting the quote."
+ "description": "Describes the period to bill for upon accepting the quote.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_behavior": {
"description": "Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.",
@@ -169619,12 +184701,18 @@
"prorate_on_next_phase",
"prorate_up_front"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The customer the Subscription Data override applies to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -169639,7 +184727,10 @@
"type": "string"
}
],
- "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_behavior": {
"description": "Behavior of the subscription schedule and underlying subscription when it ends.",
@@ -169647,7 +184738,10 @@
"cancel",
"release"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.",
@@ -169656,7 +184750,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -169682,11 +184779,17 @@
"properties": {
"amount": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total 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.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -170457,7 +185560,10 @@
"reason": {
"description": "Reason the Quote is being marked stale.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -170492,7 +185598,7 @@
},
"/v1/quotes/{quote}/pdf": {
"get": {
- "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
+ "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
"operationId": "GetQuotesQuotePdf",
"parameters": [
{
@@ -171060,7 +186166,10 @@
"name": "charge",
"required": false,
"schema": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -171076,19 +186185,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -171144,7 +186265,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -171318,19 +186442,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -171397,7 +186533,10 @@
"required": false,
"schema": {
"maxLength": 800,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -171684,7 +186823,10 @@
"required": false,
"schema": {
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -171711,19 +186853,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -171903,14 +187057,20 @@
"us_bank_account_fingerprint"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The human-readable name of the value list.",
@@ -172104,7 +187264,10 @@
"alias": {
"description": "The name of the value list for use in rules.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -172119,12 +187282,18 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The human-readable name of the value list.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -172168,7 +187337,10 @@
"name": "charge",
"required": false,
"schema": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -172184,19 +187356,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -172251,7 +187435,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -172358,12 +187545,18 @@
"additionalProperties": false,
"properties": {
"amount": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"charge": {
"description": "The identifier of the charge to refund.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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).",
@@ -172384,7 +187577,10 @@
},
"instructions_email": {
"description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -172413,7 +187609,10 @@
"payment_intent": {
"description": "The identifier of the PaymentIntent to refund.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reason": {
"description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.",
@@ -172423,15 +187622,24 @@
"requested_by_customer"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_application_fee": {
"description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reverse_transfer": {
"description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
A transfer can be reversed only by the application that created the charge.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -172699,19 +187907,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -172880,29 +188100,47 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"connected_account": {
"description": "Connected account ID to filter for in the report run.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "Currency of objects to be included in the report run.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_end": {
"description": "Ending timestamp of data to be included in the report run (exclusive).",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_start": {
"description": "Starting timestamp of data to be included in the report run.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payout": {
"description": "Payout ID by which to filter the report run.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reporting_category": {
"description": "Category of balance transactions to be included in the report run.",
@@ -172947,7 +188185,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timezone": {
"description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.",
@@ -173552,11 +188793,17 @@
"Zulu"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "run_parameter_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"report_type": {
"description": "The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `\"balance.summary.1\"`.",
@@ -173841,19 +189088,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -174138,19 +189397,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -174322,19 +189593,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -174354,7 +189637,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -174401,7 +189687,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -174549,7 +189838,10 @@
"always",
"never"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"enabled": {
"description": "Whether this feature is enabled.",
@@ -174560,11 +189852,17 @@
"enabled"
],
"title": "automatic_payment_methods_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"confirm": {
"description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"confirmation_token": {
"description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.",
@@ -174574,12 +189872,18 @@
"customer": {
"description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -174610,13 +189914,19 @@
"accepted_at": {
"description": "The time at which the customer accepted the Mandate.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"offline": {
"description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
"properties": {},
"title": "offline_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"online": {
"description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
@@ -174636,7 +189946,10 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -174675,7 +189988,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The Stripe account ID created for this SetupIntent.",
@@ -174684,7 +190000,10 @@
"payment_method": {
"description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_configuration": {
"description": "The ID of the payment method configuration to use with this SetupIntent.",
@@ -174781,12 +190100,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -174808,32 +190133,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -174846,7 +190189,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -174860,7 +190206,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -174875,7 +190224,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -174890,11 +190242,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -174965,7 +190323,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -174981,7 +190342,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -175056,7 +190420,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -175093,7 +190460,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -175111,12 +190481,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -175170,7 +190549,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -175194,17 +190576,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -175228,7 +190619,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -175346,6 +190740,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -175377,12 +190772,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -175390,17 +190791,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -175437,7 +190847,10 @@
"cad",
"usd"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -175454,7 +190867,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_for": {
"description": "List of Stripe products where this mandate can be selected automatically.",
@@ -175465,12 +190881,18 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -175479,7 +190901,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -175487,11 +190912,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -175501,17 +190932,26 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay": {
"description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit": {
"description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.",
@@ -175520,11 +190960,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
@@ -175551,12 +190997,18 @@
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"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.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
@@ -175571,7 +191023,10 @@
},
"interval_count": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "Unique identifier for the mandate or subscription.",
@@ -175591,7 +191046,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -175603,11 +191061,17 @@
"start_date"
],
"title": "setup_intent_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"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.",
@@ -175627,7 +191091,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -175637,7 +191104,10 @@
"challenge"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"three_d_secure": {
"description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.",
@@ -175653,12 +191123,18 @@
"U",
"Y"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cryptogram": {
"description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"electronic_commerce_indicator": {
"description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
@@ -175670,7 +191146,10 @@
"07"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_options": {
"description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
@@ -175693,32 +191172,50 @@
"cb_exemption": {
"description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cb_score": {
"description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_id": {
"description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"version": {
"description": "The version of 3D Secure that was performed.",
@@ -175728,21 +191225,33 @@
"2.2.0"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_present": {
"description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
@@ -175750,11 +191259,17 @@
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
@@ -175762,10 +191277,16 @@
"billing_agreement_id": {
"description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -175773,11 +191294,17 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto": {
"description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.",
@@ -175787,7 +191314,10 @@
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
@@ -175795,12 +191325,18 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
@@ -175814,11 +191350,17 @@
"semi_annual",
"weekly"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
@@ -175835,20 +191377,32 @@
"tax",
"utility"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.",
@@ -175857,11 +191411,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.",
@@ -175882,16 +191442,25 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -175909,7 +191478,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -175924,7 +191496,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -175937,16 +191512,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -175958,11 +191542,17 @@
"paper"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Additional fields for network related functions",
@@ -175976,11 +191566,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -175990,11 +191586,17 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -176037,7 +191639,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"use_stripe_sdk": {
"description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.",
@@ -176206,12 +191811,18 @@
"customer": {
"description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -176252,7 +191863,10 @@
"payment_method": {
"description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_configuration": {
"description": "The ID of the payment method configuration to use with this SetupIntent.",
@@ -176349,12 +191963,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -176376,32 +191996,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -176414,7 +192052,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -176428,7 +192069,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -176443,7 +192087,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -176458,11 +192105,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -176533,7 +192186,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -176549,7 +192205,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -176624,7 +192283,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -176661,7 +192323,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -176679,12 +192344,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -176738,7 +192412,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -176762,17 +192439,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -176796,7 +192482,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -176914,6 +192603,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -176945,12 +192635,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -176958,17 +192654,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -177005,7 +192710,10 @@
"cad",
"usd"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -177022,7 +192730,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_for": {
"description": "List of Stripe products where this mandate can be selected automatically.",
@@ -177033,12 +192744,18 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -177047,7 +192764,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -177055,11 +192775,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -177069,17 +192795,26 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay": {
"description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit": {
"description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.",
@@ -177088,11 +192823,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
@@ -177119,12 +192860,18 @@
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"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.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
@@ -177139,7 +192886,10 @@
},
"interval_count": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "Unique identifier for the mandate or subscription.",
@@ -177159,7 +192909,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -177171,11 +192924,17 @@
"start_date"
],
"title": "setup_intent_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"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.",
@@ -177195,7 +192954,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -177205,7 +192967,10 @@
"challenge"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"three_d_secure": {
"description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.",
@@ -177221,12 +192986,18 @@
"U",
"Y"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cryptogram": {
"description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"electronic_commerce_indicator": {
"description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
@@ -177238,7 +193009,10 @@
"07"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_options": {
"description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
@@ -177261,32 +193035,50 @@
"cb_exemption": {
"description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cb_score": {
"description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_id": {
"description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"version": {
"description": "The version of 3D Secure that was performed.",
@@ -177296,21 +193088,33 @@
"2.2.0"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_present": {
"description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
@@ -177318,11 +193122,17 @@
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
@@ -177330,10 +193140,16 @@
"billing_agreement_id": {
"description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -177341,11 +193157,17 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto": {
"description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.",
@@ -177355,7 +193177,10 @@
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
@@ -177363,12 +193188,18 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
@@ -177382,11 +193213,17 @@
"semi_annual",
"weekly"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
@@ -177403,20 +193240,32 @@
"tax",
"utility"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.",
@@ -177425,11 +193274,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.",
@@ -177450,16 +193305,25 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -177477,7 +193341,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -177492,7 +193359,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -177505,16 +193375,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -177526,11 +193405,17 @@
"paper"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Additional fields for network related functions",
@@ -177544,11 +193429,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -177558,11 +193449,17 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -177643,7 +193540,10 @@
"requested_by_customer"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -177747,13 +193647,19 @@
"accepted_at": {
"description": "The time at which the customer accepted the Mandate.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"offline": {
"description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
"properties": {},
"title": "offline_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"online": {
"description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
@@ -177773,7 +193679,10 @@
"user_agent"
],
"title": "online_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
@@ -177815,12 +193724,18 @@
"properties": {
"ip_address": {
"description": "The IP address from which the Mandate was accepted by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the Mandate was accepted by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "online_param",
@@ -177857,7 +193772,10 @@
"payment_method": {
"description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_data": {
"description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.",
@@ -177949,12 +193867,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -177976,32 +193900,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -178014,7 +193956,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -178028,7 +193973,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -178043,7 +193991,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -178058,11 +194009,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -178133,7 +194090,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -178149,7 +194109,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -178224,7 +194187,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -178261,7 +194227,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -178279,12 +194248,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -178338,7 +194316,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -178362,17 +194343,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -178396,7 +194386,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -178514,6 +194507,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -178545,12 +194539,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -178558,17 +194558,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -178605,7 +194614,10 @@
"cad",
"usd"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -178622,7 +194634,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_for": {
"description": "List of Stripe products where this mandate can be selected automatically.",
@@ -178633,12 +194648,18 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval_description": {
"description": "Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "Payment schedule for the mandate.",
@@ -178647,7 +194668,10 @@
"interval",
"sporadic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_type": {
"description": "Transaction type of the mandate.",
@@ -178655,11 +194679,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -178669,17 +194699,26 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amazon_pay": {
"description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bacs_debit": {
"description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.",
@@ -178688,11 +194727,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
@@ -178719,12 +194764,18 @@
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"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.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
@@ -178739,7 +194790,10 @@
},
"interval_count": {
"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`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "Unique identifier for the mandate or subscription.",
@@ -178759,7 +194813,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -178771,11 +194828,17 @@
"start_date"
],
"title": "setup_intent_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"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.",
@@ -178795,7 +194858,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -178805,7 +194871,10 @@
"challenge"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"three_d_secure": {
"description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.",
@@ -178821,12 +194890,18 @@
"U",
"Y"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cryptogram": {
"description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"electronic_commerce_indicator": {
"description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
@@ -178838,7 +194913,10 @@
"07"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_options": {
"description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
@@ -178861,32 +194939,50 @@
"cb_exemption": {
"description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
"maxLength": 4,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cb_score": {
"description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"cb_avalgo"
],
"title": "cartes_bancaires_network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "network_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"requestor_challenge_indicator": {
"description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transaction_id": {
"description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"version": {
"description": "The version of 3D Secure that was performed.",
@@ -178896,21 +194992,33 @@
"2.2.0"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card_present": {
"description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.",
"properties": {},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"link": {
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
@@ -178918,11 +195026,17 @@
"persistent_token": {
"description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"paypal": {
"description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.",
@@ -178930,10 +195044,16 @@
"billing_agreement_id": {
"description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subsellers": {
"description": "The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.",
@@ -178941,11 +195061,17 @@
"maxLength": 32,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payto": {
"description": "If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.",
@@ -178955,7 +195081,10 @@
"properties": {
"amount": {
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.",
@@ -178963,12 +195092,18 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_schedule": {
"description": "The periodicity at which payments will be collected.",
@@ -178982,11 +195117,17 @@
"semi_annual",
"weekly"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payments_per_period": {
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purpose": {
"description": "The purpose for which payments are made. Defaults to retail.",
@@ -179003,20 +195144,32 @@
"tax",
"utility"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.",
@@ -179025,11 +195178,17 @@
"description": "Additional fields for Mandate creation",
"properties": {},
"title": "payment_method_options_mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"description": "If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.",
@@ -179050,16 +195209,25 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"manual_entry": {
"description": "Customize manual entry behavior",
@@ -179077,7 +195245,10 @@
"mode"
],
"title": "linked_account_options_manual_entry_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -179092,7 +195263,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -179105,16 +195279,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mandate_options": {
"description": "Additional fields for Mandate creation",
@@ -179126,11 +195309,17 @@
"paper"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Additional fields for network related functions",
@@ -179144,11 +195333,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Bank account verification method.",
@@ -179158,11 +195353,17 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "setup_intent_payment_method_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -179244,12 +195445,18 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"descriptor_code": {
"description": "A six-character code starting with SM present in the microdeposit sent to the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -179301,7 +195508,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -179317,19 +195527,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -179348,7 +195570,10 @@
"name": "currency",
"required": false,
"schema": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -179526,7 +195751,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minimum": {
"description": "The lower bound of the estimated range. If empty, represents no lower bound.",
@@ -179552,7 +195780,10 @@
"value"
],
"title": "delivery_estimate_bound",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "delivery_estimate",
@@ -179596,7 +195827,10 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -179606,7 +195840,10 @@
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -179614,14 +195851,20 @@
"currency"
],
"title": "fixed_amount",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
@@ -179641,7 +195884,10 @@
"enum": [
"fixed_amount"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -179781,7 +196027,10 @@
"properties": {
"active": {
"description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -179799,7 +196048,10 @@
"properties": {
"amount": {
"description": "A non-negative integer in cents representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
@@ -179808,18 +196060,27 @@
"inclusive",
"unspecified"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_option_update",
"type": "object"
},
"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).",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fixed_amount_update",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -180114,16 +196375,25 @@
"properties": {
"amount": {
"description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -180153,11 +196423,17 @@
"date": {
"description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the mandate was accepted or refused by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"offline": {
"description": "The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`",
@@ -180171,7 +196447,10 @@
"contact_email"
],
"title": "mandate_offline_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"online": {
"description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`",
@@ -180179,20 +196458,32 @@
"date": {
"description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the mandate was accepted or refused by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the mandate was accepted or refused by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_online_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"status": {
"description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).",
@@ -180212,19 +196503,28 @@
"online"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the mandate was accepted or refused by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"status"
],
"title": "mandate_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount": {
"anyOf": [
@@ -180238,11 +196538,17 @@
"type": "string"
}
],
- "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)"
+ "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "The currency specified by the mandate. (Must match `currency` of the source)",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"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)",
@@ -180252,7 +196558,10 @@
"variable"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"notification_method": {
"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).",
@@ -180264,7 +196573,10 @@
"stripe_email"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_params",
@@ -180274,12 +196586,18 @@
"additionalProperties": {
"type": "string"
},
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"original_source": {
"description": "The source to share.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "Information about the owner of the payment instrument that may be used or required by particular source types.",
@@ -180290,54 +196608,87 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "source_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "Owner's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Owner's full name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Owner's phone number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "owner",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"receiver": {
"description": "Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).",
@@ -180350,7 +196701,10 @@
"none"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "receiver_params",
@@ -180368,7 +196722,10 @@
"return_url"
],
"title": "redirect_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"source_order": {
"description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.",
@@ -180378,23 +196735,38 @@
"items": {
"properties": {
"amount": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"parent": {
"description": "The ID of the SKU being ordered.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"enum": [
@@ -180404,13 +196776,19 @@
"tax"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "order_item_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.",
@@ -180421,12 +196799,18 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
@@ -180436,17 +196820,26 @@
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -180458,29 +196851,44 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"address"
],
"title": "order_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shallow_order_specs",
@@ -180489,7 +196897,10 @@
"statement_descriptor": {
"description": "An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"token": {
"description": "An optional token used to create the source. When passed, token properties will override source parameters.",
@@ -180507,7 +196918,10 @@
"single_use"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -180663,7 +197077,10 @@
"properties": {
"amount": {
"description": "Amount associated with the source.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -180682,11 +197099,17 @@
"date": {
"description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the mandate was accepted or refused by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"offline": {
"description": "The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`",
@@ -180700,7 +197123,10 @@
"contact_email"
],
"title": "mandate_offline_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"online": {
"description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`",
@@ -180708,20 +197134,32 @@
"date": {
"description": "The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the mandate was accepted or refused by the customer.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the mandate was accepted or refused by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_online_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"status": {
"description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).",
@@ -180741,19 +197179,28 @@
"online"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the mandate was accepted or refused by the customer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"status"
],
"title": "mandate_acceptance_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount": {
"anyOf": [
@@ -180767,11 +197214,17 @@
"type": "string"
}
],
- "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)"
+ "description": "The amount specified by the mandate. (Leave null for a mandate covering all amounts)",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "The currency specified by the mandate. (Must match `currency` of the source)",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"interval": {
"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)",
@@ -180781,7 +197234,10 @@
"variable"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"notification_method": {
"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).",
@@ -180793,7 +197249,10 @@
"stripe_email"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_params",
@@ -180825,54 +197284,87 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "source_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "Owner's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Owner's full name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Owner's phone number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "owner",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"source_order": {
"description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.",
@@ -180882,23 +197374,38 @@
"items": {
"properties": {
"amount": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"parent": {
"description": "The ID of the SKU being ordered.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"enum": [
@@ -180908,13 +197415,19 @@
"tax"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "order_item_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.",
@@ -180925,12 +197438,18 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
@@ -180940,17 +197459,26 @@
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -180962,29 +197490,44 @@
"carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Recipient name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "Recipient phone (including extension).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"address"
],
"title": "order_shipping",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "order_params",
@@ -181443,7 +197986,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -181476,12 +198022,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -181531,7 +198083,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -181541,7 +198096,10 @@
"error_if_incomplete",
"pending_if_incomplete"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "The identifier of the plan to add to the subscription.",
@@ -181551,7 +198109,10 @@
"price": {
"description": "The ID of the price object.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
@@ -181600,7 +198161,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -181623,7 +198187,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.",
@@ -181632,7 +198199,10 @@
},
"quantity": {
"description": "The quantity you'd like to apply to the subscription item you're creating.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"subscription": {
"description": "The identifier of the subscription to modify.",
@@ -181666,7 +198236,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -181751,7 +198324,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.",
@@ -181933,7 +198509,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -181966,12 +198545,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -182045,7 +198630,10 @@
"error_if_incomplete",
"pending_if_incomplete"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "The identifier of the new plan for this subscription item.",
@@ -182055,7 +198643,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -182104,7 +198695,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -182127,7 +198721,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.",
@@ -182136,7 +198733,10 @@
},
"quantity": {
"description": "The quantity you'd like to apply to the subscription item you're creating.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -182358,7 +198958,10 @@
"increment",
"set"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -182439,19 +199042,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -182476,19 +199091,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -182513,19 +199140,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -182545,7 +199184,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -182597,19 +199239,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -182762,14 +199416,20 @@
"customer": {
"description": "The identifier of the customer to create the subscription schedule for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_settings": {
"description": "Object representing the subscription schedule's default settings.",
"properties": {
"application_fee_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Default settings for automatic tax computation.",
@@ -182783,7 +199443,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -182798,14 +199461,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"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).",
@@ -182813,7 +199482,10 @@
"automatic",
"phase_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_thresholds": {
"anyOf": [
@@ -182821,11 +199493,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -182838,7 +199516,10 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
@@ -182846,12 +199527,18 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -182866,7 +199553,10 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -182887,18 +199577,27 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule."
+ "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -182913,11 +199612,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_schedule_default_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"anyOf": [
@@ -182931,7 +199636,10 @@
"type": "string"
}
],
- "description": "The account on behalf of which to charge, for each of the associated subscription's invoices."
+ "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"anyOf": [
@@ -182939,7 +199647,10 @@
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -182959,7 +199670,10 @@
"type": "string"
}
],
- "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices."
+ "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "default_settings_params",
@@ -183020,7 +199734,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -183053,12 +199770,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -183089,7 +199812,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -183113,8 +199839,11 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -183131,7 +199860,10 @@
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -183158,11 +199890,17 @@
"class_name": "AddInvoiceItem"
}
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Automatic tax settings for this phase.",
@@ -183176,7 +199914,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -183191,14 +199932,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"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).",
@@ -183206,7 +199953,10 @@
"automatic",
"phase_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_thresholds": {
"anyOf": [
@@ -183214,11 +199964,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -183231,7 +199987,10 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
@@ -183239,21 +199998,33 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -183271,7 +200042,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -183286,7 +200060,10 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -183296,7 +200073,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -183329,12 +200109,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -183369,12 +200155,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
+ "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -183395,18 +200187,27 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."
+ "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -183421,11 +200222,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -183453,7 +200260,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -183463,7 +200273,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -183496,12 +200309,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -183536,24 +200355,36 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
@@ -183602,7 +200433,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -183620,7 +200454,10 @@
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -183638,7 +200475,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -183649,7 +200489,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -183664,7 +200507,10 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "configuration_item_params",
@@ -183674,18 +200520,27 @@
},
"iterations": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"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`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The account on behalf of which to charge, for each of the associated subscription's invoices.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pause_collection": {
"description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).",
@@ -183704,7 +200559,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"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`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -183713,14 +200571,20 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -183731,11 +200595,17 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_continuation": {
"description": "Specify trial behavior when crossing phase boundaries",
@@ -183743,12 +200613,18 @@
"continue",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"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`",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -183762,15 +200638,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -183779,7 +200664,10 @@
"title": "phase_configuration_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"description": "If specified, the invoicing for the given billing cycle iterations will be processed now.",
@@ -183794,7 +200682,10 @@
"prebill",
"reset"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -183973,7 +200864,10 @@
"properties": {
"application_fee_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Default settings for automatic tax computation.",
@@ -183987,7 +200881,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -184002,14 +200899,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"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).",
@@ -184017,7 +200920,10 @@
"automatic",
"phase_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_thresholds": {
"anyOf": [
@@ -184025,11 +200931,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -184042,7 +200954,10 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
@@ -184050,12 +200965,18 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -184070,7 +200991,10 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -184091,18 +201015,27 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule."
+ "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -184117,11 +201050,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_schedule_default_settings_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"anyOf": [
@@ -184135,7 +201074,10 @@
"type": "string"
}
],
- "description": "The account on behalf of which to charge, for each of the associated subscription's invoices."
+ "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"anyOf": [
@@ -184143,7 +201085,10 @@
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -184163,7 +201108,10 @@
"type": "string"
}
],
- "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices."
+ "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "default_settings_params",
@@ -184219,7 +201167,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -184252,12 +201203,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -184288,7 +201245,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -184312,8 +201272,11 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -184330,7 +201293,10 @@
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -184357,11 +201323,17 @@
"class_name": "AddInvoiceItem"
}
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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 total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"automatic_tax": {
"description": "Automatic tax settings for this phase.",
@@ -184375,7 +201347,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -184390,14 +201365,20 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"enabled"
],
"title": "automatic_tax_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_cycle_anchor": {
"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).",
@@ -184405,7 +201386,10 @@
"automatic",
"phase_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"billing_thresholds": {
"anyOf": [
@@ -184413,11 +201397,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -184430,7 +201420,10 @@
"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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"collection_method": {
"description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.",
@@ -184438,21 +201431,33 @@
"charge_automatically",
"send_invoice"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"coupon": {
"description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_payment_method": {
"description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_tax_rates": {
"anyOf": [
@@ -184470,7 +201475,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"anyOf": [
@@ -184485,7 +201493,10 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -184495,7 +201506,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -184528,12 +201542,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -184568,7 +201588,10 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts."
+ "description": "The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_date": {
"anyOf": [
@@ -184584,7 +201607,10 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set."
+ "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -184605,18 +201631,27 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."
+ "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"days_until_due": {
"description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -184631,11 +201666,17 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"items": {
"description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.",
@@ -184663,7 +201704,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -184673,7 +201717,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -184706,12 +201753,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -184746,24 +201799,36 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
@@ -184812,7 +201877,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -184830,7 +201898,10 @@
},
"quantity": {
"description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -184848,7 +201919,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -184859,7 +201933,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -184874,7 +201951,10 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "configuration_item_params",
@@ -184884,18 +201964,27 @@
},
"iterations": {
"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.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"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`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"on_behalf_of": {
"description": "The account on behalf of which to charge, for each of the associated subscription's invoices.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pause_collection": {
"description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).",
@@ -184914,7 +202003,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"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`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.",
@@ -184923,7 +202015,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"start_date": {
"anyOf": [
@@ -184939,14 +202034,20 @@
"type": "string"
}
],
- "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase."
+ "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"transfer_data": {
"description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -184957,11 +202058,17 @@
"destination"
],
"title": "transfer_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_continuation": {
"description": "Specify trial behavior when crossing phase boundaries",
@@ -184969,7 +202076,10 @@
"continue",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_end": {
"anyOf": [
@@ -184985,7 +202095,10 @@
"type": "string"
}
],
- "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`"
+ "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`",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -184999,15 +202112,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -185016,7 +202138,10 @@
"title": "phase_configuration_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prebilling": {
"description": "If specified, the invoicing for the given billing cycle iterations will be processed now.",
@@ -185031,7 +202156,10 @@
"prebill",
"reset"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -185047,7 +202175,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -185140,7 +202271,10 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for the amendment starting from the `amendment_start`.",
@@ -185165,12 +202299,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_end`.",
@@ -185190,7 +202330,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amendment_start": {
"description": "Details to identify the earliest timestamp where the proposed change should take effect.",
@@ -185207,7 +202350,10 @@
"index"
],
"title": "amendment_end_index_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Use the `end` time of a given discount.",
@@ -185222,12 +202368,18 @@
"discount"
],
"title": "discount_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the amendment to start.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to pass the `amendment_start`.",
@@ -185256,7 +202408,10 @@
"amendment_start",
"automatic"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_actions": {
"description": "Changes to the coupons being redeemed or discounts being applied during the amendment time span.",
@@ -185268,12 +202423,18 @@
"coupon": {
"description": "The coupon code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount for a coupon that was already redeemed.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount_end": {
"description": "Details to determine how long the discount should be applied for.",
@@ -185290,20 +202451,32 @@
"type"
],
"title": "amendment_discount_end",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"index": {
"description": "The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The promotion code to redeem.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "add_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the discount to remove.",
@@ -185311,21 +202484,33 @@
"coupon": {
"description": "The coupon code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "The ID of a discount to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "The ID of a promotion code to remove from the `discounts` array.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "remove_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the discount to replace the existing discounts with.",
@@ -185333,21 +202518,33 @@
"coupon": {
"description": "The coupon code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "An ID of an existing discount to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"promotion_code": {
"description": "An ID of an existing promotion code to replace the `discounts` array with.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "set_discount_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of discount action.",
@@ -185365,7 +202562,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"item_actions": {
"description": "Changes to the subscription items during the amendment time span.",
@@ -185381,7 +202581,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -185414,12 +202617,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -185445,14 +202654,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -185461,7 +202676,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
@@ -185469,7 +202687,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Options that configure the trial on the subscription item.",
@@ -185480,7 +202701,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -185495,14 +202719,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "add_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Details of the subscription item to remove.",
@@ -185517,7 +202747,10 @@
"price"
],
"title": "remove_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"description": "Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.",
@@ -185529,7 +202762,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -185562,12 +202798,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -185593,14 +202835,20 @@
"title": "discounts_data_param",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
@@ -185609,7 +202857,10 @@
},
"quantity": {
"description": "If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"description": "If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.",
@@ -185617,7 +202868,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.",
@@ -185628,7 +202882,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -185643,14 +202900,20 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"price"
],
"title": "set_item_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of item action.",
@@ -185668,7 +202931,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata_actions": {
"description": "Instructions for how to modify phase metadata",
@@ -185679,7 +202945,10 @@
"type": "string"
},
"description": "Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"remove": {
"description": "Keys to remove from schedule phase metadata.",
@@ -185687,7 +202956,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set": {
"anyOf": [
@@ -185704,7 +202976,10 @@
"type": "string"
}
],
- "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten."
+ "description": "Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of three ways to update phase-level `metadata` on subscription schedules.",
@@ -185722,7 +202997,10 @@
"title": "specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_behavior": {
"description": "Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.",
@@ -185731,7 +203009,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_pause_collection": {
"description": "Defines how to pause collection for the underlying subscription throughout the duration of the amendment.",
@@ -185753,7 +203034,10 @@
"behavior"
],
"title": "pause_collection_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of the pause_collection amendment.",
@@ -185768,7 +203052,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"set_schedule_end": {
"description": "Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.",
@@ -185776,7 +203063,10 @@
"amendment_end",
"amendment_start"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial_settings": {
"description": "Settings related to subscription trials.",
@@ -185790,15 +203080,24 @@
"defer",
"include"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "end_behavior_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "trial_settings_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -185807,7 +203106,10 @@
"title": "amendment_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -185837,12 +203139,18 @@
"index"
],
"title": "amendment_start_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of several ways to pass the `bill_from` value.",
@@ -185858,7 +203166,10 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bill_until": {
"description": "The end of the prebilled time period.",
@@ -185875,7 +203186,10 @@
"index"
],
"title": "amendment_end_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"duration": {
"description": "Time span for prebilling, starting from `bill_from`.",
@@ -185900,12 +203214,18 @@
"interval_count"
],
"title": "duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "End the prebilled period at a precise integer timestamp, starting from the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Select one of several ways to pass the `bill_until` value.",
@@ -185922,14 +203242,20 @@
"type"
],
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"invoice_at": {
"description": "When the prebilling invoice should be created. The default value is `now`.",
"enum": [
"now"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"update_behavior": {
"description": "Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.",
@@ -185937,7 +203263,10 @@
"prebill",
"reset"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "specs",
@@ -185961,7 +203290,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"schedule_settings": {
"description": "Changes to apply to the subscription schedule.",
@@ -185972,11 +203304,17 @@
"cancel",
"release"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -186047,7 +203385,10 @@
},
"invoice_now": {
"description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prorate": {
"description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.",
@@ -186207,19 +203548,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -186243,19 +203596,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -186279,19 +203644,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -186311,7 +203688,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -186369,7 +203749,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -186402,7 +203785,10 @@
"trialing",
"unpaid"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -186584,7 +203970,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -186617,12 +204006,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -186653,7 +204048,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -186677,8 +204075,11 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -186695,7 +204096,10 @@
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -186750,7 +204154,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -186765,7 +204172,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -186794,19 +204204,31 @@
},
"hour": {
"description": "The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"minute": {
"description": "The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"month": {
"description": "The month to start full cycle billing periods. Ranges from 1 to 12.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"second": {
"description": "The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -186821,11 +204243,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -186847,7 +204275,10 @@
},
"cancel_at_period_end": {
"description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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`.",
@@ -186864,7 +204295,10 @@
},
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "The identifier of the customer to subscribe.",
@@ -186878,7 +204312,10 @@
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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).",
@@ -186906,7 +204343,10 @@
"description": {
"description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -186916,7 +204356,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -186949,12 +204392,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -187018,14 +204467,20 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription."
+ "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -187040,7 +204495,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings_param",
@@ -187072,7 +204530,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -187082,7 +204543,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -187115,12 +204579,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -187155,24 +204625,36 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "Plan ID for this item, as a string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
@@ -187221,7 +204703,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -187239,7 +204724,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -187257,7 +204745,10 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"trial": {
"description": "Define options to configure the trial on the subscription item.",
@@ -187268,7 +204759,10 @@
"maxLength": 5000,
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Determines the type of trial for this item.",
@@ -187283,13 +204777,19 @@
"type"
],
"title": "trial_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_item_create_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -187334,7 +204834,10 @@
"error_if_incomplete",
"pending_if_incomplete"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_settings": {
"description": "Payment settings to pass to invoices created by the subscription.",
@@ -187355,11 +204858,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -187369,7 +204878,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -187382,7 +204894,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -187396,7 +204911,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -187409,7 +204927,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -187420,7 +204941,10 @@
"properties": {
"amount": {
"description": "Amount to be charged for future payments.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"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.",
@@ -187428,16 +204952,25 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"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.",
@@ -187457,7 +204990,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -187466,7 +205002,10 @@
"automatic",
"challenge"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_payment_method_options_param",
@@ -187479,7 +205018,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -187501,19 +205043,31 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -187526,7 +205080,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"anyOf": [
@@ -187542,7 +205099,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -187558,7 +205118,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"anyOf": [
@@ -187579,16 +205142,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -187603,7 +205175,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -187616,11 +205191,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -187630,7 +205211,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -187643,11 +205227,17 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_types": {
"anyOf": [
@@ -187697,7 +205287,10 @@
"type": "string"
}
],
- "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)."
+ "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).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"save_default_payment_method": {
"description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.",
@@ -187705,7 +205298,10 @@
"off",
"on_subscription"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_settings",
@@ -187727,7 +205323,10 @@
},
"interval_count": {
"description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -187758,7 +205357,10 @@
"prebill",
"reset"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -187786,7 +205388,10 @@
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -187912,7 +205517,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -187923,7 +205531,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -188067,7 +205678,10 @@
"type": "string"
}
],
- "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user."
+ "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"feedback": {
"description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.",
@@ -188082,7 +205696,10 @@
"too_expensive",
"unused"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "cancellation_details_param",
@@ -188322,7 +205939,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -188355,12 +205975,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -188391,7 +206017,10 @@
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -188415,8 +206044,11 @@
"type": "string"
},
"unit_amount": {
- "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.",
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -188433,7 +206065,10 @@
},
"quantity": {
"description": "Quantity for this item. Defaults to 1.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -188488,7 +206123,10 @@
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -188503,7 +206141,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -188528,11 +206169,17 @@
"properties": {
"amount_gte": {
"description": "Monetary threshold that triggers the subscription to advance to a new billing period",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reset_billing_cycle_anchor": {
"description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_thresholds_param",
@@ -188564,7 +206211,10 @@
},
"cancel_at_period_end": {
"description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cancellation_details": {
"description": "Details about why this subscription was cancelled",
@@ -188582,7 +206232,10 @@
"type": "string"
}
],
- "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user."
+ "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"feedback": {
"description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.",
@@ -188597,7 +206250,10 @@
"too_expensive",
"unused"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "cancellation_details_param",
@@ -188623,7 +206279,10 @@
"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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"default_source": {
"anyOf": [
@@ -188681,7 +206340,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -188714,12 +206376,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -188783,14 +206451,20 @@
"type": "string"
}
],
- "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription."
+ "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"issuer": {
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
"properties": {
"account": {
"description": "The connected account being referenced when `type` is `account`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of the account referenced in the request.",
@@ -188805,7 +206479,10 @@
"type"
],
"title": "param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_settings_param",
@@ -188837,15 +206514,24 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"clear_usage": {
"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`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deleted": {
"description": "A flag that, if set to `true`, will delete the specified item.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discounts": {
"anyOf": [
@@ -188855,7 +206541,10 @@
"coupon": {
"description": "ID of the coupon to create a new discount for.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"discount": {
"description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
@@ -188888,12 +206577,18 @@
"interval_count"
],
"title": "discount_end_duration_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"timestamp": {
"description": "A precise Unix timestamp for the discount to end. Must be in the future.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of calculation made to determine when the discount ends.",
@@ -188928,12 +206623,18 @@
"type": "string"
}
],
- "description": "The coupons to redeem into discounts for the subscription item."
+ "description": "The coupons to redeem into discounts for the subscription item.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "Subscription item to update.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -188950,17 +206651,26 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"plan": {
"description": "Plan ID for this item, as a string.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price": {
"description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
@@ -189009,7 +206719,10 @@
},
"unit_amount": {
"description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_amount_decimal": {
"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.",
@@ -189027,7 +206740,10 @@
},
"quantity": {
"description": "Quantity for this item.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_rates": {
"anyOf": [
@@ -189045,13 +206761,19 @@
"type": "string"
}
],
- "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."
+ "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.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_item_update_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -189104,7 +206826,10 @@
"resumes_at": {
"description": "The time after which the subscription will resume collecting payments.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -189130,7 +206855,10 @@
"error_if_incomplete",
"pending_if_incomplete"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_settings": {
"description": "Payment settings to pass to invoices created by the subscription.",
@@ -189151,11 +206879,17 @@
"business",
"personal"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -189165,7 +206899,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -189178,7 +206915,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bancontact": {
"anyOf": [
@@ -189192,7 +206932,10 @@
"fr",
"nl"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -189205,7 +206948,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -189216,7 +206962,10 @@
"properties": {
"amount": {
"description": "Amount to be charged for future payments.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"amount_type": {
"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.",
@@ -189224,16 +206973,25 @@
"fixed",
"maximum"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "mandate_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"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.",
@@ -189253,7 +207011,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"request_three_d_secure": {
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
@@ -189262,7 +207023,10 @@
"automatic",
"challenge"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "subscription_payment_method_options_param",
@@ -189275,7 +207039,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer_balance": {
"anyOf": [
@@ -189297,19 +207064,31 @@
"country"
],
"title": "eu_bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bank_transfer_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"funding_type": {
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -189322,7 +207101,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"konbini": {
"anyOf": [
@@ -189338,7 +207120,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sepa_debit": {
"anyOf": [
@@ -189354,7 +207139,10 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_bank_account": {
"anyOf": [
@@ -189375,16 +207163,25 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"institution": {
"description": "ID of the institution to use to filter for selectable accounts.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_filters_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"permissions": {
"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`.",
@@ -189399,7 +207196,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"prefetch": {
"description": "List of data features that you would like to retrieve upon account creation.",
@@ -189412,11 +207212,17 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_linked_account_options_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification_method": {
"description": "Verification method for the intent",
@@ -189426,7 +207232,10 @@
"microdeposits"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "invoice_payment_method_options_param",
@@ -189439,11 +207248,17 @@
"type": "string"
}
],
- "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent."
+ "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_types": {
"anyOf": [
@@ -189493,7 +207308,10 @@
"type": "string"
}
],
- "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)."
+ "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).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"save_default_payment_method": {
"description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.",
@@ -189501,7 +207319,10 @@
"off",
"on_subscription"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_settings",
@@ -189523,7 +207344,10 @@
},
"interval_count": {
"description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -189554,7 +207378,10 @@
"prebill",
"reset"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -189575,7 +207402,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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#upcoming_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.",
@@ -189588,7 +207418,10 @@
"properties": {
"amount_percent": {
"description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
- "type": "number"
+ "type": "number",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "ID of an existing, connected Stripe account.",
@@ -189778,7 +207611,10 @@
"unchanged"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -189795,7 +207631,10 @@
"create_prorations",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"proration_date": {
"description": "If set, the proration will be calculated as though the subscription was resumed 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.",
@@ -189962,7 +207801,10 @@
"type": "string"
}
],
- "description": "City, district, suburb, town, or village."
+ "description": "City, district, suburb, town, or village.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
@@ -189982,7 +207824,10 @@
"type": "string"
}
],
- "description": "Address line 1 (e.g., street, PO Box, or company name)."
+ "description": "Address line 1 (e.g., street, PO Box, or company name).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"anyOf": [
@@ -189997,7 +207842,10 @@
"type": "string"
}
],
- "description": "Address line 2 (e.g., apartment, suite, unit, or building)."
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"anyOf": [
@@ -190012,7 +207860,10 @@
"type": "string"
}
],
- "description": "ZIP or postal code."
+ "description": "ZIP or postal code.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"anyOf": [
@@ -190027,14 +207878,20 @@
"type": "string"
}
],
- "description": "State, county, province, or region. We recommend sending [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code value when possible."
+ "description": "State, county, province, or region. We recommend sending [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code value when possible.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"country"
],
"title": "postal_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_source": {
"description": "The type of customer address provided.",
@@ -190042,18 +207899,24 @@
"billing",
"shipping"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip_address": {
"description": "The customer's IP address (IPv4 or IPv6).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_ids": {
"description": "The customer's tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn't validate tax IDs for correctness.",
"items": {
"properties": {
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -190087,6 +207950,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -190145,7 +208009,10 @@
"title": "data_params",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"taxability_override": {
"description": "Overrides the tax calculation result to allow you to not collect tax from your customer. Use this if you've manually checked your customer's tax exemptions. Prefer providing the customer's `tax_ids` where possible, which automatically determines whether `reverse_charge` applies.",
@@ -190154,11 +208021,17 @@
"none",
"reverse_charge"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "customer_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -190179,16 +208052,25 @@
"product": {
"description": "If provided, the product's `tax_code` will be used as the line item's `tax_code`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"description": "The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported [tax reports](https://stripe.com/docs/tax/reports).",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the `amount` includes taxes. Defaults to `exclusive`.",
@@ -190196,11 +208078,17 @@
"exclusive",
"inclusive"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID to use for this line item. If not provided, we will use the tax code from the provided `product` param. If neither `tax_code` nor `product` is provided, we will use the default tax code from your Tax Settings.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -190230,7 +208118,10 @@
"type": "string"
}
],
- "description": "City, district, suburb, town, or village."
+ "description": "City, district, suburb, town, or village.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
@@ -190250,7 +208141,10 @@
"type": "string"
}
],
- "description": "Address line 1 (e.g., street, PO Box, or company name)."
+ "description": "Address line 1 (e.g., street, PO Box, or company name).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"anyOf": [
@@ -190265,7 +208159,10 @@
"type": "string"
}
],
- "description": "Address line 2 (e.g., apartment, suite, unit, or building)."
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"anyOf": [
@@ -190280,7 +208177,10 @@
"type": "string"
}
],
- "description": "ZIP or postal code."
+ "description": "ZIP or postal code.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"anyOf": [
@@ -190295,7 +208195,10 @@
"type": "string"
}
],
- "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\"."
+ "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\".",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -190316,12 +208219,18 @@
"properties": {
"amount": {
"description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping_rate": {
"description": "If provided, the [shipping rate](https://stripe.com/docs/api/shipping_rates/object)'s `amount`, `tax_code` and `tax_behavior` are used. If you provide a shipping rate, then you cannot pass the `amount`, `tax_code`, or `tax_behavior` parameters.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_behavior": {
"description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Defaults to `exclusive`.",
@@ -190329,15 +208238,24 @@
"exclusive",
"inclusive"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
- "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](/settings/tax) is used.",
- "type": "string"
+ "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) used to calculate tax on shipping. If not provided, the default shipping tax code from your [Tax Settings](https://dashboard.stripe.com/settings/tax) is used.",
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "shipping_cost",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_date": {
"description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.",
@@ -190468,7 +208386,10 @@
"required": false,
"schema": {
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -190493,7 +208414,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -190504,7 +208428,10 @@
"required": false,
"schema": {
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -190635,14 +208562,20 @@
"account": {
"description": "The ID of the Stripe account whose forms will be retrieved.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Specifies the payee type. Always `account`.",
"enum": [
"account"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payee_params",
@@ -190672,7 +208605,10 @@
"us_1099_misc",
"us_1099_nec"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -190956,7 +208892,10 @@
"expired",
"scheduled"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -191095,7 +209034,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"at": {
"description": "Options for the registration in AT.",
@@ -191116,7 +209058,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191133,7 +209078,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"au": {
"description": "Options for the registration in AU.",
@@ -191150,7 +209098,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"be": {
"description": "Options for the registration in BE.",
@@ -191171,7 +209122,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191188,7 +209142,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bg": {
"description": "Options for the registration in BG.",
@@ -191209,7 +209166,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191226,7 +209186,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bh": {
"description": "Options for the registration in BH.",
@@ -191243,7 +209206,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ca": {
"description": "Options for the registration in CA.",
@@ -191261,7 +209227,10 @@
"province"
],
"title": "province_standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in Canada.",
@@ -191277,7 +209246,10 @@
"type"
],
"title": "canada",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ch": {
"description": "Options for the registration in CH.",
@@ -191294,7 +209266,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cl": {
"description": "Options for the registration in CL.",
@@ -191311,7 +209286,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"co": {
"description": "Options for the registration in CO.",
@@ -191328,7 +209306,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cy": {
"description": "Options for the registration in CY.",
@@ -191349,7 +209330,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191366,7 +209350,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cz": {
"description": "Options for the registration in CZ.",
@@ -191387,7 +209374,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191404,7 +209394,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"de": {
"description": "Options for the registration in DE.",
@@ -191425,7 +209418,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191442,7 +209438,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dk": {
"description": "Options for the registration in DK.",
@@ -191463,7 +209462,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191480,7 +209482,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ee": {
"description": "Options for the registration in EE.",
@@ -191501,7 +209506,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191518,7 +209526,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eg": {
"description": "Options for the registration in EG.",
@@ -191535,7 +209546,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"es": {
"description": "Options for the registration in ES.",
@@ -191556,7 +209570,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191573,7 +209590,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fi": {
"description": "Options for the registration in FI.",
@@ -191594,7 +209614,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191611,7 +209634,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fr": {
"description": "Options for the registration in FR.",
@@ -191632,7 +209658,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191649,7 +209678,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gb": {
"description": "Options for the registration in GB.",
@@ -191666,7 +209698,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ge": {
"description": "Options for the registration in GE.",
@@ -191683,7 +209718,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gr": {
"description": "Options for the registration in GR.",
@@ -191704,7 +209742,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191721,7 +209762,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"hr": {
"description": "Options for the registration in HR.",
@@ -191742,7 +209786,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191759,7 +209806,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"hu": {
"description": "Options for the registration in HU.",
@@ -191780,7 +209830,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191797,7 +209850,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id": {
"description": "Options for the registration in ID.",
@@ -191814,7 +209870,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ie": {
"description": "Options for the registration in IE.",
@@ -191835,7 +209894,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191852,7 +209914,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"is": {
"description": "Options for the registration in IS.",
@@ -191869,7 +209934,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"it": {
"description": "Options for the registration in IT.",
@@ -191890,7 +209958,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -191907,7 +209978,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"jp": {
"description": "Options for the registration in JP.",
@@ -191924,7 +209998,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ke": {
"description": "Options for the registration in KE.",
@@ -191941,7 +210018,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"kr": {
"description": "Options for the registration in KR.",
@@ -191958,7 +210038,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"kz": {
"description": "Options for the registration in KZ.",
@@ -191975,7 +210058,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Options for the registration in LT.",
@@ -191996,7 +210082,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192013,7 +210102,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lu": {
"description": "Options for the registration in LU.",
@@ -192034,7 +210126,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192051,7 +210146,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lv": {
"description": "Options for the registration in LV.",
@@ -192072,7 +210170,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192089,7 +210190,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mt": {
"description": "Options for the registration in MT.",
@@ -192110,7 +210214,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192127,7 +210234,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mx": {
"description": "Options for the registration in MX.",
@@ -192144,7 +210254,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"my": {
"description": "Options for the registration in MY.",
@@ -192161,7 +210274,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ng": {
"description": "Options for the registration in NG.",
@@ -192178,7 +210294,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nl": {
"description": "Options for the registration in NL.",
@@ -192199,7 +210318,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192216,7 +210338,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"no": {
"description": "Options for the registration in NO.",
@@ -192233,7 +210358,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nz": {
"description": "Options for the registration in NZ.",
@@ -192250,7 +210378,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"om": {
"description": "Options for the registration in OM.",
@@ -192267,7 +210398,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pl": {
"description": "Options for the registration in PL.",
@@ -192288,7 +210422,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192305,7 +210442,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pt": {
"description": "Options for the registration in PT.",
@@ -192326,7 +210466,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192343,7 +210486,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ro": {
"description": "Options for the registration in RO.",
@@ -192364,7 +210510,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192381,7 +210530,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sa": {
"description": "Options for the registration in SA.",
@@ -192398,7 +210550,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"se": {
"description": "Options for the registration in SE.",
@@ -192419,7 +210574,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192436,7 +210594,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sg": {
"description": "Options for the registration in SG.",
@@ -192453,7 +210614,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"si": {
"description": "Options for the registration in SI.",
@@ -192474,7 +210638,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192491,7 +210658,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sk": {
"description": "Options for the registration in SK.",
@@ -192512,7 +210682,10 @@
"place_of_supply_scheme"
],
"title": "standard",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of registration to be created in an EU country.",
@@ -192529,7 +210702,10 @@
"type"
],
"title": "europe",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"th": {
"description": "Options for the registration in TH.",
@@ -192546,7 +210722,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tr": {
"description": "Options for the registration in TR.",
@@ -192563,7 +210742,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us": {
"description": "Options for the registration in US.",
@@ -192581,7 +210763,10 @@
"jurisdiction"
],
"title": "local_amusement_tax",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"local_lease_tax": {
"description": "Options for the local lease tax registration.",
@@ -192596,7 +210781,10 @@
"jurisdiction"
],
"title": "local_lease_tax",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
@@ -192620,7 +210808,10 @@
"type"
],
"title": "united_states",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vn": {
"description": "Options for the registration in VN.",
@@ -192637,7 +210828,10 @@
"type"
],
"title": "simplified",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"za": {
"description": "Options for the registration in ZA.",
@@ -192654,7 +210848,10 @@
"type"
],
"title": "default",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "country_options",
@@ -192671,7 +210868,10 @@
"expires_at": {
"description": "If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -192978,15 +211178,24 @@
"inclusive",
"inferred_by_currency"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_code": {
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "defaults_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -193005,32 +211214,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"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\".",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "validated_country_address",
@@ -193041,7 +211268,10 @@
"address"
],
"title": "head_office_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -193112,7 +211342,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"posted_at": {
"description": "The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.",
@@ -193197,7 +211430,10 @@
},
"flat_amount": {
"description": "A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line_items": {
"description": "The line item amounts to reverse.",
@@ -193216,7 +211452,10 @@
"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"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"original_line_item": {
"description": "The `id` of the line item to reverse in the original transaction.",
@@ -193225,7 +211464,10 @@
},
"quantity": {
"description": "The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.",
@@ -193242,14 +211484,20 @@
"title": "transaction_line_item_reversal",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mode": {
"description": "If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.",
@@ -193404,7 +211652,10 @@
"required": false,
"schema": {
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -193429,7 +211680,10 @@
"name": "limit",
"required": false,
"schema": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -193440,7 +211694,10 @@
"required": false,
"schema": {
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -193771,12 +212028,18 @@
"properties": {
"account": {
"description": "Account the tax ID belongs to. Required when `type=account`",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "Customer the tax ID belongs to. Required when `type=customer`",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of owner referenced.",
@@ -193793,7 +212056,10 @@
"type"
],
"title": "owner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -193913,12 +212179,18 @@
"properties": {
"account": {
"description": "Account the tax ID belongs to. Required when `type=account`",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"customer": {
"description": "Customer the tax ID belongs to. Required when `type=customer`",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "Type of owner referenced.",
@@ -193938,7 +212210,7 @@
"type": "object"
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -193972,6 +212244,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -194187,7 +212460,10 @@
"name": "active",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -194203,19 +212479,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -194379,17 +212667,26 @@
"properties": {
"active": {
"description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"display_name": {
"description": "The display name of the tax rate, which will be shown to users.",
@@ -194411,14 +212708,20 @@
"jurisdiction": {
"description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentage": {
"description": "This represents the tax rate percent out of 100.",
@@ -194427,7 +212730,10 @@
"state": {
"description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_type": {
"description": "The high-level tax type, such as `vat` or `sales_tax`.",
@@ -194584,22 +212890,34 @@
"properties": {
"active": {
"description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"display_name": {
"description": "The display name of the tax rate, which will be shown to users.",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -194612,7 +212930,10 @@
"jurisdiction": {
"description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -194634,7 +212955,10 @@
"state": {
"description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.",
"maxLength": 2,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_type": {
"description": "The high-level tax type, such as `vat` or `sales_tax`.",
@@ -194723,7 +213047,10 @@
"name": "is_account_default",
"required": false,
"schema": {
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -194875,11 +213202,17 @@
"type": "string"
}
],
- "description": "A File ID representing an image you would like displayed on the reader."
+ "description": "A File ID representing an image you would like displayed on the reader.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bbpos_wise_pose",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -194952,11 +213285,17 @@
"type": "string"
}
],
- "description": "A File ID representing an image you would like displayed on the reader."
+ "description": "A File ID representing an image you would like displayed on the reader.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "stripe_s700",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tipping": {
"anyOf": [
@@ -194970,22 +213309,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cad": {
"description": "Tipping configuration for CAD",
@@ -194995,22 +213346,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"chf": {
"description": "Tipping configuration for CHF",
@@ -195020,22 +213383,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"czk": {
"description": "Tipping configuration for CZK",
@@ -195045,22 +213420,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dkk": {
"description": "Tipping configuration for DKK",
@@ -195070,22 +213457,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eur": {
"description": "Tipping configuration for EUR",
@@ -195095,22 +213494,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gbp": {
"description": "Tipping configuration for GBP",
@@ -195120,22 +213531,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"hkd": {
"description": "Tipping configuration for HKD",
@@ -195145,22 +213568,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"myr": {
"description": "Tipping configuration for MYR",
@@ -195170,22 +213605,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nok": {
"description": "Tipping configuration for NOK",
@@ -195195,22 +213642,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nzd": {
"description": "Tipping configuration for NZD",
@@ -195220,22 +213679,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sek": {
"description": "Tipping configuration for SEK",
@@ -195245,22 +213716,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sgd": {
"description": "Tipping configuration for SGD",
@@ -195270,22 +213753,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"usd": {
"description": "Tipping configuration for USD",
@@ -195295,22 +213790,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tipping",
@@ -195340,11 +213847,17 @@
"type": "string"
}
],
- "description": "A File ID representing an image you would like displayed on the reader."
+ "description": "A File ID representing an image you would like displayed on the reader.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verifone_p400",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -195569,7 +214082,10 @@
"type": "string"
}
],
- "description": "A File ID representing an image you would like displayed on the reader."
+ "description": "A File ID representing an image you would like displayed on the reader.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "bbpos_wise_pose",
@@ -195666,7 +214182,10 @@
"type": "string"
}
],
- "description": "A File ID representing an image you would like displayed on the reader."
+ "description": "A File ID representing an image you would like displayed on the reader.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "stripe_s700",
@@ -195693,22 +214212,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cad": {
"description": "Tipping configuration for CAD",
@@ -195718,22 +214249,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"chf": {
"description": "Tipping configuration for CHF",
@@ -195743,22 +214286,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"czk": {
"description": "Tipping configuration for CZK",
@@ -195768,22 +214323,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dkk": {
"description": "Tipping configuration for DKK",
@@ -195793,22 +214360,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"eur": {
"description": "Tipping configuration for EUR",
@@ -195818,22 +214397,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gbp": {
"description": "Tipping configuration for GBP",
@@ -195843,22 +214434,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"hkd": {
"description": "Tipping configuration for HKD",
@@ -195868,22 +214471,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"myr": {
"description": "Tipping configuration for MYR",
@@ -195893,22 +214508,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nok": {
"description": "Tipping configuration for NOK",
@@ -195918,22 +214545,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nzd": {
"description": "Tipping configuration for NZD",
@@ -195943,22 +214582,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sek": {
"description": "Tipping configuration for SEK",
@@ -195968,22 +214619,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sgd": {
"description": "Tipping configuration for SGD",
@@ -195993,22 +214656,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"usd": {
"description": "Tipping configuration for USD",
@@ -196018,22 +214693,34 @@
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percentages": {
"description": "Percentages displayed when collecting a tip",
"items": {
"type": "integer"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"smart_tip_threshold": {
"description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "currency_specific_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tipping",
@@ -196064,7 +214751,10 @@
"type": "string"
}
],
- "description": "A File ID representing an image you would like displayed on the reader."
+ "description": "A File ID representing an image you would like displayed on the reader.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verifone_p400",
@@ -196144,7 +214834,10 @@
"location": {
"description": "The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -196331,7 +215024,10 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
@@ -196341,22 +215037,34 @@
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -196605,36 +215313,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"configuration_overrides": {
"anyOf": [
@@ -196654,7 +215383,10 @@
"display_name": {
"description": "A name for the location.",
"maxLength": 1000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -196719,6 +215451,75 @@
}
}
},
+ "/v1/terminal/reader_collected_data/{reader_collected_data}": {
+ "get": {
+ "description": "Retrieve data collected using Reader hardware.
",
+ "operationId": "GetTerminalReaderCollectedDataReaderCollectedData",
+ "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"
+ },
+ {
+ "description": "The ID of the ReaderCollectedData to retrieve.",
+ "in": "path",
+ "name": "reader_collected_data",
+ "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/terminal.reader_collected_data"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/terminal/readers": {
"get": {
"description": "Returns a list of Reader objects.
",
@@ -196741,7 +215542,10 @@
"verifone_P400"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -196788,7 +215592,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -196799,7 +215606,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -196824,7 +215634,10 @@
"offline",
"online"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -196931,12 +215744,18 @@
"label": {
"description": "Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"location": {
"description": "The location to assign the reader to.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -197353,17 +216172,26 @@
"description": {
"description": "The description which will be displayed when collecting this input",
"maxLength": 350,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"skip_button": {
"description": "The skip button text",
"maxLength": 14,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"submit_button": {
"description": "The submit button text",
"maxLength": 30,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The title which will be displayed when collecting this input",
@@ -197379,7 +216207,10 @@
},
"required": {
"description": "Indicate that this input is required, disabling the skip button",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"selection": {
"description": "Options for the `selection` input",
@@ -197394,7 +216225,10 @@
"primary",
"secondary"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"value": {
"description": "The text which will be shown on the button for this choice",
@@ -197427,17 +216261,26 @@
"disabled",
"enabled"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "The description which will be displayed for the toggle",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The title which will be displayed for the toggle",
"maxLength": 50,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "toggle_params",
@@ -197472,7 +216315,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -197545,22 +216391,34 @@
"properties": {
"enable_customer_cancellation": {
"description": "Enables cancel button on transaction screens.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"skip_tipping": {
"description": "Override showing a tipping selection screen on this transaction.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tipping": {
"description": "Tipping configuration for this transaction.",
"properties": {
"amount_eligible": {
"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).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tipping_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "collect_config",
@@ -197738,22 +216596,34 @@
"properties": {
"enable_customer_cancellation": {
"description": "Enables cancel button on transaction screens.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"skip_tipping": {
"description": "Override showing a tipping selection screen on this transaction.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tipping": {
"description": "Tipping configuration for this transaction.",
"properties": {
"amount_eligible": {
"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).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "tipping_config",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "process_config",
@@ -197842,7 +216712,10 @@
"properties": {
"enable_customer_cancellation": {
"description": "Enables cancel button on transaction screens.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "process_setup_config",
@@ -197926,12 +216799,18 @@
"properties": {
"amount": {
"description": "A positive integer in __cents__ representing how much of this charge to refund.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"charge": {
"description": "ID of the Charge to refund.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -197946,23 +216825,35 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_intent": {
"description": "ID of the PaymentIntent to refund.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_application_fee": {
"description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refund_payment_config": {
"description": "Configuration overrides",
"properties": {
"enable_customer_cancellation": {
"description": "Enables cancel button on transaction screens.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "refund_payment_config",
@@ -197970,7 +216861,10 @@
},
"reverse_transfer": {
"description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -198072,7 +216966,10 @@
},
"tax": {
"description": "The amount of tax in cents.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total": {
"description": "Total balance of cart due in cents.",
@@ -198085,7 +216982,10 @@
"total"
],
"title": "cart",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -198171,7 +217071,10 @@
"payment_method": {
"description": "ID of an existing PaymentMethod.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method_data": {
"description": "If provided, this hash will be used to create a PaymentMethod.",
@@ -198263,12 +217166,18 @@
"account_number": {
"description": "Account number of the bank account that the funds will be debited from.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"sort_code": {
"description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -198290,32 +217199,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -198328,7 +217255,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -198342,7 +217272,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -198357,7 +217290,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -198372,11 +217308,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"blik": {
"description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
@@ -198447,7 +217389,10 @@
"vr_bank_braunau"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -198463,7 +217408,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bank": {
"description": "The customer's bank.",
@@ -198538,7 +217486,10 @@
"yoursafe"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -198575,7 +217526,10 @@
"year"
],
"title": "date_of_birth",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -198593,12 +217547,21 @@
"title": "param",
"type": "object"
},
+ "mb_way": {
+ "description": "If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"mobilepay": {
"description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
@@ -198652,7 +217615,10 @@
"volkswagen_bank"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -198676,17 +217642,26 @@
"account_number": {
"description": "The account number for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"bsb_number": {
"description": "Bank-State-Branch number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"pay_id": {
"description": "The PayID alias for the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "param",
@@ -198710,7 +217685,10 @@
"session": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "radar_options_with_hidden_options",
@@ -198828,6 +217806,7 @@
"klarna",
"konbini",
"link",
+ "mb_way",
"mobilepay",
"multibanco",
"oxxo",
@@ -198859,12 +217838,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -198872,17 +217857,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -198905,11 +217899,17 @@
"type"
],
"title": "payment_method_data_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"return_url": {
"description": "Return URL used to confirm the Intent.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property 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.",
@@ -198917,7 +217917,10 @@
"off_session",
"on_session"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"shipping": {
"description": "Shipping information for this ConfirmationToken.",
@@ -198928,32 +217931,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "optional_fields_address",
@@ -198977,7 +217998,10 @@
"type": "string"
}
],
- "description": "Recipient phone (including extension)"
+ "description": "Recipient phone (including extension)",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -198985,7 +218009,10 @@
"name"
],
"title": "recipient_shipping_with_optional_fields_address",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -199151,11 +218178,17 @@
"properties": {
"atm_fee": {
"description": "The ATM withdrawal fee.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cashback_amount": {
"description": "The amount of cash requested by the cardholder.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "amount_details_specs",
@@ -199179,7 +218212,10 @@
},
"currency": {
"description": "The currency of the authorization. If not provided, defaults to the currency of the card. 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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -199198,30 +218234,48 @@
"driver_id": {
"description": "Driver ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"odometer": {
"description": "Odometer reading.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unspecified_id": {
"description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_id": {
"description": "User ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vehicle_number": {
"description": "Vehicle number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -199231,7 +218285,10 @@
"non_fuel_purchase"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reported_breakdown": {
"description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.",
@@ -199242,11 +218299,17 @@
"gross_amount_decimal": {
"description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -199254,11 +218317,17 @@
"gross_amount_decimal": {
"description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -199266,20 +218335,32 @@
"local_amount_decimal": {
"description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"national_amount_decimal": {
"description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -199289,7 +218370,10 @@
"self_service"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_testmode_authorization_specs",
@@ -199301,12 +218385,18 @@
"industry_product_code": {
"description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity_decimal": {
"description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
@@ -199318,7 +218408,10 @@
"unleaded_super"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit": {
"description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.",
@@ -199333,12 +218426,18 @@
"us_gallon"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost_decimal": {
"description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fuel_specs",
@@ -199650,47 +218749,74 @@
"wrecking_and_salvage_yards"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"city": {
"description": "City where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Country where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the seller",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_id": {
"description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terminal_id": {
"description": "An ID assigned by the seller to the location of the sale.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"description": "URL provided by the merchant on a 3DS request",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "merchant_data_specs",
@@ -199702,7 +218828,10 @@
"acquiring_institution_id": {
"description": "Identifier assigned to the acquirer by the card network.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "network_data_specs",
@@ -199718,7 +218847,10 @@
"mismatch",
"not_provided"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_postal_code_check": {
"description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.",
@@ -199727,7 +218859,10 @@
"mismatch",
"not_provided"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"authentication_exemption": {
"description": "The exemption applied to this authorization.",
@@ -199756,7 +218891,10 @@
"type"
],
"title": "authentication_exemption_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc_check": {
"description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.",
@@ -199765,7 +218903,10 @@
"mismatch",
"not_provided"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expiry_check": {
"description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record.",
@@ -199774,7 +218915,10 @@
"mismatch",
"not_provided"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"three_d_secure": {
"description": "3D Secure details.",
@@ -199795,7 +218939,10 @@
"result"
],
"title": "three_d_secure_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verification_data_specs",
@@ -199879,11 +219026,17 @@
"properties": {
"capture_amount": {
"description": "The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"close_authorization": {
"description": "Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -199905,30 +219058,48 @@
"driver_id": {
"description": "Driver ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"odometer": {
"description": "Odometer reading.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unspecified_id": {
"description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_id": {
"description": "User ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vehicle_number": {
"description": "Vehicle number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -199938,7 +219109,10 @@
"non_fuel_purchase"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reported_breakdown": {
"description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.",
@@ -199949,11 +219123,17 @@
"gross_amount_decimal": {
"description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -199961,11 +219141,17 @@
"gross_amount_decimal": {
"description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -199973,20 +219159,32 @@
"local_amount_decimal": {
"description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"national_amount_decimal": {
"description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -199996,11 +219194,17 @@
"self_service"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Information about the flight that was purchased with this transaction.",
@@ -200008,16 +219212,25 @@
"departure_at": {
"description": "The time that the flight departed.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the passenger.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refundable": {
"description": "Whether the ticket is refundable.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The legs of the trip.",
@@ -200026,46 +219239,73 @@
"arrival_airport_code": {
"description": "The three-letter IATA airport code of the flight's destination.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The airline carrier code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departure_airport_code": {
"description": "The three-letter IATA airport code that the flight departed from.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The flight's service class.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"stopover_allowed": {
"description": "Whether a stopover is allowed on this flight.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "flight_segment_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"travel_agency": {
"description": "The travel agency that issued the ticket.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "flight_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -200073,12 +219313,18 @@
"industry_product_code": {
"description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity_decimal": {
"description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
@@ -200090,7 +219336,10 @@
"unleaded_super"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit": {
"description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.",
@@ -200105,16 +219354,25 @@
"us_gallon"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost_decimal": {
"description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Information about lodging that was purchased with this transaction.",
@@ -200122,15 +219380,24 @@
"check_in_at": {
"description": "The time of checking into the lodging.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nights": {
"description": "The number of nights stayed at the lodging.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "lodging_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"receipt": {
"description": "The line items in the purchase.",
@@ -200138,32 +219405,53 @@
"properties": {
"description": {
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "receipt_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A merchant-specific order number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "purchase_details_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -200320,30 +219608,48 @@
"driver_id": {
"description": "Driver ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"odometer": {
"description": "Odometer reading.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unspecified_id": {
"description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_id": {
"description": "User ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vehicle_number": {
"description": "Vehicle number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -200353,7 +219659,10 @@
"non_fuel_purchase"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reported_breakdown": {
"description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.",
@@ -200364,11 +219673,17 @@
"gross_amount_decimal": {
"description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -200376,11 +219691,17 @@
"gross_amount_decimal": {
"description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -200388,20 +219709,32 @@
"local_amount_decimal": {
"description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"national_amount_decimal": {
"description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -200411,7 +219744,10 @@
"self_service"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_specs",
@@ -200423,12 +219759,18 @@
"industry_product_code": {
"description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity_decimal": {
"description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
@@ -200440,7 +219782,10 @@
"unleaded_super"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit": {
"description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.",
@@ -200455,12 +219800,18 @@
"us_gallon"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost_decimal": {
"description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fuel_specs",
@@ -200542,7 +219893,10 @@
},
"is_amount_controllable": {
"description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -200616,7 +219970,10 @@
},
"reverse_amount": {
"description": "The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -201109,7 +220466,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier_text": {
"description": "The reason(s) the carrier text was rejected.",
@@ -201125,7 +220485,10 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "rejection_reasons_param",
@@ -201200,7 +220563,10 @@
},
"currency": {
"description": "The currency of the capture. If not provided, defaults to the currency of the card. 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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -201512,47 +220878,74 @@
"wrecking_and_salvage_yards"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"city": {
"description": "City where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Country where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the seller",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_id": {
"description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terminal_id": {
"description": "An ID assigned by the seller to the location of the sale.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"description": "URL provided by the merchant on a 3DS request",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "merchant_data_specs",
@@ -201570,30 +220963,48 @@
"driver_id": {
"description": "Driver ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"odometer": {
"description": "Odometer reading.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unspecified_id": {
"description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_id": {
"description": "User ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vehicle_number": {
"description": "Vehicle number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -201603,7 +221014,10 @@
"non_fuel_purchase"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reported_breakdown": {
"description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.",
@@ -201614,11 +221028,17 @@
"gross_amount_decimal": {
"description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -201626,11 +221046,17 @@
"gross_amount_decimal": {
"description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -201638,20 +221064,32 @@
"local_amount_decimal": {
"description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"national_amount_decimal": {
"description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -201661,11 +221099,17 @@
"self_service"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Information about the flight that was purchased with this transaction.",
@@ -201673,16 +221117,25 @@
"departure_at": {
"description": "The time that the flight departed.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the passenger.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refundable": {
"description": "Whether the ticket is refundable.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The legs of the trip.",
@@ -201691,46 +221144,73 @@
"arrival_airport_code": {
"description": "The three-letter IATA airport code of the flight's destination.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The airline carrier code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departure_airport_code": {
"description": "The three-letter IATA airport code that the flight departed from.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The flight's service class.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"stopover_allowed": {
"description": "Whether a stopover is allowed on this flight.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "flight_segment_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"travel_agency": {
"description": "The travel agency that issued the ticket.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "flight_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -201738,12 +221218,18 @@
"industry_product_code": {
"description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity_decimal": {
"description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
@@ -201755,7 +221241,10 @@
"unleaded_super"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit": {
"description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.",
@@ -201770,16 +221259,25 @@
"us_gallon"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost_decimal": {
"description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Information about lodging that was purchased with this transaction.",
@@ -201787,15 +221285,24 @@
"check_in_at": {
"description": "The time of checking into the lodging.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nights": {
"description": "The number of nights stayed at the lodging.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "lodging_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"receipt": {
"description": "The line items in the purchase.",
@@ -201803,28 +221310,46 @@
"properties": {
"description": {
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "receipt_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A merchant-specific order number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "purchase_details_specs",
@@ -201900,7 +221425,10 @@
},
"currency": {
"description": "The currency of the unlinked refund. If not provided, defaults to the currency of the card. 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"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -202212,47 +221740,74 @@
"wrecking_and_salvage_yards"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"city": {
"description": "City where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Country where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "Name of the seller",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_id": {
"description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State where the seller is located",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"terminal_id": {
"description": "An ID assigned by the seller to the location of the sale.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"url": {
"description": "URL provided by the merchant on a 3DS request",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "merchant_data_specs",
@@ -202270,30 +221825,48 @@
"driver_id": {
"description": "Driver ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"odometer": {
"description": "Odometer reading.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unspecified_id": {
"description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_id": {
"description": "User ID.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vehicle_number": {
"description": "Vehicle number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_cardholder_prompt_data_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"purchase_type": {
"description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
@@ -202303,7 +221876,10 @@
"non_fuel_purchase"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reported_breakdown": {
"description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.",
@@ -202314,11 +221890,17 @@
"gross_amount_decimal": {
"description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"non_fuel": {
"description": "Breakdown of non-fuel portion of the purchase.",
@@ -202326,11 +221908,17 @@
"gross_amount_decimal": {
"description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_non_fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax": {
"description": "Information about tax included in this transaction.",
@@ -202338,20 +221926,32 @@
"local_amount_decimal": {
"description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"national_amount_decimal": {
"description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_tax_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_reported_breakdown_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_type": {
"description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
@@ -202361,11 +221961,17 @@
"self_service"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fleet_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight": {
"description": "Information about the flight that was purchased with this transaction.",
@@ -202373,16 +221979,25 @@
"departure_at": {
"description": "The time that the flight departed.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passenger_name": {
"description": "The name of the passenger.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"refundable": {
"description": "Whether the ticket is refundable.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"segments": {
"description": "The legs of the trip.",
@@ -202391,46 +222006,73 @@
"arrival_airport_code": {
"description": "The three-letter IATA airport code of the flight's destination.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"carrier": {
"description": "The airline carrier code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"departure_airport_code": {
"description": "The three-letter IATA airport code that the flight departed from.",
"maxLength": 3,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"flight_number": {
"description": "The flight number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"service_class": {
"description": "The flight's service class.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"stopover_allowed": {
"description": "Whether a stopover is allowed on this flight.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "flight_segment_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"travel_agency": {
"description": "The travel agency that issued the ticket.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "flight_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"fuel": {
"description": "Information about fuel that was purchased with this transaction.",
@@ -202438,12 +222080,18 @@
"industry_product_code": {
"description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity_decimal": {
"description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
@@ -202455,7 +222103,10 @@
"unleaded_super"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit": {
"description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.",
@@ -202470,16 +222121,25 @@
"us_gallon"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost_decimal": {
"description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "fuel_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lodging": {
"description": "Information about lodging that was purchased with this transaction.",
@@ -202487,15 +222147,24 @@
"check_in_at": {
"description": "The time of checking into the lodging.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"nights": {
"description": "The number of nights stayed at the lodging.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "lodging_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"receipt": {
"description": "The line items in the purchase.",
@@ -202503,28 +222172,46 @@
"properties": {
"description": {
"maxLength": 26,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"quantity": {
"format": "decimal",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"total": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"unit_cost": {
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "receipt_specs",
"type": "object"
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"reference": {
"description": "A merchant-specific order number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "purchase_details_specs",
@@ -202603,7 +222290,10 @@
},
"refund_amount": {
"description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -202748,11 +222438,17 @@
"number": {
"description": "The card number, as a string without any separators.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "card_present",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -202768,7 +222464,10 @@
"number": {
"description": "Card Number",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "interac_present",
@@ -202781,7 +222480,10 @@
"interac_present"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -202970,7 +222672,10 @@
"name": {
"description": "The name for this test clock.",
"maxLength": 300,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -203260,11 +222965,17 @@
"no_account",
"other"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "failure_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -203487,7 +223198,10 @@
"trace_id"
],
"title": "ach_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The US bank account network used to send funds.",
@@ -203503,21 +223217,33 @@
"chips": {
"description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"imad": {
"description": "IMAD for funds sent over the `us_domestic_wire` network.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"omad": {
"description": "OMAD for funds sent over the `us_domestic_wire` network.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "us_domestic_wire_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -203751,11 +223477,17 @@
"no_account",
"other"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "returned_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -203844,7 +223576,10 @@
"trace_id"
],
"title": "ach_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The US bank account network used to send funds.",
@@ -203860,21 +223595,33 @@
"chips": {
"description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"imad": {
"description": "IMAD for funds sent over the `us_domestic_wire` network.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"omad": {
"description": "OMAD for funds sent over the `us_domestic_wire` network.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "us_domestic_wire_tracking_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -204108,11 +223855,17 @@
"no_account",
"other"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "returned_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -204180,7 +223933,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -204210,28 +223966,43 @@
"account_holder_name": {
"description": "The bank account holder's name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "The bank account number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "The bank account's routing number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "us_bank_account_source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"type"
],
"title": "source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
@@ -204250,11 +224021,17 @@
"addenda": {
"description": "ACH Addenda record",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "ach_network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of flow that originated the ReceivedCredit.",
@@ -204268,7 +224045,10 @@
"type"
],
"title": "network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -204342,7 +224122,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -204372,28 +224155,43 @@
"account_holder_name": {
"description": "The bank account holder's name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "The bank account number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "The bank account's routing number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "us_bank_account_source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
"type"
],
"title": "source_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network": {
"description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
@@ -204411,11 +224209,17 @@
"addenda": {
"description": "Addenda record data associated with this ReceivedDebit.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "ach_network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of flow that originated the ReceivedDebit.",
@@ -204429,7 +224233,10 @@
"type"
],
"title": "network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -204520,7 +224327,10 @@
"non_profit"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"company": {
"description": "Information about the company or business.",
@@ -204531,36 +224341,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the company's primary address (Japan only).",
@@ -204568,41 +224399,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kanji": {
"description": "The Kanji variation of the company's primary address (Japan only).",
@@ -204610,78 +224465,126 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"directors_provided": {
"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](/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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executives_provided": {
"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](/api/persons) for accounts with a `relationship.executive` requirement.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"export_license_id": {
"description": "The export license ID number of the company, also referred as Import Export Code (India only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"export_purpose_code": {
"description": "The purpose code to use for export transactions (India only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"description": "The company's legal name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name_kana": {
"description": "The Kana variation of the company's legal name (Japan only).",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name_kanji": {
"description": "The Kanji variation of the company's legal name (Japan only).",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owners_provided": {
"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](/api/persons) for accounts with a `relationship.owner` requirement.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ownership_declaration": {
"description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.",
@@ -204689,34 +224592,55 @@
"date": {
"description": "The Unix timestamp marking when the beneficial owner attestation was made.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the beneficial owner attestation was made.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"description": "The user agent of the browser from which the beneficial owner attestation was made.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "company_ownership_declaration",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ownership_declaration_shown_and_signed": {
"description": "Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The company's phone number (used for verification).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"registration_number": {
"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).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"structure": {
"description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.",
@@ -204747,22 +224671,34 @@
"unincorporated_partnership"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_id": {
"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.)",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tax_id_registrar": {
"description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"vat_id": {
"description": "The VAT number of the company.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "Information on the verification state of the company.",
@@ -204773,24 +224709,39 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "connect_js_account_token_company_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"individual": {
"description": "Information about the person represented by the account.",
@@ -204801,36 +224752,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the individual's primary address (Japan only).",
@@ -204838,41 +224810,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kanji": {
"description": "The Kanji variation of the individual's primary address (Japan only).",
@@ -204880,41 +224876,65 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"dob": {
"anyOf": [
@@ -204948,26 +224968,41 @@
"type": "string"
}
],
- "description": "The individual's date of birth."
+ "description": "The individual's date of birth.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"description": "The individual's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name": {
"description": "The individual's first name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kana": {
"description": "The Kana variation of the individual's first name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kanji": {
"description": "The Kanji variation of the individual's first name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"full_name_aliases": {
"anyOf": [
@@ -204985,41 +225020,65 @@
"type": "string"
}
],
- "description": "A list of alternate names or aliases that the individual is known by."
+ "description": "A list of alternate names or aliases that the individual is known by.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gender": {
"description": "The individual's gender (International regulations require either \"male\" or \"female\").",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id_number": {
"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](/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"id_number_secondary": {
"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](/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name": {
"description": "The individual's last name.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kana": {
"description": "The Kana variation of the individual's last name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kanji": {
"description": "The Kanji variation of the individual's last name (Japan only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"maiden_name": {
"description": "The individual's maiden name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"metadata": {
"anyOf": [
@@ -205036,11 +225095,17 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"description": "The individual's phone number.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -205048,7 +225113,10 @@
"existing",
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"registered_address": {
"description": "The individual's registered address.",
@@ -205056,51 +225124,81 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"relationship": {
"description": "Describes the person’s relationship to the account.",
"properties": {
"director": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executive": {
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_ownership": {
"anyOf": [
@@ -205114,21 +225212,33 @@
"type": "string"
}
],
- "description": "The percent owned by the person of the account's legal entity."
+ "description": "The percent owned by the person of the account's legal entity.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The person's title (e.g., CEO, Support Engineer).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ssn_last_4": {
"description": "The last four digits of the individual's Social Security Number (U.S. only).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "The individual's verification document information.",
@@ -205139,16 +225249,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -205156,28 +225275,46 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "individual_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"tos_shown_and_accepted": {
"description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "connect_js_account_token_specs",
@@ -205189,7 +225326,10 @@
"account_holder_name": {
"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.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_holder_type": {
"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.",
@@ -205198,7 +225338,10 @@
"individual"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "The account number for the bank account, in string form. Must be a checking account.",
@@ -205214,7 +225357,10 @@
"toza"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "The country in which the bank account is located.",
@@ -205223,17 +225369,26 @@
},
"currency": {
"description": "The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"payment_method": {
"description": "The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -205242,7 +225397,10 @@
],
"title": "token_create_bank_account",
"type": "object",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"card": {
"anyOf": [
@@ -205251,42 +225409,66 @@
"address_city": {
"description": "City / District / Suburb / Town / Village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_country": {
"description": "Billing address country, if provided.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_line1": {
"description": "Address line 1 (Street address / PO Box / Company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_line2": {
"description": "Address line 2 (Apartment / Suite / Unit / Building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_state": {
"description": "State / County / Province / Region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_zip": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc": {
"description": "Card security code. Highly recommended to always include this value.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"exp_month": {
"description": "Two-digit number representing the card's expiration month.",
@@ -205301,7 +225483,10 @@
"name": {
"description": "Cardholder's full name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"networks": {
"description": "Contains information about card networks used to process the payment.",
@@ -205313,11 +225498,17 @@
"mastercard",
"visa"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "networks_param_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"number": {
"description": "The card number, as a string without any separators.",
@@ -205347,7 +225538,10 @@
"customer": {
"description": "Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"cvc_update": {
"description": "The updated CVC value this token represents.",
@@ -205376,7 +225570,7 @@
"description": "Information for the person this token represents.",
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
@@ -205384,11 +225578,17 @@
"date": {
"description": "The Unix timestamp marking when the account representative accepted the service agreement.",
"format": "unix-time",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ip": {
"description": "The IP address from which the account representative accepted the service agreement.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"user_agent": {
"anyOf": [
@@ -205403,11 +225603,17 @@
"type": "string"
}
],
- "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ "description": "The user agent of the browser from which the account representative accepted the service agreement.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "settings_terms_of_service_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_additional_tos_acceptances_specs",
@@ -205419,36 +225625,57 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "legal_entity_and_kyc_address_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"address_kana": {
"description": "The Kana variation of the person's address (Japan only).",
@@ -205456,37 +225683,58 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kana_specs",
@@ -205498,37 +225746,58 @@
"city": {
"description": "City or ward.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Block or building number.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Building details.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "Postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "Prefecture.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"town": {
"description": "Town or cho-me.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "japan_address_kanji_specs",
@@ -205566,7 +225835,10 @@
"type": "string"
}
],
- "description": "The person's date of birth."
+ "description": "The person's date of birth.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"documents": {
"description": "Documents that may be submitted to satisfy various informational requests.",
@@ -205590,11 +225862,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"passport": {
"description": "One or more documents showing the person's passport page with photo and personal data.",
@@ -205615,11 +225893,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"visa": {
"description": "One or more documents showing the person's visa required for living in the country where they are residing.",
@@ -205640,11 +225924,17 @@
}
]
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "documents_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_documents_specs",
@@ -205652,12 +225942,18 @@
},
"email": {
"description": "The person's email address.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name": {
"description": "The person's first name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"first_name_kana": {
"description": "The Kana variation of the person's first name (Japan only).",
@@ -205694,7 +225990,10 @@
"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://docs.stripe.com/js/tokens/create_token?type=pii).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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://docs.stripe.com/js/tokens/create_token?type=pii).",
@@ -205704,7 +226003,10 @@
"last_name": {
"description": "The person's last name.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"last_name_kana": {
"description": "The Kana variation of the person's last name (Japan only).",
@@ -205736,7 +226038,10 @@
"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`."
+ "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`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -205745,7 +226050,10 @@
},
"phone": {
"description": "The person's phone number.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"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.",
@@ -205758,32 +226066,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 100,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 200,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "address_specs",
@@ -205794,19 +226120,31 @@
"properties": {
"director": {
"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.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"executive": {
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"legal_guardian": {
"description": "Whether the person is the legal guardian of the account's representative.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"percent_ownership": {
"anyOf": [
@@ -205820,24 +226158,39 @@
"type": "string"
}
],
- "description": "The percent owned by the person of the account's legal entity."
+ "description": "The percent owned by the person of the account's legal entity.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"representative": {
"description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.",
- "type": "boolean"
+ "type": "boolean",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"title": {
"description": "The person's title (e.g., CEO, Support Engineer).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "relationship_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"ssn_last_4": {
"description": "The last four digits of the person's Social Security number (U.S. only).",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"verification": {
"description": "The person's verification status.",
@@ -205848,16 +226201,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"document": {
"description": "An identifying document, either a passport or local ID card.",
@@ -205865,16 +226227,25 @@
"back": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"front": {
"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.",
"maxLength": 500,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_document_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "person_verification_specs",
@@ -205890,7 +226261,10 @@
"id_number": {
"description": "The `id_number` for the PII, in string form.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "pii_token_specs",
@@ -206012,19 +226386,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -206049,19 +226435,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -206134,7 +226532,10 @@
"succeeded"
],
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -206241,7 +226642,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -206418,7 +226822,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -206560,19 +226967,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -206592,7 +227011,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -206749,7 +227171,10 @@
"properties": {
"amount": {
"description": "A positive integer in cents (or local equivalent) representing how much to transfer.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"currency": {
"description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).",
@@ -206758,7 +227183,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination": {
"description": "The ID of a connected Stripe account. See the Connect documentation for details.",
@@ -206777,7 +227205,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"source_transaction": {
"description": "You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.",
@@ -207001,12 +227432,18 @@
"properties": {
"amount": {
"description": "A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -207169,7 +227606,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -207459,7 +227899,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -207485,7 +227928,10 @@
"posted",
"processing"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -207594,7 +228040,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"received_credit": {
"description": "The ReceivedCredit to reverse.",
@@ -207761,7 +228210,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -207775,7 +228227,10 @@
"lost",
"won"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -207801,7 +228256,10 @@
"completed",
"processing"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -207910,7 +228368,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"received_debit": {
"description": "The ReceivedDebit to reverse.",
@@ -208036,19 +228497,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -208254,7 +228727,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deposit_insurance": {
"description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.",
@@ -208268,7 +228744,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_addresses": {
"description": "Contains Features that add FinancialAddresses to the FinancialAccount.",
@@ -208285,11 +228764,17 @@
"requested"
],
"title": "aba_access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "financial_addresses",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"inbound_transfers": {
"description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.",
@@ -208306,11 +228791,17 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "inbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"intra_stripe_flows": {
"description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).",
@@ -208324,7 +228815,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_payments": {
"description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.",
@@ -208341,7 +228835,10 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundPayments API.",
@@ -208355,11 +228852,17 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "outbound_payments",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_transfers": {
"description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.",
@@ -208376,7 +228879,10 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundTransfers API.",
@@ -208390,22 +228896,34 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "outbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "feature_access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"platform_restrictions": {
"description": "The set of functionalities that the platform can restrict on the FinancialAccount.",
@@ -208416,7 +228934,10 @@
"restricted",
"unrestricted"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_flows": {
"description": "Restricts all outbound money movement.",
@@ -208424,11 +228945,17 @@
"restricted",
"unrestricted"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "platform_restrictions",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"supported_currencies": {
"description": "The currencies the FinancialAccount can hold a balance in.",
@@ -208620,7 +229147,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deposit_insurance": {
"description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.",
@@ -208634,7 +229164,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_addresses": {
"description": "Contains Features that add FinancialAddresses to the FinancialAccount.",
@@ -208651,11 +229184,17 @@
"requested"
],
"title": "aba_access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "financial_addresses",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"inbound_transfers": {
"description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.",
@@ -208672,11 +229211,17 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "inbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"intra_stripe_flows": {
"description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).",
@@ -208690,7 +229235,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_payments": {
"description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.",
@@ -208707,7 +229255,10 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundPayments API.",
@@ -208721,11 +229272,17 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "outbound_payments",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_transfers": {
"description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.",
@@ -208742,7 +229299,10 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundTransfers API.",
@@ -208756,22 +229316,34 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "outbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "feature_access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": 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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"platform_restrictions": {
"description": "The set of functionalities that the platform can restrict on the FinancialAccount.",
@@ -208782,7 +229354,10 @@
"restricted",
"unrestricted"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_flows": {
"description": "Restricts all outbound money movement.",
@@ -208790,11 +229365,17 @@
"restricted",
"unrestricted"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "platform_restrictions",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -208961,7 +229542,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"deposit_insurance": {
"description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.",
@@ -208975,7 +229559,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -209000,11 +229587,17 @@
"requested"
],
"title": "aba_access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "financial_addresses",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"inbound_transfers": {
"description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.",
@@ -209021,11 +229614,17 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "inbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"intra_stripe_flows": {
"description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).",
@@ -209039,7 +229638,10 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_payments": {
"description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.",
@@ -209056,7 +229658,10 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundPayments API.",
@@ -209070,11 +229675,17 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "outbound_payments",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"outbound_transfers": {
"description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.",
@@ -209091,7 +229702,10 @@
"requested"
],
"title": "access_with_ach_details",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"us_domestic_wire": {
"description": "Enables US domestic wire transfers via the OutboundTransfers API.",
@@ -209105,11 +229719,17 @@
"requested"
],
"title": "access",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "outbound_transfers",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
@@ -209216,7 +229836,10 @@
"processing",
"succeeded"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -209323,7 +229946,10 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -209342,7 +229968,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"origin_payment_method": {
"description": "The origin payment method to be debited for the InboundTransfer.",
@@ -209352,7 +229981,10 @@
"statement_descriptor": {
"description": "The complete description that appears on your customers' statements. Maximum 10 characters.",
"maxLength": 10,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -209543,19 +230175,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -209575,7 +230219,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -209649,7 +230296,10 @@
"processing",
"returned"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -209769,17 +230419,26 @@
"customer": {
"description": "ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination_payment_method": {
"description": "The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination_payment_method_data": {
"description": "Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.",
@@ -209794,32 +230453,50 @@
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_address",
@@ -209832,7 +230509,10 @@
"type": "string"
}
],
- "description": "Billing address."
+ "description": "Billing address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"email": {
"anyOf": [
@@ -209846,7 +230526,10 @@
"type": "string"
}
],
- "description": "Email address."
+ "description": "Email address.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"name": {
"anyOf": [
@@ -209861,7 +230544,10 @@
"type": "string"
}
],
- "description": "Full name."
+ "description": "Full name.",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"phone": {
"anyOf": [
@@ -209876,11 +230562,17 @@
"type": "string"
}
],
- "description": "Billing phone number (including extension)."
+ "description": "Billing phone number (including extension).",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "billing_details_inner_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_account": {
"description": "Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.",
@@ -209891,7 +230583,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
@@ -209910,12 +230605,18 @@
"company",
"individual"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_number": {
"description": "Account number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"account_type": {
"description": "Account type: checkings or savings. Defaults to checking if omitted.",
@@ -209923,17 +230624,26 @@
"checking",
"savings"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"financial_connections_account": {
"description": "The ID of a Financial Connections Account to use as a payment method.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"routing_number": {
"description": "Routing number of the bank account.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_param",
@@ -209944,7 +230654,10 @@
"type"
],
"title": "payment_method_data",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination_payment_method_options": {
"description": "Payment method-specific configuration for this OutboundPayment.",
@@ -209959,7 +230672,10 @@
"ach",
"us_domestic_wire"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -209972,18 +230688,27 @@
"type": "string"
}
],
- "description": "Optional fields for `us_bank_account`."
+ "description": "Optional fields for `us_bank_account`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"end_user_details": {
"description": "End user details.",
"properties": {
"ip_address": {
"description": "IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"present": {
"description": "`True` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.",
@@ -209994,7 +230719,10 @@
"present"
],
"title": "end_user_details_params",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -210013,12 +230741,18 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
"description": "The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is \"payment\".",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -210266,7 +231000,10 @@
"processing",
"returned"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -210381,12 +231118,18 @@
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination_payment_method": {
"description": "The PaymentMethod to use as the payment instrument for the OutboundTransfer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"destination_payment_method_options": {
"description": "Hash describing payment method configuration details.",
@@ -210401,7 +231144,10 @@
"ach",
"us_domestic_wire"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options_param",
@@ -210414,11 +231160,17 @@
"type": "string"
}
],
- "description": "Optional fields for `us_bank_account`."
+ "description": "Optional fields for `us_bank_account`.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "payment_method_options",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -210437,7 +231189,10 @@
"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",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"network_details": {
"description": "Details about the network used for the OutboundTransfer.",
@@ -210448,11 +231203,17 @@
"addenda": {
"description": "Addenda record data associated with this OutboundTransfer.",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "ach_network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"type": {
"description": "The type of flow that originated the OutboundTransfer.",
@@ -210466,12 +231227,18 @@
"type"
],
"title": "network_details_source",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"statement_descriptor": {
"description": "Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is \"transfer\".",
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"required": [
@@ -210719,7 +231486,10 @@
"source_flow_type"
],
"title": "linked_flows_param",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
},
@@ -210745,7 +231515,10 @@
"succeeded"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -210964,7 +231737,10 @@
"succeeded"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -211127,19 +231903,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -211163,19 +231951,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -211244,7 +232044,10 @@
"created",
"effective_at"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -211266,7 +232069,10 @@
"required": false,
"schema": {
"maxLength": 5000,
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
}
@@ -211430,19 +232236,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -211512,7 +232330,10 @@
"posted_at"
],
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -211538,7 +232359,10 @@
"posted",
"void"
],
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "form"
},
@@ -211556,19 +232380,31 @@
"properties": {
"gt": {
"description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"gte": {
"description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lt": {
"description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"lte": {
"description": "Maximum value to filter by (inclusive)",
- "type": "integer"
+ "type": "integer",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "range_query_specs",
@@ -211578,11 +232414,17 @@
"type": "integer"
}
],
- "description": "Returns Transactions with `posted_at` within the specified range."
+ "description": "Returns Transactions with `posted_at` within the specified range.",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"title": "status_transition_timestamp_specs",
- "type": "object"
+ "type": "object",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"style": "deepObject"
}
@@ -211988,7 +232830,10 @@
],
"maxLength": 5000,
"type": "string",
- "x-stripeBypassValidation": true
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"connect": {
"description": "Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.",
@@ -212797,7 +233642,10 @@
"type": "string",
"x-stripeBypassValidation": true
},
- "type": "array"
+ "type": "array",
+ "x-stripeParam": {
+ "most_common": true
+ }
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -212826,7 +233674,10 @@
},
"url": {
"description": "The URL of the webhook endpoint.",
- "type": "string"
+ "type": "string",
+ "x-stripeParam": {
+ "most_common": true
+ }
}
},
"type": "object"
diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json
index cb13f760..cf7fd058 100644
--- a/embedded/openapi/spec3.json
+++ b/embedded/openapi/spec3.json
@@ -3562,6 +3562,35 @@
"x-expandableFields": [],
"x-resourceId": "billing.meter_event_summary"
},
+ "billing_clocks_resource_status_details_advancing_status_details": {
+ "description": "",
+ "properties": {
+ "target_frozen_time": {
+ "description": "The `frozen_time` that the Test Clock is advancing towards.",
+ "format": "unix-time",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "target_frozen_time"
+ ],
+ "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "billing_clocks_resource_status_details_status_details": {
+ "description": "",
+ "properties": {
+ "advancing": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details"
+ }
+ },
+ "title": "BillingClocksResourceStatusDetailsStatusDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "advancing"
+ ]
+ },
"billing_details": {
"description": "",
"properties": {
@@ -4777,7 +4806,7 @@
"$ref": "#/components/schemas/transfer"
}
],
- "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
+ "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -4788,13 +4817,13 @@
}
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -9568,7 +9597,7 @@
"x-resourceId": "customer_cash_balance_transaction"
},
"customer_session": {
- "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.",
+ "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).",
"properties": {
"client_secret": {
"description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
@@ -12179,6 +12208,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -16640,7 +16670,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -16674,6 +16704,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -17877,6 +17908,14 @@
"maxLength": 5000,
"type": "string"
},
+ "status": {
+ "description": "The current processing status of this settlement.",
+ "enum": [
+ "complete",
+ "pending"
+ ],
+ "type": "string"
+ },
"transaction_count": {
"description": "The total number of transactions reflected in this settlement.",
"type": "integer"
@@ -17901,6 +17940,7 @@
"network_settlement_identifier",
"object",
"settlement_service",
+ "status",
"transaction_count",
"transaction_volume"
],
@@ -22919,7 +22959,6 @@
"amount_tax",
"amount_total",
"currency",
- "description",
"id",
"object"
],
@@ -24683,6 +24722,27 @@
"type": "object",
"x-expandableFields": []
},
+ "payment_flows_private_payment_methods_card_present_common_wallet": {
+ "description": "",
+ "properties": {
+ "type": {
+ "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.",
+ "enum": [
+ "apple_pay",
+ "google_pay",
+ "samsung_pay",
+ "unknown"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet",
+ "type": "object",
+ "x-expandableFields": []
+ },
"payment_flows_private_payment_methods_klarna_dob": {
"description": "",
"properties": {
@@ -24842,7 +24902,7 @@
"$ref": "#/components/schemas/deleted_customer"
}
],
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -25063,13 +25123,13 @@
"nullable": true
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -28962,6 +29022,9 @@
],
"nullable": true,
"type": "string"
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -28972,7 +29035,8 @@
"type": "object",
"x-expandableFields": [
"networks",
- "offline"
+ "offline",
+ "wallet"
]
},
"payment_method_card_present_networks": {
@@ -30371,7 +30435,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -30418,6 +30482,9 @@
],
"description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
"nullable": true
+ },
+ "wallet": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
}
},
"required": [
@@ -30430,7 +30497,8 @@
"type": "object",
"x-expandableFields": [
"offline",
- "receipt"
+ "receipt",
+ "wallet"
]
},
"payment_method_details_card_present_offline": {
@@ -31053,7 +31121,7 @@
"type": "string"
},
"network_transaction_id": {
- "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+ "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -34313,7 +34381,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -34347,6 +34415,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -39938,7 +40007,7 @@
"$ref": "#/components/schemas/payment_method"
}
],
- "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.corp.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
+ "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -45045,7 +45114,7 @@
"nullable": true
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -45079,6 +45148,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -45672,7 +45742,7 @@
"description": "",
"properties": {
"type": {
- "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
+ "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -45706,6 +45776,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -47266,6 +47337,9 @@
"ready"
],
"type": "string"
+ },
+ "status_details": {
+ "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details"
}
},
"required": [
@@ -47279,7 +47353,9 @@
],
"title": "TestClock",
"type": "object",
- "x-expandableFields": [],
+ "x-expandableFields": [
+ "status_details"
+ ],
"x-resourceId": "test_helpers.test_clock"
},
"three_d_secure_details": {
@@ -48664,7 +48740,7 @@
"x-resourceId": "treasury.financial_account_features"
},
"treasury.inbound_transfer": {
- "description": "Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.",
+ "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -48822,7 +48898,7 @@
"x-resourceId": "treasury.inbound_transfer"
},
"treasury.outbound_payment": {
- "description": "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -49003,7 +49079,7 @@
"x-resourceId": "treasury.outbound_payment"
},
"treasury.outbound_transfer": {
- "description": "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.",
+ "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)",
"properties": {
"amount": {
"description": "Amount (in cents) transferred.",
@@ -57031,7 +57107,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -57747,7 +57823,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -58478,7 +58554,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -59194,7 +59270,7 @@
"additionalProperties": false,
"properties": {
"additional_tos_acceptances": {
- "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
"properties": {
"account": {
"properties": {
@@ -64965,12 +65041,12 @@
"x-stripeBypassValidation": true
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
"type": "string"
},
@@ -65472,12 +65548,12 @@
"type": "string"
},
"statement_descriptor": {
- "description": "For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
+ "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
"maxLength": 22,
"type": "string"
},
@@ -73215,6 +73291,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -80676,7 +80753,7 @@
"type": "array"
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -80710,6 +80787,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -82852,7 +82930,7 @@
"type": "integer"
},
"file": {
- "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
+ "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"maxLength": 5000,
"type": "string"
},
@@ -83176,6 +83254,7 @@
"finance_report_run",
"identity_document",
"identity_document_downloadable",
+ "issuing_regulatory_reporting",
"pci_document",
"selfie",
"sigma_scheduled_query",
@@ -83347,6 +83426,7 @@
"customer_signature",
"dispute_evidence",
"identity_document",
+ "issuing_regulatory_reporting",
"pci_document",
"tax_document_user_upload",
"terminal_reader_splashscreen"
@@ -88260,6 +88340,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -89799,6 +89880,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -91621,6 +91703,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -106773,7 +106856,7 @@
"type": "string"
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
"type": "string"
},
@@ -109293,12 +109376,12 @@
"type": "object"
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -109662,7 +109745,7 @@
"type": "string"
},
"customer": {
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.corp.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"maxLength": 5000,
"type": "string"
},
@@ -112106,12 +112189,12 @@
"description": "Shipping information for this PaymentIntent."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -112388,12 +112471,12 @@
"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`."
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
+ "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
"maxLength": 22,
"type": "string"
},
@@ -115171,7 +115254,7 @@
"type": "object"
},
"statement_descriptor": {
- "description": "Text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors) for a non-card charge. This value overrides the account's default statement descriptor. Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
+ "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).",
"maxLength": 22,
"type": "string"
},
@@ -128455,7 +128538,7 @@
},
"/v1/quotes/{quote}/pdf": {
"get": {
- "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
+ "description": "Download the PDF for a finalized quote. Explanation for special handling can be found here
",
"operationId": "GetQuotesQuotePdf",
"parameters": [
{
@@ -144127,6 +144210,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
@@ -147454,7 +147538,7 @@
"type": "object"
},
"type": {
- "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
+ "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`",
"enum": [
"ad_nrt",
"ae_trn",
@@ -147488,6 +147572,7 @@
"gb_vat",
"ge_vat",
"hk_br",
+ "hr_oib",
"hu_tin",
"id_npwp",
"il_vat",