With Connect, you can delete accounts you manage.
\n\nTest-mode accounts can be deleted at any time.
\n\nLive-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.
\n\nIf you want to delete your own account, use the account information tab in your account settings instead.
", + "description": "With Connect, you can delete accounts you manage.
\n\nTest-mode accounts can be deleted at any time.
\n\nLive-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.
\n\nIf you want to delete your own account, use the account information tab in your account settings instead.
", "operationId": "DeleteAccountsAccount", "parameters": [ { @@ -64518,7 +74026,7 @@ "description": "The applicant's gross annual revenue for its preceding fiscal year.", "properties": { "amount": { - "description": "A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -64537,14 +74045,19 @@ "fiscal_year_end" ], "title": "annual_revenue_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "fiscal_year_end" + ] }, "estimated_worker_count": { "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", "type": "integer" }, "mcc": { - "description": "[The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", + "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" }, @@ -64552,7 +74065,7 @@ "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -64565,7 +74078,11 @@ "currency" ], "title": "monthly_estimated_revenue_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] }, "name": { "description": "The customer-facing business name.", @@ -64612,7 +74129,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "support_email": { "description": "A publicly available email address for sending support issues to.", @@ -64643,7 +74168,26 @@ } }, "title": "business_profile_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "annual_revenue", + "estimated_worker_count", + "industry", + "mcc", + "monthly_estimated_revenue", + "name", + "payment_collection_methods", + "privacy_policy_url", + "product_description", + "singapore_account_activity_survey", + "specified_commercial_transactions_act_url", + "support_address", + "support_email", + "support_phone", + "support_url", + "terms_of_service_url", + "url" + ] }, "business_type": { "description": "The 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.", @@ -64668,7 +74212,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "affirm_payments": { "description": "The affirm_payments capability.", @@ -64679,7 +74226,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "afterpay_clearpay_payments": { "description": "The afterpay_clearpay_payments capability.", @@ -64690,7 +74240,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "amazon_pay_payments": { "description": "The amazon_pay_payments capability.", @@ -64701,7 +74254,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "au_becs_debit_payments": { "description": "The au_becs_debit_payments capability.", @@ -64712,7 +74268,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bacs_debit_payments": { "description": "The bacs_debit_payments capability.", @@ -64723,7 +74282,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bancontact_payments": { "description": "The bancontact_payments capability.", @@ -64734,7 +74296,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "bank_transfer_payments": { "description": "The bank_transfer_payments capability.", @@ -64745,7 +74310,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "blik_payments": { "description": "The blik_payments capability.", @@ -64756,7 +74324,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "boleto_payments": { "description": "The boleto_payments capability.", @@ -64767,7 +74338,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "card_issuing": { "description": "The card_issuing capability.", @@ -64778,7 +74352,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "card_payments": { "description": "The card_payments capability.", @@ -64789,7 +74366,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "cartes_bancaires_payments": { "description": "The cartes_bancaires_payments capability.", @@ -64800,7 +74380,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "cashapp_payments": { "description": "The cashapp_payments capability.", @@ -64811,7 +74394,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "eps_payments": { "description": "The eps_payments capability.", @@ -64822,7 +74408,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "fpx_payments": { "description": "The fpx_payments capability.", @@ -64833,7 +74422,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "gb_bank_transfer_payments": { "description": "The gb_bank_transfer_payments capability.", @@ -64844,7 +74436,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "giropay_payments": { "description": "The giropay_payments capability.", @@ -64855,7 +74450,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "grabpay_payments": { "description": "The grabpay_payments capability.", @@ -64866,7 +74464,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "ideal_payments": { "description": "The ideal_payments capability.", @@ -64877,7 +74478,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "india_international_payments": { "description": "The india_international_payments capability.", @@ -64888,7 +74492,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "jcb_payments": { "description": "The jcb_payments capability.", @@ -64899,7 +74506,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "jp_bank_transfer_payments": { "description": "The jp_bank_transfer_payments capability.", @@ -64910,7 +74520,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "klarna_payments": { "description": "The klarna_payments capability.", @@ -64921,7 +74534,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "konbini_payments": { "description": "The konbini_payments capability.", @@ -64932,7 +74548,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "legacy_payments": { "description": "The legacy_payments capability.", @@ -64943,7 +74562,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "link_payments": { "description": "The link_payments capability.", @@ -64954,7 +74576,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "mobilepay_payments": { "description": "The mobilepay_payments capability.", @@ -64965,7 +74590,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "multibanco_payments": { "description": "The multibanco_payments capability.", @@ -64976,7 +74604,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "mx_bank_transfer_payments": { "description": "The mx_bank_transfer_payments capability.", @@ -64987,7 +74618,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "oxxo_payments": { "description": "The oxxo_payments capability.", @@ -64998,7 +74632,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "p24_payments": { "description": "The p24_payments capability.", @@ -65009,7 +74646,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "paynow_payments": { "description": "The paynow_payments capability.", @@ -65020,7 +74660,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "promptpay_payments": { "description": "The promptpay_payments capability.", @@ -65031,7 +74674,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "revolut_pay_payments": { "description": "The revolut_pay_payments capability.", @@ -65042,7 +74688,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sepa_bank_transfer_payments": { "description": "The sepa_bank_transfer_payments capability.", @@ -65053,7 +74702,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sepa_debit_payments": { "description": "The sepa_debit_payments capability.", @@ -65064,7 +74716,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "sofort_payments": { "description": "The sofort_payments capability.", @@ -65075,7 +74730,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "swish_payments": { "description": "The swish_payments capability.", @@ -65086,7 +74744,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "tax_reporting_us_1099_k": { "description": "The tax_reporting_us_1099_k capability.", @@ -65097,7 +74758,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "tax_reporting_us_1099_misc": { "description": "The tax_reporting_us_1099_misc capability.", @@ -65108,7 +74772,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "transfers": { "description": "The transfers capability.", @@ -65119,7 +74786,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "treasury": { "description": "The treasury capability.", @@ -65130,7 +74800,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "twint_payments": { "description": "The twint_payments capability.", @@ -65141,7 +74814,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "us_bank_account_ach_payments": { "description": "The us_bank_account_ach_payments capability.", @@ -65152,7 +74828,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "us_bank_transfer_payments": { "description": "The us_bank_transfer_payments capability.", @@ -65163,7 +74842,10 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "zip_payments": { "description": "The zip_payments capability.", @@ -65174,11 +74856,125 @@ } }, "title": "capability_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "capabilities_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach_debit_payments", + "acss_debit_payments", + "affirm_payments", + "afterpay_clearpay_payments", + "alipay_payments", + "alma_payments", + "amazon_pay_payments", + "apple_pay_later_payments", + "au_bank_transfer_payments", + "au_becs_debit_payments", + "bacs_debit_payments", + "bacs_debit_stripe_sun_payments", + "bancontact_payments", + "bank_transfer_payments", + "beneficiary_transfers", + "billie_payments", + "bizum_payments", + "blik_payments", + "boleto_payments", + "ca_bank_transfer_payments", + "capchase_pay_payments", + "card_issuing", + "card_issuing_charge_card", + "card_issuing_charge_card_stripe", + "card_issuing_spend_card_cross_river", + "card_payments", + "cartes_bancaires_payments", + "cash_advances", + "cashapp_payments", + "crypto_payments", + "crypto_transfers", + "demo_pay_payments", + "duitnow_payments", + "dummy_passthrough_card_payments", + "eps_payments", + "fpx_payments", + "funding_credit", + "gb_bank_transfer_payments", + "giropay_payments", + "gopay_payments", + "grabpay_payments", + "id_bank_transfer_payments", + "id_bank_transfer_payments_bca", + "id_credit_transfer_payments", + "ideal_payments", + "india_international_payments", + "jcb_payments", + "jp_bank_transfer_payments", + "kakao_pay_payments", + "klarna_payments", + "konbini_payments", + "kr_card_payments", + "kr_market_payments", + "kriya_payments", + "legacy_payments", + "link_payments", + "loans", + "mb_way_payments", + "meta_pay_payments", + "mobilepay_payments", + "mondu_payments", + "multibanco_payments", + "mx_bank_transfer_payments", + "naver_pay_payments", + "netbanking_payments", + "ng_bank_payments", + "ng_bank_transfer_payments", + "ng_card_payments", + "ng_market_payments", + "ng_ussd_payments", + "nz_bank_account_becs_debit_payments", + "nz_bank_transfer_payments", + "oxxo_payments", + "p24_payments", + "pay_by_bank_payments", + "payco_payments", + "payments", + "paynow_payments", + "paypal_payments", + "payto_payments", + "pix_payments", + "promptpay_payments", + "qris_payments", + "rechnung_payments", + "revolut_pay_payments", + "samsung_pay_payments", + "satispay_payments", + "sepa_bank_transfer_payments", + "sepa_debit_payments", + "sequra_payments", + "shopeepay_payments", + "sofort_payments", + "south_korea_market_payments", + "submerchant_payments", + "sunbit_payments", + "swish_payments", + "tax_reporting_us_1099_k", + "tax_reporting_us_1099_misc", + "transfers", + "treasury", + "treasury_evolve", + "treasury_fifth_third", + "treasury_goldman_sachs", + "twint_payments", + "upi_payments", + "us_bank_account_ach_payments", + "us_bank_transfer_payments", + "wechat_pay_payments", + "zip_payments" + ] }, "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.", @@ -65218,7 +75014,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", @@ -65260,7 +75064,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", @@ -65302,14 +75116,24 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "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](https://docs.stripe.com/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.", + "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" }, "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](https://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.", + "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" }, "export_license_id": { @@ -65338,7 +75162,7 @@ "type": "string" }, "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](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.", + "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" }, "ownership_declaration": { @@ -65360,7 +75184,12 @@ } }, "title": "company_ownership_declaration", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "phone": { "description": "The company's phone number (used for verification).", @@ -65373,7 +75202,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", + "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.", "enum": [ "", "free_zone_establishment", @@ -65436,15 +75265,53 @@ } }, "title": "verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "company_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "contact_point_verification_address", + "cross_border_transaction_classifications", + "directors_provided", + "executives_provided", + "export_license_id", + "export_purpose_code", + "fiscal_code", + "invoicing_recipient_code", + "name", + "name_kana", + "name_kanji", + "owners_provided", + "ownership_declaration", + "pan", + "phone", + "registered_email", + "registration_date", + "registration_number", + "stock_data", + "structure", + "tax_deduction_account_number", + "tax_id", + "tax_id_registrar", + "vat_id", + "vat_registration_status", + "verification" + ] }, "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).", @@ -65454,7 +75321,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`.", @@ -65466,7 +75333,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_license": { "description": "One or more documents that demonstrate proof of a company's license to operate.", @@ -65481,7 +75351,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_memorandum_of_association": { "description": "One or more documents showing the company's Memorandum of Association.", @@ -65496,7 +75369,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_ministerial_decree": { "description": "(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.", @@ -65511,7 +75387,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_registration_verification": { "description": "One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.", @@ -65526,7 +75405,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "company_tax_id_verification": { "description": "One or more documents that demonstrate proof of a company's tax ID.", @@ -65541,7 +75423,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "proof_of_registration": { "description": "One or more documents showing the company’s proof of registration with the national business registry.", @@ -65556,11 +75441,25 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_account_ownership_verification", + "company_address_verification", + "company_license", + "company_memorandum_of_association", + "company_ministerial_decree", + "company_registration_verification", + "company_tax_id_verification", + "company_vat_id_verification", + "proof_of_registration" + ] }, "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.", @@ -65618,7 +75517,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", @@ -65660,7 +75567,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", @@ -65702,7 +75619,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -65727,7 +75654,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -65780,12 +75712,12 @@ "type": "string" }, "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](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "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" }, "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](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "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" }, @@ -65873,7 +75805,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "Describes the person’s relationship to the account.", @@ -65911,7 +75851,17 @@ } }, "title": "individual_relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "controller", + "director", + "executive", + "officer", + "owner", + "partner", + "percent_ownership", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", @@ -65936,7 +75886,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -65953,15 +75907,50 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, "title": "individual_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "birth_city", + "birth_country", + "dob", + "email", + "first_name", + "first_name_kana", + "first_name_kanji", + "full_name_aliases", + "gender", + "id_number", + "id_number_secondary", + "last_name", + "last_name_kana", + "last_name_kanji", + "maiden_name", + "metadata", + "phone", + "political_exposure", + "registered_address", + "relationship", + "ssn_last_4", + "verification" + ] }, "metadata": { "anyOf": [ @@ -65992,7 +75981,10 @@ } }, "title": "bacs_debit_payments_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name" + ] }, "branding": { "description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.", @@ -66019,13 +76011,20 @@ } }, "title": "branding_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "icon", + "logo", + "primary_color", + "secondary_color", + "show_support_phone" + ] }, "card_issuing": { "description": "Settings specific to the account's use of the Card Issuing product.", "properties": { "tos_acceptance": { - "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://docs.stripe.com/issuing/connect/tos_acceptance).", + "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", @@ -66053,11 +76052,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "card_issuing_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tos_acceptance", + "tos_acceptances" + ] }, "card_payments": { "description": "Settings specific to card charging on the account.", @@ -66075,7 +76083,11 @@ } }, "title": "decline_charge_on_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "avs_failure", + "cvc_failure" + ] }, "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.", @@ -66114,7 +76126,14 @@ } }, "title": "card_payments_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "decline_on", + "onboarding_policy", + "statement_descriptor_prefix", + "statement_descriptor_prefix_kana", + "statement_descriptor_prefix_kanji" + ] }, "invoices": { "description": "Settings specific to the account's use of Invoices.", @@ -66139,39 +76158,47 @@ } }, "title": "invoices_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_account_tax_ids" + ] }, "payments": { "description": "Settings that apply across payment methods for charging on the account.", "properties": { "statement_descriptor": { - "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.", + "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" }, "statement_descriptor_kana": { - "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).", + "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" }, "statement_descriptor_kanji": { - "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).", + "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" } }, "title": "payments_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "statement_descriptor", + "statement_descriptor_kana", + "statement_descriptor_kanji" + ] }, "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](https://docs.stripe.com/connect/account-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" }, "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](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.", + "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.", "properties": { "delay_days": { "anyOf": [ @@ -66186,7 +76213,7 @@ "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](https://docs.stripe.com/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)." }, "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", @@ -66220,7 +76247,15 @@ } }, "title": "transfer_schedule_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "automatic", + "delay_days", + "interval", + "monthly_anchor", + "timezone", + "weekly_anchor" + ] }, "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.", @@ -66229,7 +76264,12 @@ } }, "title": "payout_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "debit_negative_balances", + "schedule", + "statement_descriptor" + ] }, "treasury": { "description": "Settings specific to the account's Treasury FinancialAccounts.", @@ -66263,15 +76303,42 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "treasury_settings_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tos_acceptance" + ] } }, "title": "settings_specs_update", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "affirm_payments", + "apply_future_requirements", + "bacs_debit_payments", + "bank_bca_onboarding", + "branding", + "capital", + "card_issuing", + "card_issuing_charge_card", + "card_issuing_payout", + "card_payments", + "funding_credit", + "invoices", + "konbini_payments", + "payments", + "payouts", + "tax_forms", + "treasury" + ] }, "tos_acceptance": { "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). 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. This property defaults to a `full` service agreement when empty.", @@ -66297,10 +76364,25 @@ } }, "title": "tos_acceptance_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "service_agreement", + "user_agent" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "business_type", + "capabilities", + "company", + "email", + "individual", + "metadata", + "tos_acceptance" + ] } } }, @@ -66414,6 +76496,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -66558,7 +76646,10 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } } }, @@ -66722,6 +76813,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -66800,7 +76897,11 @@ "required": [ "external_account" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "external_account", + "metadata" + ] } } }, @@ -67074,7 +77175,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 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`.", @@ -67086,11 +77187,17 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "external_account_documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_account_ownership_verification" + ] }, "exp_month": { "description": "Two digit number representing the card’s expiration month.", @@ -67133,7 +77240,11 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_for_currency", + "metadata" + ] } } }, @@ -67311,7 +77422,17 @@ } }, "title": "all_people_relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "representative" + ] }, "style": "deepObject" }, @@ -67380,6 +77501,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -67470,7 +77597,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.", @@ -67501,11 +77628,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "person_additional_tos_acceptances_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "representative" + ] }, "address": { "description": "The person's address.", @@ -67542,7 +77678,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", @@ -67584,7 +77728,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", @@ -67626,7 +77780,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -67651,7 +77815,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -67688,7 +77857,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", @@ -67713,7 +77885,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", @@ -67738,11 +77913,20 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "person_documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "DASHBOARD_proof_of_liveness", + "company_authorization", + "passport", + "visa" + ] }, "email": { "description": "The person's email address.", @@ -67894,7 +78078,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", @@ -67940,7 +78132,20 @@ } }, "title": "relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "controller", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "percent_ownership", + "representative", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", @@ -67964,7 +78169,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -67981,14 +78190,34 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "first_name", + "id_number", + "last_name", + "metadata", + "phone", + "relationship", + "ssn_last_4" + ] } } }, @@ -68238,7 +78467,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.", @@ -68269,11 +78498,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "person_additional_tos_acceptances_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "representative" + ] }, "address": { "description": "The person's address.", @@ -68310,7 +78548,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", @@ -68352,7 +78598,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", @@ -68394,7 +78650,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -68419,7 +78685,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -68456,7 +78727,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", @@ -68481,7 +78755,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", @@ -68506,11 +78783,20 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "person_documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "DASHBOARD_proof_of_liveness", + "company_authorization", + "passport", + "visa" + ] }, "email": { "description": "The person's email address.", @@ -68662,7 +78948,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", @@ -68708,7 +79002,20 @@ } }, "title": "relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "controller", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "percent_ownership", + "representative", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", @@ -68732,7 +79039,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -68749,14 +79060,34 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "first_name", + "id_number", + "last_name", + "metadata", + "phone", + "relationship", + "ssn_last_4" + ] } } }, @@ -68831,7 +79162,10 @@ "required": [ "reason" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reason" + ] } } }, @@ -68978,6 +79312,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -69026,7 +79366,10 @@ "required": [ "domain_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "domain_name" + ] } } }, @@ -69219,7 +79562,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -69330,6 +79679,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -69493,7 +79848,10 @@ "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -69708,6 +80066,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -69777,7 +80141,11 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "metadata" + ] } } }, @@ -69874,7 +80242,11 @@ "type" ], "title": "scope_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] }, "style": "deepObject" }, @@ -69944,6 +80316,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -70025,7 +80403,11 @@ "type" ], "title": "scope_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] } }, "required": [ @@ -70033,98 +80415,112 @@ "payload", "scope" ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/apps.secret" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/apps/secrets/delete": { - "post": { - "description": "Deletes a secret from the secret store by name and scope.
", - "operationId": "PostAppsSecretsDelete", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "explode": true, - "style": "deepObject" - }, - "scope": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "A name for the secret that's unique within the scope.", - "maxLength": 5000, - "type": "string" - }, - "scope": { - "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", - "properties": { - "type": { - "description": "The secret scope type.", - "enum": [ - "account", - "user" - ], - "type": "string" - }, - "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" - } - }, - "required": [ - "type" - ], - "title": "scope_param", - "type": "object" - } - }, - "required": [ + "type": "object", + "x-stripeMostCommon": [ + "expires_at", "name", + "payload", "scope" - ], - "type": "object" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/apps.secret" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/apps/secrets/delete": { + "post": { + "description": "Deletes a secret from the secret store by name and scope.
", + "operationId": "PostAppsSecretsDelete", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "scope": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "A name for the secret that's unique within the scope.", + "maxLength": 5000, + "type": "string" + }, + "scope": { + "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.", + "properties": { + "type": { + "description": "The secret scope type.", + "enum": [ + "account", + "user" + ], + "type": "string" + }, + "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" + } + }, + "required": [ + "type" + ], + "title": "scope_param", + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] + } + }, + "required": [ + "name", + "scope" + ], + "type": "object", + "x-stripeMostCommon": [ + "name", + "scope" + ] } } }, @@ -70211,7 +80607,11 @@ "type" ], "title": "scope_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "user" + ] }, "style": "deepObject" } @@ -70344,7 +80744,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -70466,7 +80872,1963 @@ "properties": { "data": { "items": { - "$ref": "#/components/schemas/balance_transaction" + "$ref": "#/components/schemas/balance_transaction" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/balance_transactions", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "BalanceTransactionsList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/balance_transactions/{id}": { + "get": { + "description": "Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
Lists billing active and inactive alerts
", + "operationId": "GetBillingAlerts", + "parameters": [ + { + "description": "Filter results to only include this type of alert.", + "in": "query", + "name": "alert_type", + "required": false, + "schema": { + "enum": [ + "usage_threshold" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter results to only include alerts with the given meter.", + "in": "query", + "name": "meter", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/billing.alert" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/billing/alerts", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "ThresholdsResourceAlertList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a billing alert
", + "operationId": "PostBillingAlerts", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "usage_threshold": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "alert_type": { + "description": "The type of alert to create.", + "enum": [ + "usage_threshold" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The title of the alert.", + "maxLength": 256, + "type": "string" + }, + "usage_threshold": { + "description": "The configuration of the usage threshold.", + "properties": { + "filters": { + "description": "The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.", + "items": { + "properties": { + "customer": { + "description": "Limit the scope to this usage alert only to this customer.", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "What type of filter is being applied to this usage alert.", + "enum": [ + "customer" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "usage_alert_filter", + "type": "object", + "x-stripeMostCommon": [ + "customer", + "type" + ] + }, + "type": "array" + }, + "gte": { + "description": "Defines at which value the alert will fire.", + "type": "integer" + }, + "meter": { + "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.", + "maxLength": 5000, + "type": "string" + }, + "recurrence": { + "description": "Whether the alert should only fire only once, or once per billing cycle.", + "enum": [ + "one_time" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "gte", + "recurrence" + ], + "title": "usage_threshold_config", + "type": "object", + "x-stripeMostCommon": [ + "filters", + "gte", + "meter", + "recurrence" + ] + } + }, + "required": [ + "alert_type", + "title" + ], + "type": "object", + "x-stripeMostCommon": [ + "alert_type", + "title", + "usage_threshold" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.alert" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/alerts/{id}": { + "get": { + "description": "Retrieves a billing alert given an ID
", + "operationId": "GetBillingAlertsId", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.alert" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/alerts/{id}/activate": { + "post": { + "description": "Reactivates this alert, allowing it to trigger again.
", + "operationId": "PostBillingAlertsIdActivate", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.alert" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/alerts/{id}/archive": { + "post": { + "description": "Archives this alert, removing it from the list view and APIs. This is non-reversible.
", + "operationId": "PostBillingAlertsIdArchive", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.alert" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/alerts/{id}/deactivate": { + "post": { + "description": "Deactivates this alert, preventing it from triggering.
", + "operationId": "PostBillingAlertsIdDeactivate", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.alert" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/credit_balance_summary": { + "get": { + "description": "Retrieves the credit balance summary for a customer
", + "operationId": "GetBillingCreditBalanceSummary", + "parameters": [ + { + "description": "The customer for which to fetch credit balance summary.", + "in": "query", + "name": "customer", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "The filter criteria for the credit balance summary.", + "explode": true, + "in": "query", + "name": "filter", + "required": true, + "schema": { + "properties": { + "applicability_scope": { + "description": "The credit applicability scope for which to fetch balance summary.", + "properties": { + "price_type": { + "description": "The price type to which credit grants can apply to. We currently only support `metered` price type.", + "enum": [ + "metered" + ], + "type": "string" + } + }, + "required": [ + "price_type" + ], + "title": "scope_param", + "type": "object", + "x-stripeMostCommon": [ + "price_type" + ] + }, + "credit_grant": { + "description": "The credit grant for which to fetch balance summary.", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "Specify the type of this filter.", + "enum": [ + "applicability_scope", + "credit_grant" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "balance_summary_filter_param", + "type": "object", + "x-stripeMostCommon": [ + "applicability_scope", + "credit_grant", + "type" + ] + }, + "style": "deepObject" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.credit_balance_summary" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/credit_balance_transactions": { + "get": { + "description": "Retrieve a list of credit balance transactions
", + "operationId": "GetBillingCreditBalanceTransactions", + "parameters": [ + { + "description": "The credit grant for which to fetch credit balance transactions.", + "in": "query", + "name": "credit_grant", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "The customer for which to fetch credit balance transactions.", + "in": "query", + "name": "customer", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/billing.credit_balance_transaction" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/billing/credit_grants", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "BillingCreditGrantsResourceBalanceTransactionList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/credit_balance_transactions/{id}": { + "get": { + "description": "Retrieves a credit balance transaction
", + "operationId": "GetBillingCreditBalanceTransactionsId", + "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": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.credit_balance_transaction" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/credit_grants": { + "get": { + "description": "Retrieve a list of credit grants
", + "operationId": "GetBillingCreditGrants", + "parameters": [ + { + "description": "Only return credit grants for this customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/billing.credit_grant" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/billing/credit_grants", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "BillingCreditGrantsResourceCreditGrantList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a credit grant
", + "operationId": "PostBillingCreditGrants", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "amount": { + "explode": true, + "style": "deepObject" + }, + "applicability_config": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "amount": { + "description": "Amount of this credit grant.", + "properties": { + "monetary": { + "description": "The monetary amount.", + "properties": { + "currency": { + "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.", + "type": "string" + }, + "value": { + "description": "A positive integer representing the amount of the credit grant.", + "type": "integer" + } + }, + "required": [ + "currency", + "value" + ], + "title": "monetary_amount_param", + "type": "object", + "x-stripeMostCommon": [ + "currency", + "value" + ] + }, + "type": { + "description": "Specify the type of this amount. We currently only support `monetary` credits.", + "enum": [ + "monetary" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "amount_param", + "type": "object", + "x-stripeMostCommon": [ + "monetary", + "type" + ] + }, + "applicability_config": { + "description": "Configuration specifying what this credit grant applies to.", + "properties": { + "scope": { + "description": "Specify the scope of this applicability config.", + "properties": { + "price_type": { + "description": "The price type to which credit grants can apply to. We currently only support `metered` price type.", + "enum": [ + "metered" + ], + "type": "string" + } + }, + "required": [ + "price_type" + ], + "title": "scope_param", + "type": "object", + "x-stripeMostCommon": [ + "price_type" + ] + } + }, + "required": [ + "scope" + ], + "title": "applicability_config_param", + "type": "object", + "x-stripeMostCommon": [ + "scope" + ] + }, + "category": { + "description": "The category of this credit grant.", + "enum": [ + "paid", + "promotional" + ], + "type": "string" + }, + "customer": { + "description": "Id of the customer to whom the credit should be granted.", + "maxLength": 5000, + "type": "string" + }, + "effective_at": { + "description": "The time when the credit becomes effective i.e when it is eligible to be used. Defaults to the current timestamp if not specified.", + "format": "unix-time", + "type": "integer" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "expires_at": { + "description": "The time when the credit will expire. If not specified, the credit will never expire.", + "format": "unix-time", + "type": "integer" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (ex: cost basis) in a structured format.", + "type": "object" + }, + "name": { + "description": "A descriptive name shown in dashboard and on invoices.", + "maxLength": 250, + "type": "string" + } + }, + "required": [ + "amount", + "applicability_config", + "category", + "customer" + ], + "type": "object", + "x-stripeMostCommon": [ + "amount", + "applicability_config", + "category", + "customer", + "effective_at", + "expires_at", + "metadata", + "name" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.credit_grant" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/credit_grants/{id}": { + "get": { + "description": "Retrieves a credit grant
", + "operationId": "GetBillingCreditGrantsId", + "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": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.credit_grant" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Updates a credit grant
", + "operationId": "PostBillingCreditGrantsId", + "parameters": [ + { + "description": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "expires_at": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "expires_at": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The time when the credit created by this credit grant will expire. If set to empty, the credit will never expire." + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (ex: cost basis) in a structured format.", + "type": "object" + } + }, + "type": "object", + "x-stripeMostCommon": [ + "expires_at", + "metadata" + ] + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.credit_grant" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/credit_grants/{id}/expire": { + "post": { + "description": "Expires a credit grant
", + "operationId": "PostBillingCreditGrantsIdExpire", + "parameters": [ + { + "description": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.credit_grant" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/credit_grants/{id}/void": { + "post": { + "description": "Voids a credit grant
", + "operationId": "PostBillingCreditGrantsIdVoid", + "parameters": [ + { + "description": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.credit_grant" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meter_event_adjustments": { + "post": { + "description": "Creates a billing meter event adjustment
", + "operationId": "PostBillingMeterEventAdjustments", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "cancel": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "cancel": { + "description": "Specifies which event to cancel.", + "properties": { + "identifier": { + "description": "Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.", + "maxLength": 100, + "type": "string" + } + }, + "title": "event_adjustment_cancel_settings_param", + "type": "object", + "x-stripeMostCommon": [ + "identifier" + ] + }, + "event_name": { + "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", + "maxLength": 100, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", + "enum": [ + "cancel" + ], + "type": "string" + } + }, + "required": [ + "event_name", + "type" + ], + "type": "object", + "x-stripeMostCommon": [ + "cancel", + "event_name", + "type" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter_event_adjustment" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meter_events": { + "post": { + "description": "Creates a billing meter event
", + "operationId": "PostBillingMeterEvents", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "payload": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "event_name": { + "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", + "maxLength": 100, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "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" + }, + "payload": { + "additionalProperties": { + "type": "string" + }, + "description": "The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", + "type": "object" + }, + "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" + } + }, + "required": [ + "event_name", + "payload" + ], + "type": "object", + "x-stripeMostCommon": [ + "event_name", + "identifier", + "payload", + "timestamp" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter_event" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meters": { + "get": { + "description": "Retrieve a list of billing meters.
", + "operationId": "GetBillingMeters", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter results to only include meters with the given status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/billing.meter" }, "type": "array" }, @@ -70484,7 +82846,7 @@ "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, - "pattern": "^/v1/balance_transactions", + "pattern": "^/v1/billing/meters", "type": "string" } }, @@ -70494,390 +82856,16 @@ "object", "url" ], - "title": "BalanceTransactionsList", + "title": "BillingMeterResourceBillingMeterList", "type": "object", "x-expandableFields": [ "data" - ] - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/balance_transactions/{id}": { - "get": { - "description": "Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
Creates a billing meter event adjustment
", - "operationId": "PostBillingMeterEventAdjustments", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "cancel": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "cancel": { - "description": "Specifies which event to cancel.", - "properties": { - "identifier": { - "description": "Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.", - "maxLength": 100, - "type": "string" - } - }, - "title": "event_adjustment_cancel_settings_param", - "type": "object" - }, - "event_name": { - "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", - "maxLength": 100, - "type": "string" - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "type": { - "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", - "enum": [ - "cancel" - ], - "type": "string" - } - }, - "required": [ - "event_name", - "type" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/billing.meter_event_adjustment" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/billing/meter_events": { - "post": { - "description": "Creates a billing meter event
", - "operationId": "PostBillingMeterEvents", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "explode": true, - "style": "deepObject" - }, - "payload": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "event_name": { - "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", - "maxLength": 100, - "type": "string" - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "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" - }, - "payload": { - "additionalProperties": { - "type": "string" - }, - "description": "The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", - "type": "object" - }, - "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" - } - }, - "required": [ - "event_name", - "payload" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/billing.meter_event" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/billing/meters": { - "get": { - "description": "Retrieve a list of billing meters.
", - "operationId": "GetBillingMeters", - "parameters": [ - { - "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "in": "query", - "name": "ending_before", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "in": "query", - "name": "starting_after", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter results to only include meters with the given status.", - "in": "query", - "name": "status", - "required": false, - "schema": { - "enum": [ - "active", - "inactive" - ], - "type": "string" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/billing.meter" - }, - "type": "array" - }, - "has_more": { - "description": "True if this list has another page of items after this one that can be fetched.", - "type": "boolean" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "enum": [ - "list" - ], - "type": "string" - }, - "url": { - "description": "The URL where this list can be accessed.", - "maxLength": 5000, - "pattern": "^/v1/billing/meters", - "type": "string" - } - }, - "required": [ + ], + "x-stripeMostCommon": [ "data", "has_more", "object", "url" - ], - "title": "BillingMeterResourceBillingMeterList", - "type": "object", - "x-expandableFields": [ - "data" ] } } @@ -70944,7 +82932,11 @@ "type" ], "title": "customer_mapping_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "event_payload_key", + "type" + ] }, "default_aggregation": { "description": "The default settings to aggregate a meter's events with.", @@ -70962,7 +82954,10 @@ "formula" ], "title": "aggregation_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "formula" + ] }, "display_name": { "description": "The meter's name.", @@ -71003,7 +82998,10 @@ "event_payload_key" ], "title": "meter_value_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "event_payload_key" + ] } }, "required": [ @@ -71011,7 +83009,15 @@ "display_name", "event_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_mapping", + "default_aggregation", + "display_name", + "event_name", + "event_time_window", + "value_settings" + ] } } }, @@ -71151,7 +83157,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name" + ] } } }, @@ -71266,7 +83275,7 @@ "style": "form" }, { - "description": "The timestamp from when to stop aggregating meter events (exclusive).", + "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.", "in": "query", "name": "end_time", "required": true, @@ -71324,7 +83333,7 @@ "style": "form" }, { - "description": "The timestamp from when to start aggregating meter events (inclusive).", + "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.", "in": "query", "name": "start_time", "required": true, @@ -71346,12 +83355,13 @@ "style": "form" }, { - "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range.", + "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).", "in": "query", "name": "value_grouping_window", "required": false, "schema": { "enum": [ + "day", "hour" ], "type": "string" @@ -71413,6 +83423,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -71627,6 +83643,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -71708,7 +83730,12 @@ } }, "title": "business_profile_create_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "headline", + "privacy_policy_url", + "terms_of_service_url" + ] }, "default_return_url": { "anyOf": [ @@ -71772,7 +83799,11 @@ "enabled" ], "title": "customer_update_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_updates", + "enabled" + ] }, "invoice_history": { "description": "Information about showing the billing history in the portal.", @@ -71786,7 +83817,10 @@ "enabled" ], "title": "invoice_list_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_method_update": { "description": "Information about updating payment methods in the portal.", @@ -71800,7 +83834,10 @@ "enabled" ], "title": "payment_method_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "subscription_cancel": { "description": "Information about canceling subscriptions in the portal.", @@ -71845,7 +83882,11 @@ "options" ], "title": "subscription_cancellation_reason_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "options" + ] }, "enabled": { "description": "Whether the feature is enabled.", @@ -71873,7 +83914,14 @@ "enabled" ], "title": "subscription_cancel_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason", + "cancellation_redirect", + "enabled", + "mode", + "proration_behavior" + ] }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", @@ -71928,7 +83976,11 @@ "product" ], "title": "subscription_update_product_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "prices", + "product" + ] }, "type": "array" }, @@ -71952,16 +84004,28 @@ } }, "required": [ - "default_allowed_updates", - "enabled", - "products" + "enabled" ], "title": "subscription_update_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_allowed_updates", + "enabled", + "products", + "proration_behavior", + "schedule_at_period_end" + ] } }, "title": "features_creation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_update", + "invoice_history", + "payment_method_update", + "subscription_cancel", + "subscription_update" + ] }, "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).", @@ -71975,7 +84039,10 @@ "enabled" ], "title": "login_page_create_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "metadata": { "additionalProperties": { @@ -71989,7 +84056,14 @@ "business_profile", "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "business_profile", + "default_return_url", + "features", + "login_page", + "metadata" + ] } } }, @@ -72185,7 +84259,12 @@ } }, "title": "business_profile_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "headline", + "privacy_policy_url", + "terms_of_service_url" + ] }, "default_return_url": { "anyOf": [ @@ -72246,7 +84325,11 @@ } }, "title": "customer_update_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_updates", + "enabled" + ] }, "invoice_history": { "description": "Information about showing the billing history in the portal.", @@ -72260,7 +84343,10 @@ "enabled" ], "title": "invoice_list_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "payment_method_update": { "description": "Information about updating payment methods in the portal.", @@ -72274,7 +84360,10 @@ "enabled" ], "title": "payment_method_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "subscription_cancel": { "description": "Information about canceling subscriptions in the portal.", @@ -72318,7 +84407,11 @@ "enabled" ], "title": "subscription_cancellation_reason_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "options" + ] }, "enabled": { "description": "Whether the feature is enabled.", @@ -72343,7 +84436,14 @@ } }, "title": "subscription_cancel_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason", + "cancellation_redirect", + "enabled", + "mode", + "proration_behavior" + ] }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", @@ -72398,7 +84498,11 @@ "product" ], "title": "subscription_update_product_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "prices", + "product" + ] }, "type": "array" }, @@ -72422,11 +84526,25 @@ } }, "title": "subscription_update_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_allowed_updates", + "enabled", + "products", + "proration_behavior", + "schedule_at_period_end" + ] } }, "title": "features_updating_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_update", + "invoice_history", + "payment_method_update", + "subscription_cancel", + "subscription_update" + ] }, "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).", @@ -72440,7 +84558,10 @@ "enabled" ], "title": "login_page_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "metadata": { "anyOf": [ @@ -72460,7 +84581,15 @@ "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-stripeMostCommon": [ + "active", + "business_profile", + "default_return_url", + "features", + "login_page", + "metadata" + ] } } }, @@ -72544,7 +84673,10 @@ } }, "title": "after_completion_hosted_confirmation_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_message" + ] }, "redirect": { "description": "Configuration when `after_completion.type=redirect`.", @@ -72558,7 +84690,10 @@ "return_url" ], "title": "after_completion_redirect_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "return_url" + ] }, "type": { "description": "The specified behavior after the flow is completed.", @@ -72574,7 +84709,12 @@ "type" ], "title": "flow_data_after_completion_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "hosted_confirmation", + "redirect", + "type" + ] }, "subscription_cancel": { "description": "Configuration when `flow_data.type=subscription_cancel`.", @@ -72595,7 +84735,10 @@ "coupon" ], "title": "coupon_offer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": { "description": "Type of retention strategy to use with the customer.", @@ -72610,7 +84753,11 @@ "type" ], "title": "retention_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon_offer", + "type" + ] }, "subscription": { "description": "The ID of the subscription to be canceled.", @@ -72622,7 +84769,11 @@ "subscription" ], "title": "flow_data_subscription_cancel_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "retention", + "subscription" + ] }, "subscription_update": { "description": "Configuration when `flow_data.type=subscription_update`.", @@ -72637,7 +84788,10 @@ "subscription" ], "title": "flow_data_subscription_update_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "subscription" + ] }, "subscription_update_confirm": { "description": "Configuration when `flow_data.type=subscription_update_confirm`.", @@ -72658,7 +84812,11 @@ } }, "title": "subscription_update_confirm_discount_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon", + "promotion_code" + ] }, "type": "array" }, @@ -72685,7 +84843,13 @@ "id" ], "title": "subscription_update_confirm_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "deleted", + "id", + "price", + "quantity" + ] }, "type": "array" }, @@ -72700,7 +84864,13 @@ "subscription" ], "title": "flow_data_subscription_update_confirm_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "discounts", + "items", + "recurring_items", + "subscription" + ] }, "type": { "description": "Type of flow that the customer will go through.", @@ -72717,7 +84887,14 @@ "type" ], "title": "flow_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after_completion", + "subscription_cancel", + "subscription_update", + "subscription_update_confirm", + "type" + ] }, "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.", @@ -72784,7 +84961,15 @@ "required": [ "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "configuration", + "customer", + "flow_data", + "locale", + "on_behalf_of", + "return_url" + ] } } }, @@ -72847,7 +85032,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -72924,7 +85115,7 @@ "style": "form" }, { - "description": "Only return charges for this transfer group.", + "description": "Only return charges for this transfer group, limited to 100.", "in": "query", "name": "transfer_group", "required": false, @@ -72989,6 +85180,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -73087,7 +85284,11 @@ "account" ], "title": "destination_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "amount" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -73129,7 +85330,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "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).", @@ -73173,7 +85378,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -73201,7 +85414,14 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "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.", @@ -73210,12 +85430,12 @@ "x-stripeBypassValidation": true }, "statement_descriptor": { - "description": "For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.", + "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 the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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" }, @@ -73236,14 +85456,32 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, "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": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "application_fee", + "currency", + "customer", + "description", + "destination", + "metadata", + "receipt_email", + "shipping", + "source", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -73387,6 +85625,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -73548,7 +85794,10 @@ "user_report" ], "title": "fraud_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "user_report" + ] }, "metadata": { "anyOf": [ @@ -73610,7 +85859,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -73638,14 +85895,28 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "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.", "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "description", + "metadata", + "receipt_email", + "shipping" + ] } } }, @@ -73732,12 +86003,12 @@ "type": "string" }, "statement_descriptor": { - "description": "For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.", + "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 the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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" }, @@ -73750,14 +86021,24 @@ } }, "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount" + ] }, "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.", "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "application_fee", + "receipt_email", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -73901,6 +86182,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -74029,7 +86316,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -74066,7 +86359,10 @@ "email" ], "title": "customer_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "email" + ] }, "style": "deepObject" }, @@ -74219,6 +86515,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -74355,11 +86657,18 @@ "enabled" ], "title": "recovery_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_promotion_codes", + "enabled" + ] } }, "title": "after_expiration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "recovery" + ] }, "allow_promotion_codes": { "description": "Enables user redeemable promotion codes.", @@ -74392,14 +86701,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_address_collection": { "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", @@ -74410,7 +86727,7 @@ "type": "string" }, "cancel_url": { - "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.", + "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded`.", "maxLength": 5000, "type": "string" }, @@ -74438,7 +86755,10 @@ "position" ], "title": "payment_method_reuse_agreement_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "position" + ] }, "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.", @@ -74458,7 +86778,12 @@ } }, "title": "consent_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_reuse_agreement", + "promotions", + "terms_of_service" + ] }, "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). Required in `setup` mode when `payment_method_types` is not set.", @@ -74496,7 +86821,11 @@ "value" ], "title": "custom_field_option_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "label", + "value" + ] }, "type": "array" } @@ -74505,7 +86834,11 @@ "options" ], "title": "custom_field_dropdown_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "options" + ] }, "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.", @@ -74533,7 +86866,11 @@ "type" ], "title": "custom_field_label_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom", + "type" + ] }, "numeric": { "description": "Configuration for `type=numeric` fields.", @@ -74553,7 +86890,12 @@ } }, "title": "custom_field_numeric_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", @@ -74577,7 +86919,12 @@ } }, "title": "custom_field_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_value", + "maximum_length", + "minimum_length" + ] }, "type": { "description": "The type of the field.", @@ -74595,7 +86942,16 @@ "type" ], "title": "custom_field_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dropdown", + "key", + "label", + "numeric", + "optional", + "text", + "type" + ] }, "type": "array" }, @@ -74616,7 +86972,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -74641,7 +87000,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -74666,7 +87028,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -74691,7 +87056,10 @@ "message" ], "title": "custom_text_position_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "message" + ] }, { "enum": [ @@ -74704,7 +87072,13 @@ } }, "title": "custom_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after_submit", + "shipping_address", + "submit", + "terms_of_service_acceptance" + ] }, "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.", @@ -74755,7 +87129,12 @@ } }, "title": "customer_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "shipping" + ] }, "discounts": { "description": "The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.", @@ -74773,7 +87152,11 @@ } }, "title": "discount_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon", + "promotion_code" + ] }, "type": "array" }, @@ -74839,7 +87222,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -74882,7 +87269,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "additionalProperties": { @@ -74906,7 +87297,11 @@ } }, "title": "rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title" + ] }, { "enum": [ @@ -74919,14 +87314,27 @@ } }, "title": "invoice_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "metadata", + "rendering_options" + ] } }, "required": [ "enabled" ], "title": "invoice_creation_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "invoice_data" + ] }, "line_items": { "description": "A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\n\nFor `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.", @@ -74936,7 +87344,7 @@ "description": "When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.", "properties": { "enabled": { - "description": "Set to true if the quantity can be adjusted to any non-negative integer. By default customers will be able to remove the line item by setting the quantity to 0.", + "description": "Set to true if the quantity can be adjusted to any non-negative integer.", "type": "boolean" }, "maximum": { @@ -74952,7 +87360,12 @@ "enabled" ], "title": "adjustable_quantity_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "maximum", + "minimum" + ] }, "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.", @@ -75016,7 +87429,14 @@ "name" ], "title": "product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] }, "recurring": { "description": "The recurring components of a price such as `interval` and `interval_count`.", @@ -75040,7 +87460,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -75065,7 +87488,12 @@ "currency" ], "title": "price_data_with_product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.", @@ -75081,7 +87509,18 @@ } }, "title": "line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "adjustable_quantity", + "display", + "dynamic_tax_rates", + "metadata", + "price", + "price_data", + "pricing_spec", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -75234,7 +87673,15 @@ "line1" ], "title": "address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -75262,15 +87709,22 @@ "name" ], "title": "shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "statement_descriptor": { - "description": "Extra information about the payment. This will appear on your\ncustomer's statement when this payment succeeds in creating a charge.", + "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 the charge that customers see on their statements. Concatenated with the\nprefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete\nstatement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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" }, @@ -75290,7 +87744,11 @@ "destination" ], "title": "transfer_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, "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.", @@ -75298,7 +87756,23 @@ } }, "title": "payment_intent_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_amount", + "capture_method", + "cross_border_classification", + "description", + "fulfillment_date", + "metadata", + "on_behalf_of", + "receipt_email", + "setup_future_usage", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix", + "transfer_data", + "transfer_group" + ] }, "payment_method_collection": { "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).", @@ -75327,7 +87801,10 @@ } }, "title": "payment_method_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redisplay" + ] }, "payment_method_options": { "description": "Payment-method-specific configuration.", @@ -75395,10 +87872,17 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session", @@ -75418,13 +87902,19 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "setup_future_usage", + "verification_method" + ] }, "affirm": { "description": "contains details about the Affirm payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75432,13 +87922,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "afterpay_clearpay": { "description": "contains details about the Afterpay Clearpay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75446,13 +87939,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "alipay": { "description": "contains details about the Alipay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75460,13 +87956,17 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "setup_future_usage" + ] }, "amazon_pay": { "description": "contains details about the AmazonPay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session" @@ -75475,13 +87975,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "au_becs_debit": { "description": "contains details about the AU Becs Debit payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75489,13 +87992,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "bacs_debit": { "description": "contains details about the Bacs Debit payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session", @@ -75505,13 +88011,17 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "target_date" + ] }, "bancontact": { "description": "contains details about the Bancontact payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75519,7 +88029,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "boleto": { "description": "contains details about the Boleto payment method options.", @@ -75529,7 +88042,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session", @@ -75539,7 +88052,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "card": { "description": "contains details about the Card payment method options.", @@ -75553,7 +88070,10 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "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.", @@ -75566,7 +88086,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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": [ "off_session", "on_session" @@ -75585,13 +88105,26 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "request_decremental_authorization", + "request_extended_authorization", + "request_incremental_authorization", + "request_multicapture", + "request_overcapture", + "request_three_d_secure", + "restrictions", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji" + ] }, "cashapp": { "description": "contains details about the Cashapp Pay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session", @@ -75601,7 +88134,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "customer_balance": { "description": "contains details about the Customer Balance payment method options.", @@ -75622,7 +88158,10 @@ "country" ], "title": "eu_bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -75658,7 +88197,13 @@ "type" ], "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "requested_address_types", + "type" + ] }, "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`.", @@ -75668,7 +88213,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75676,13 +88221,18 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" + ] }, "eps": { "description": "contains details about the EPS payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75690,13 +88240,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "fpx": { "description": "contains details about the FPX payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75704,13 +88257,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "giropay": { "description": "contains details about the Giropay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75718,13 +88274,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "grabpay": { "description": "contains details about the Grabpay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75732,13 +88291,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "ideal": { "description": "contains details about the Ideal payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75746,13 +88308,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "klarna": { "description": "contains details about the Klarna payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75760,7 +88325,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "konbini": { "description": "contains details about the Konbini payment method options.", @@ -75770,7 +88338,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75778,13 +88346,17 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "link": { "description": "contains details about the Link payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session" @@ -75793,13 +88365,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "mobilepay": { "description": "contains details about the Mobilepay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75807,13 +88382,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "multibanco": { "description": "contains details about the Multibanco payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75821,7 +88399,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "oxxo": { "description": "contains details about the OXXO payment method options.", @@ -75831,7 +88412,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75839,13 +88420,17 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, "p24": { "description": "contains details about the P24 payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75857,13 +88442,17 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "tos_shown_and_accepted" + ] }, "paynow": { "description": "contains details about the PayNow payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75871,7 +88460,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "paypal": { "description": "contains details about the PayPal payment method options.", @@ -75923,7 +88515,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -75933,7 +88525,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "reference", + "reference_id", + "risk_correlation_id", + "setup_future_usage", + "subsellers" + ] }, "pix": { "description": "contains details about the Pix payment method options.", @@ -75944,13 +88545,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_seconds" + ] }, "revolut_pay": { "description": "contains details about the RevolutPay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session" @@ -75959,13 +88563,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "sepa_debit": { "description": "contains details about the Sepa Debit payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session", @@ -75975,13 +88582,18 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "target_date", + "verification_method" + ] }, "sofort": { "description": "contains details about the Sofort payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -75989,7 +88601,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, "swish": { "description": "contains details about the Swish payment method options.", @@ -76001,7 +88616,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorization_method", + "reference" + ] }, "us_bank_account": { "description": "contains details about the Us Bank Account payment method options.", @@ -76039,10 +88658,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "permissions", + "prefetch" + ] }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", "off_session", @@ -76061,7 +88684,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "setup_future_usage", + "verification_method" + ] }, "wechat_pay": { "description": "contains details about the WeChat Pay payment method options.", @@ -76082,7 +88710,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -76093,11 +88721,62 @@ "client" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "boleto", + "card", + "cashapp", + "customer_balance", + "demo_pay", + "eps", + "fpx", + "giropay", + "grabpay", + "id_bank_transfer", + "ideal", + "klarna", + "konbini", + "kr_market", + "link", + "mobilepay", + "multibanco", + "ng_bank", + "ng_bank_transfer", + "ng_card", + "ng_market", + "ng_ussd", + "oxxo", + "p24", + "pay_by_bank", + "paynow", + "paypal", + "payto", + "pix", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "upi", + "us_bank_account", + "wechat_pay" + ] }, "payment_method_types": { "description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nYou can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nSee [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.", @@ -76158,10 +88837,13 @@ "enabled" ], "title": "phone_number_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "redirect_on_completion": { - "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -76199,7 +88881,12 @@ } }, "title": "saved_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redisplay_filters", + "payment_method_remove", + "payment_method_save" + ] }, "setup_intent_data": { "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.", @@ -76222,7 +88909,12 @@ } }, "title": "setup_intent_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "metadata", + "on_behalf_of" + ] }, "shipping_address_collection": { "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.", @@ -76478,7 +89170,10 @@ "allowed_countries" ], "title": "shipping_address_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_countries" + ] }, "shipping_options": { "description": "The shipping rate options to apply to this Session. Up to a maximum of 5.", @@ -76519,7 +89214,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -76545,11 +89244,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -76588,7 +89295,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "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" @@ -76599,7 +89310,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -76633,11 +89349,21 @@ "display_name" ], "title": "method_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } }, "title": "shipping_option_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate", + "shipping_rate_data" + ] }, "type": "array" }, @@ -76649,7 +89375,8 @@ "donate", "pay" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "subscription_data": { "description": "A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.", @@ -76699,11 +89426,18 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "issuer" + ] }, "metadata": { "additionalProperties": { @@ -76740,7 +89474,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "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.", @@ -76771,18 +89509,38 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] } }, "title": "subscription_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_percent", + "billing_cycle_anchor", + "default_tax_rates", + "description", + "invoice_settings", + "metadata", + "on_behalf_of", + "proration_behavior", + "tax_filing_currency", + "transfer_data", + "trial_end", + "trial_period_days" + ] }, "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`. 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).", @@ -76795,13 +89553,25 @@ "enabled": { "description": "Enable tax ID collection during checkout. Defaults to `false`.", "type": "boolean" + }, + "required": { + "description": "Describes whether a tax ID is required during checkout. Defaults to `never`.", + "enum": [ + "if_supported", + "never" + ], + "type": "string" } }, "required": [ "enabled" ], "title": "tax_id_collection_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "required" + ] }, "ui_mode": { "description": "The UI mode of the Session. Defaults to `hosted`.", @@ -76813,6 +89583,84 @@ "x-stripeBypassValidation": true } }, + "type": "object", + "x-stripeMostCommon": [ + "client_reference_id", + "customer", + "customer_email", + "line_items", + "metadata", + "mode", + "return_url", + "success_url" + ] + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout.session" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/checkout/sessions/{session}": { + "get": { + "description": "Retrieves a Session object.
", + "operationId": "GetCheckoutSessionsSession", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "session", + "required": true, + "schema": { + "maxLength": 66, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, "type": "object" } } @@ -76841,34 +89689,17 @@ "description": "Error response." } } - } - }, - "/v1/checkout/sessions/{session}": { - "get": { - "description": "Retrieves a Session object.
", - "operationId": "GetCheckoutSessionsSession", + }, + "post": { + "description": "Updates a Session object.
", + "operationId": "PostCheckoutSessionsSession", "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, { "in": "path", "name": "session", "required": true, "schema": { - "maxLength": 66, + "maxLength": 5000, "type": "string" }, "style": "simple" @@ -76877,11 +89708,49 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "encoding": {}, + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + } + }, "schema": { "additionalProperties": false, - "properties": {}, - "type": "object" + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -77095,6 +89964,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -77221,6 +90096,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -77279,7 +90160,10 @@ "public_name" ], "title": "beneficiary_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "public_name" + ] }, "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.", @@ -77315,7 +90199,15 @@ "required": [ "product" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "beneficiary", + "currency", + "metadata", + "metric_tons", + "product" + ] } } }, @@ -77473,7 +90365,10 @@ "public_name" ], "title": "beneficiary_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "public_name" + ] }, { "enum": [ @@ -77500,7 +90395,11 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "beneficiary", + "metadata" + ] } } }, @@ -77705,6 +90604,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -77899,6 +90804,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -78161,6 +91072,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -78281,7 +91198,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -78392,6 +91315,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -78454,7 +91383,11 @@ } }, "title": "applies_to_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "product_classes", + "products" + ] }, "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).", @@ -78472,7 +91405,10 @@ "amount_off" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_off" + ] }, "description": "Coupons defined in each available currency option (only supported if `amount_off` is passed). 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" @@ -78540,7 +91476,16 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_off", + "currency", + "duration", + "duration_in_months", + "metadata", + "name", + "percent_off" + ] } } }, @@ -78735,7 +91680,10 @@ "amount_off" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_off" + ] }, "description": "Coupons defined in each available currency option (only supported if the coupon is amount-based). 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" @@ -78771,7 +91719,11 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "name" + ] } } }, @@ -78834,7 +91786,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -78966,6 +91924,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -79024,6 +91988,14 @@ "format": "unix-time", "type": "integer" }, + "email_type": { + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", + "enum": [ + "credit_note", + "none" + ], + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -79084,7 +92056,12 @@ "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate", + "taxable_amount" + ] }, "type": "array" }, @@ -79137,7 +92114,18 @@ "type" ], "title": "credit_note_line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_line_item", + "quantity", + "tax_amounts", + "tax_rates", + "type", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -79185,13 +92173,23 @@ } }, "title": "credit_note_shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate" + ] } }, "required": [ "invoice" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice", + "lines", + "memo", + "metadata", + "reason" + ] } } }, @@ -79257,6 +92255,20 @@ }, "style": "form" }, + { + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", + "in": "query", + "name": "email_type", + "required": false, + "schema": { + "enum": [ + "credit_note", + "none" + ], + "type": "string" + }, + "style": "form" + }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, @@ -79335,7 +92347,12 @@ "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate", + "taxable_amount" + ] }, "type": "array" }, @@ -79388,7 +92405,18 @@ "type" ], "title": "credit_note_line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_line_item", + "quantity", + "tax_amounts", + "tax_rates", + "type", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -79480,7 +92508,10 @@ } }, "title": "credit_note_shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate" + ] }, "style": "deepObject" } @@ -79558,6 +92589,20 @@ }, "style": "form" }, + { + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", + "in": "query", + "name": "email_type", + "required": false, + "schema": { + "enum": [ + "credit_note", + "none" + ], + "type": "string" + }, + "style": "form" + }, { "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", "in": "query", @@ -79657,7 +92702,12 @@ "taxable_amount" ], "title": "tax_amount_with_tax_rate_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate", + "taxable_amount" + ] }, "type": "array" }, @@ -79710,7 +92760,18 @@ "type" ], "title": "credit_note_line_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_line_item", + "quantity", + "tax_amounts", + "tax_rates", + "type", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -79802,7 +92863,10 @@ } }, "title": "credit_note_shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate" + ] }, "style": "deepObject" }, @@ -79872,6 +92936,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -80008,6 +93078,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -80146,7 +93222,11 @@ "type": "object" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "memo", + "metadata" + ] } } }, @@ -80245,7 +93325,7 @@ }, "/v1/customer_sessions": { "post": { - "description": "Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.
", + "description": "Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.
", "operationId": "PostCustomerSessions", "requestBody": { "content": { @@ -80278,7 +93358,96 @@ "enabled" ], "title": "buy_button_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] + }, + "payment_element": { + "description": "Configuration for the Payment Element.", + "properties": { + "enabled": { + "description": "Whether the Payment Element is enabled.", + "type": "boolean" + }, + "features": { + "description": "This hash defines whether the Payment Element supports certain features.", + "properties": { + "payment_method_allow_redisplay_filters": { + "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].", + "items": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_redisplay": { + "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": 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" + }, + "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).", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": 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`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": 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.", + "enum": [ + "off_session", + "on_session" + ], + "type": "string" + } + }, + "title": "features_param", + "type": "object", + "x-stripeMostCommon": [ + "payment_method_allow_redisplay_filters", + "payment_method_redisplay", + "payment_method_redisplay_limit", + "payment_method_remove", + "payment_method_save", + "payment_method_save_usage", + "payment_method_set_as_default", + "payment_method_update" + ] + } + }, + "required": [ + "enabled" + ], + "title": "payment_element_param", + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "features" + ] }, "pricing_table": { "description": "Configuration for the pricing table.", @@ -80292,14 +93461,25 @@ "enabled" ], "title": "pricing_table_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] } }, "title": "components", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "buy_button", + "customer_sheet", + "mobile_payment_element", + "payment_element", + "payment_sheet", + "pricing_table" + ] }, "customer": { - "description": "The ID of an existing customer for which to create the customer session.", + "description": "The ID of an existing customer for which to create the Customer Session.", "maxLength": 5000, "type": "string" }, @@ -80316,7 +93496,11 @@ "components", "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "components", + "customer" + ] } } }, @@ -80379,7 +93563,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -80512,6 +93702,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -80613,7 +93809,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -80645,11 +93849,17 @@ } }, "title": "balance_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reconciliation_mode" + ] } }, "title": "cash_balance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "settings" + ] }, "coupon": { "maxLength": 5000, @@ -80702,7 +93912,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -80737,10 +93951,20 @@ "include_inclusive_tax" ], "type": "string" + }, + "template": { + "description": "ID of the invoice rendering template to use for future invoices.", + "maxLength": 5000, + "type": "string" } }, "title": "customer_rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title", + "template" + ] }, { "enum": [ @@ -80753,7 +93977,18 @@ } }, "title": "customer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_to_forgive", + "amount_to_forgive_currency", + "custom_fields", + "days_until_due", + "default_payment_method", + "footer", + "rendering_options", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "metadata": { "anyOf": [ @@ -80842,7 +94077,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -80860,7 +94103,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -80903,7 +94151,11 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "validate_location" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -80920,7 +94172,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_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", @@ -80938,6 +94190,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -80953,6 +94206,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -81009,7 +94263,11 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" }, @@ -81022,7 +94280,17 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "description", + "email", + "metadata", + "name", + "payment_method", + "phone", + "shipping" + ] } } }, @@ -81166,6 +94434,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -81401,7 +94677,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -81433,11 +94717,17 @@ } }, "title": "balance_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reconciliation_mode" + ] } }, "title": "cash_balance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "settings" + ] }, "coupon": { "maxLength": 5000, @@ -81495,7 +94785,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -81530,10 +94824,20 @@ "include_inclusive_tax" ], "type": "string" + }, + "template": { + "description": "ID of the invoice rendering template to use for future invoices.", + "maxLength": 5000, + "type": "string" } }, "title": "customer_rendering_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "invoice_title", + "template" + ] }, { "enum": [ @@ -81546,7 +94850,18 @@ } }, "title": "customer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_to_forgive", + "amount_to_forgive_currency", + "custom_fields", + "days_until_due", + "default_payment_method", + "footer", + "rendering_options", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "metadata": { "anyOf": [ @@ -81631,7 +94946,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -81649,7 +94972,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -81692,7 +95020,11 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "validate_location" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -81708,7 +95040,16 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "description", + "email", + "metadata", + "name", + "phone", + "shipping" + ] } } }, @@ -81855,6 +95196,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -81947,7 +95294,13 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "metadata" + ] } } }, @@ -82125,7 +95478,11 @@ "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-stripeMostCommon": [ + "description", + "metadata" + ] } } }, @@ -82275,10 +95632,16 @@ } }, "title": "balance_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reconciliation_mode" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "settings" + ] } } }, @@ -82425,6 +95788,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -82622,7 +95991,10 @@ "country" ], "title": "eu_bank_account_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -82655,7 +96027,12 @@ "type" ], "title": "bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "requested_address_types", + "type" + ] }, "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).", @@ -82682,7 +96059,12 @@ "currency", "funding_type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "currency", + "funding_type" + ] } } }, @@ -82891,6 +96273,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -83114,6 +96502,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -83191,7 +96585,11 @@ "required": [ "source" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "source" + ] } } }, @@ -83545,7 +96943,15 @@ } }, "title": "source_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "email": { "description": "Owner's email address.", @@ -83563,10 +96969,31 @@ } }, "title": "owner", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_name", + "account_holder_type", + "address_city", + "address_country", + "address_line1", + "address_line2", + "address_state", + "address_zip", + "exp_month", + "exp_year", + "metadata", + "name", + "owner" + ] } } }, @@ -83664,7 +97091,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amounts" + ] } } }, @@ -83811,6 +97241,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -83865,7 +97301,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_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", @@ -83883,6 +97319,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -83898,6 +97335,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -83953,7 +97391,11 @@ "type", "value" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] } } }, @@ -84137,6 +97579,7 @@ "style": "form" }, { + "description": "Only return disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -84163,7 +97606,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -84285,6 +97734,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -84537,7 +97992,45 @@ } }, "title": "dispute_evidence_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "access_activity_log", + "billing_address", + "booking", + "cancellation_policy", + "cancellation_policy_disclosure", + "cancellation_rebuttal", + "credit_voucher", + "customer_communication", + "customer_email_address", + "customer_name", + "customer_purchase_ip", + "customer_signature", + "duplicate_charge_documentation", + "duplicate_charge_explanation", + "duplicate_charge_id", + "enhanced_evidence", + "event_details", + "government_order", + "narrative", + "prior_undisputed_payments", + "product_description", + "product_service_ad", + "receipt", + "refund_policy", + "refund_policy_disclosure", + "refund_refusal_explanation", + "service_date", + "service_documentation", + "shipping_address", + "shipping_carrier", + "shipping_date", + "shipping_documentation", + "shipping_tracking_number", + "terms_disclosure", + "uncategorized_file", + "uncategorized_text" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -84569,7 +98062,12 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "evidence", + "metadata", + "submit" + ] } } }, @@ -84783,6 +98281,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -84999,6 +98503,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -85066,7 +98576,12 @@ "lookup_key", "name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "lookup_key", + "metadata", + "name" + ] } } }, @@ -85230,7 +98745,11 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "name" + ] } } }, @@ -85305,7 +98824,13 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "issuing_card", + "nonce", + "verification_session" + ] } } }, @@ -85435,7 +98960,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -85582,6 +99113,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -85603,7 +99140,7 @@ }, "/v1/events/{id}": { "get": { - "description": "Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
", + "description": "Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
", "operationId": "GetEventsId", "parameters": [ { @@ -85776,6 +99313,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -85896,7 +99439,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -86027,6 +99576,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -86078,7 +99633,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" }, @@ -86103,7 +99658,12 @@ "required": [ "file" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_at", + "file", + "metadata" + ] } } }, @@ -86281,7 +99841,11 @@ "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-stripeMostCommon": [ + "expires_at", + "metadata" + ] } } }, @@ -86344,7 +99908,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -86406,6 +99976,7 @@ "finance_report_run", "identity_document", "identity_document_downloadable", + "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", @@ -86484,6 +100055,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -86538,7 +100115,7 @@ "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": { @@ -86568,7 +100145,12 @@ "create" ], "title": "file_link_creation_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "create", + "expires_at", + "metadata" + ] }, "purpose": { "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.", @@ -86580,6 +100162,7 @@ "customer_signature", "dispute_evidence", "identity_document", + "issuing_regulatory_reporting", "pci_document", "tax_document_user_upload", "terminal_reader_splashscreen" @@ -86592,7 +100175,11 @@ "file", "purpose" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "file", + "purpose" + ] } } }, @@ -86720,7 +100307,11 @@ } }, "title": "accountholder_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer" + ] }, "style": "deepObject" }, @@ -86838,6 +100429,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -87120,6 +100717,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -87196,7 +100799,10 @@ "required": [ "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features" + ] } } }, @@ -87281,7 +100887,10 @@ "required": [ "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features" + ] } } }, @@ -87366,7 +100975,10 @@ "required": [ "features" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features" + ] } } }, @@ -87454,7 +101066,12 @@ "type" ], "title": "accountholder_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer", + "type" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -87467,6 +101084,20 @@ "filters": { "description": "Filters to restrict the kinds of accounts to collect.", "properties": { + "account_subcategories": { + "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", + "items": { + "enum": [ + "checking", + "credit_card", + "line_of_credit", + "mortgage", + "savings" + ], + "type": "string" + }, + "type": "array" + }, "countries": { "description": "List of countries from which to collect accounts.", "items": { @@ -87477,7 +101108,12 @@ } }, "title": "filters_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "countries", + "institution" + ] }, "permissions": { "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.", @@ -87517,7 +101153,14 @@ "account_holder", "permissions" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder", + "filters", + "permissions", + "prefetch", + "return_url" + ] } } }, @@ -87706,7 +101349,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -87733,7 +101382,10 @@ "after" ], "title": "transaction_refresh_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "after" + ] }, "style": "deepObject" } @@ -87793,6 +101445,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -87911,7 +101569,13 @@ } }, "title": "created_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, "style": "deepObject" }, @@ -88016,6 +101680,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -88111,13 +101781,21 @@ "value" ], "title": "header_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" } }, "title": "request_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "body", + "headers" + ] }, "url": { "description": "The destination URL for the forwarded request. Must be supported by the config.", @@ -88130,7 +101808,13 @@ "replacements", "url" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method", + "replacements", + "request", + "url" + ] } } }, @@ -88272,7 +101956,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -88409,6 +102099,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -88540,7 +102236,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -88585,6 +102287,16 @@ }, "style": "form" }, + { + "in": "query", + "name": "related_customer", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", "in": "query", @@ -88667,6 +102379,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -88765,7 +102483,13 @@ } }, "title": "document_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_types", + "require_id_number", + "require_live_capture", + "require_matching_selfie" + ] }, { "enum": [ @@ -88778,7 +102502,16 @@ } }, "title": "session_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document", + "duplicate", + "email", + "matching", + "phone", + "phone_otp", + "phone_records" + ] }, "provided_details": { "description": "Details provided about the user being verified. These details may be shown to the user.", @@ -88793,7 +102526,19 @@ } }, "title": "provided_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "name", + "phone" + ] + }, + "related_customer": { + "description": "Token referencing a Customer resource.", + "maxLength": 5000, + "type": "string" }, "return_url": { "description": "The URL that the user will be redirected to upon completing the verification flow.", @@ -88814,6 +102559,402 @@ "type": "string" } }, + "type": "object", + "x-stripeMostCommon": [ + "client_reference_id", + "metadata", + "options", + "provided_details", + "related_customer", + "return_url", + "type", + "verification_flow" + ] + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/identity.verification_session" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/identity/verification_sessions/{session}": { + "get": { + "description": "Retrieves the details of a VerificationSession that was previously created.
\n\nWhen the session status is requires_input, you can use this method to retrieve a valid\nclient_secret or url to allow re-submission.
Updates a VerificationSession object.
\n\nWhen the session status is requires_input, you can use this method to update the\nverification check and options.
A VerificationSession object can be canceled when it is in requires_input status.
Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
", + "operationId": "PostIdentityVerificationSessionsSessionCancel", + "parameters": [ + { + "in": "path", + "name": "session", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/identity.verification_session" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/identity/verification_sessions/{session}/redact": { + "post": { + "description": "Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.
\n\nA VerificationSession object can be redacted when it is in requires_input or verified\nstatus. Redacting a VerificationSession in requires_action\nstate will automatically cancel it.
The redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.
Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.
Retrieves the details of a VerificationSession that was previously created.
\n\nWhen the session status is requires_input, you can use this method to retrieve a valid\nclient_secret or url to allow re-submission.
List all templates, ordered by creation date, with the most recently created template appearing first.
", + "operationId": "GetInvoiceRenderingTemplates", "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, @@ -88865,14 +103017,38 @@ "style": "deepObject" }, { - "in": "path", - "name": "session", - "required": true, + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, "schema": { "maxLength": 5000, "type": "string" }, - "style": "simple" + "style": "form" + }, + { + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "archived" + ], + "type": "string" + }, + "style": "form" } ], "requestBody": { @@ -88893,7 +103069,49 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/identity.verification_session" + "description": "", + "properties": { + "data": { + "description": "Details about each object.", + "items": { + "$ref": "#/components/schemas/invoice_rendering_template" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "InvoiceRenderingTemplatesList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] } } }, @@ -88910,134 +103128,55 @@ "description": "Error response." } } - }, - "post": { - "description": "Updates a VerificationSession object.
\n\nWhen the session status is requires_input, you can use this method to update the\nverification check and options.
Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
", + "operationId": "GetInvoiceRenderingTemplatesTemplate", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, { "in": "path", - "name": "session", + "name": "template", "required": true, "schema": { "maxLength": 5000, "type": "string" }, "style": "simple" + }, + { + "in": "query", + "name": "version", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - }, - "options": { - "explode": true, - "style": "deepObject" - }, - "provided_details": { - "explode": true, - "style": "deepObject" - } - }, + "encoding": {}, "schema": { "additionalProperties": false, - "properties": { - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", - "type": "object" - }, - "options": { - "description": "A set of options for the session’s verification checks.", - "properties": { - "document": { - "anyOf": [ - { - "properties": { - "allowed_types": { - "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.", - "items": { - "enum": [ - "driving_license", - "id_card", - "passport" - ], - "type": "string" - }, - "type": "array" - }, - "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" - }, - "require_live_capture": { - "description": "Disable image uploads, identity document images have to be captured using the device’s camera.", - "type": "boolean" - }, - "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" - } - }, - "title": "document_options", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document)." - } - }, - "title": "session_options_param", - "type": "object" - }, - "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" - }, - "phone": { - "description": "Phone number of user being verified", - "type": "string" - } - }, - "title": "provided_details_param", - "type": "object" - }, - "type": { - "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", - "enum": [ - "document", - "id_number" - ], - "type": "string", - "x-stripeBypassValidation": true - } - }, + "properties": {}, "type": "object" } } @@ -89049,7 +103188,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/identity.verification_session" + "$ref": "#/components/schemas/invoice_rendering_template" } } }, @@ -89068,14 +103207,14 @@ } } }, - "/v1/identity/verification_sessions/{session}/cancel": { + "/v1/invoice_rendering_templates/{template}/archive": { "post": { - "description": "A VerificationSession object can be canceled when it is in requires_input status.
Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
", - "operationId": "PostIdentityVerificationSessionsSessionCancel", + "description": "Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
", + "operationId": "PostInvoiceRenderingTemplatesTemplateArchive", "parameters": [ { "in": "path", - "name": "session", + "name": "template", "required": true, "schema": { "maxLength": 5000, @@ -89116,7 +103255,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/identity.verification_session" + "$ref": "#/components/schemas/invoice_rendering_template" } } }, @@ -89135,14 +103274,14 @@ } } }, - "/v1/identity/verification_sessions/{session}/redact": { + "/v1/invoice_rendering_templates/{template}/unarchive": { "post": { - "description": "Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.
\n\nA VerificationSession object can be redacted when it is in requires_input or verified\nstatus. Redacting a VerificationSession in requires_action\nstate will automatically cancel it.
The redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.
Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.
Unarchive an invoice rendering template so it can be used on new Stripe objects again.
", + "operationId": "PostInvoiceRenderingTemplatesTemplateUnarchive", "parameters": [ { "in": "path", - "name": "session", + "name": "template", "required": true, "schema": { "maxLength": 5000, @@ -89183,7 +103322,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/identity.verification_session" + "$ref": "#/components/schemas/invoice_rendering_template" } } }, @@ -89235,7 +103374,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -89378,6 +103523,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -89479,7 +103630,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -89541,7 +103695,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -89584,7 +103742,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -89639,7 +103802,16 @@ "required": [ "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "metadata", + "period", + "price" + ] } } }, @@ -89873,7 +104045,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -89930,7 +104105,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -89973,7 +104152,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -90030,7 +104214,14 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "metadata", + "period", + "price" + ] } } }, @@ -90107,7 +104298,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -90154,7 +104351,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -90294,6 +104497,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -90432,14 +104641,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "collection_method": { "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.", @@ -90474,7 +104691,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -90541,7 +104762,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -90599,7 +104823,11 @@ "invoice" ], "title": "from_invoice", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "action", + "invoice" + ] }, "issuer": { "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", @@ -90621,7 +104849,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "anyOf": [ @@ -90687,7 +104919,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -90701,7 +104936,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -90728,7 +104967,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -90755,11 +104997,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "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" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -90770,16 +105012,20 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -90792,7 +105038,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "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.", @@ -90805,7 +105055,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "request_three_d_secure" + ] }, { "enum": [ @@ -90836,7 +105090,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -90844,7 +105101,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "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`.", @@ -90852,7 +105114,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -90884,7 +105150,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -90902,6 +105171,28 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -90932,7 +105223,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -90946,7 +105242,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -90959,7 +105259,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -90984,6 +105294,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -91012,7 +105323,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_mandate", + "payment_method_options", + "payment_method_types" + ] }, "pending_invoice_items_behavior": { "description": "How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.", @@ -91049,11 +105365,42 @@ } }, "title": "rendering_pdf_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "page_size" + ] + }, + "template": { + "description": "ID of the invoice rendering template to use for this invoice.", + "maxLength": 5000, + "type": "string" + }, + "template_version": { + "anyOf": [ + { + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The specific version of invoice rendering template to use for this invoice." } }, "title": "rendering_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "custom_text", + "invoice_title", + "pdf", + "summary_items_data", + "template", + "template_version" + ] }, "shipping_cost": { "description": "Settings for the cost of shipping for this invoice.", @@ -91093,7 +105440,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -91119,11 +105470,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -91162,7 +105521,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "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" @@ -91173,7 +105536,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -91207,11 +105575,21 @@ "display_name" ], "title": "method_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } }, "title": "shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate", + "shipping_rate_data" + ] }, "shipping_details": { "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.", @@ -91251,7 +105629,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Recipient name.", @@ -91279,7 +105665,12 @@ "name" ], "title": "recipient_shipping_with_optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, "statement_descriptor": { "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.", @@ -91307,10 +105698,22 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "auto_advance", + "collection_method", + "customer", + "description", + "metadata", + "subscription" + ] } } }, @@ -91415,14 +105818,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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.", @@ -91477,7 +105888,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -91527,7 +105946,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -91545,7 +105972,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -91575,7 +106007,10 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -91592,7 +106027,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_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", @@ -91610,6 +106045,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -91625,6 +106061,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -91681,13 +106118,24 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" } }, "title": "customer_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "shipping", + "tax", + "tax_exempt", + "tax_ids" + ] }, "discounts": { "anyOf": [ @@ -91711,7 +106159,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -91733,7 +106184,7 @@ "type": "array" }, "invoice_items": { - "description": "List of invoice items to add or update in the upcoming invoice preview.", + "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "items": { "properties": { "amount": { @@ -91775,7 +106226,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -91829,7 +106283,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -91872,7 +106330,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -91930,7 +106393,24 @@ } }, "title": "invoice_item_preview_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "discountable", + "discounts", + "invoiceitem", + "metadata", + "period", + "price", + "quantity", + "tax_behavior", + "tax_code", + "tax_rates", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -91954,7 +106434,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "on_behalf_of": { "anyOf": [ @@ -92023,7 +106507,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -92054,7 +106541,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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" }, "unit_amount_decimal": { @@ -92068,7 +106555,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -92095,6 +106587,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -92132,14 +106628,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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).", @@ -92163,7 +106667,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -92251,7 +106759,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -92325,11 +106836,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -92348,7 +106873,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -92381,7 +106909,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -92445,7 +106976,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -92472,7 +107006,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -92498,7 +107038,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -92558,7 +107108,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -92585,7 +107139,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -92600,7 +107183,15 @@ } }, "title": "schedule_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amendments", + "billing_behavior", + "end_behavior", + "phases", + "prebilling", + "proration_behavior" + ] }, "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.", @@ -92643,7 +107234,7 @@ "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancel_now": { @@ -92685,7 +107276,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -92726,7 +107320,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -92805,7 +107402,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -92832,7 +107432,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -92858,7 +107464,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -92907,10 +107525,28 @@ } }, "title": "subscription_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "cancel_at", + "cancel_at_period_end", + "cancel_now", + "default_tax_rates", + "items", + "prebilling", + "proration_behavior", + "proration_date", + "resume_at", + "start_date", + "trial_end" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "subscription" + ] } } }, @@ -93054,6 +107690,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -93110,14 +107754,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "style": "deepObject" }, @@ -93197,7 +107849,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -93247,7 +107907,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -93265,7 +107933,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -93295,7 +107968,10 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -93312,7 +107988,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_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", @@ -93330,6 +108006,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -93345,6 +108022,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -93401,13 +108079,24 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" } }, "title": "customer_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "shipping", + "tax", + "tax_exempt", + "tax_ids" + ] }, "style": "deepObject" }, @@ -93439,7 +108128,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -93469,7 +108161,7 @@ "style": "deepObject" }, { - "description": "List of invoice items to add or update in the upcoming invoice preview.", + "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "explode": true, "in": "query", "name": "invoice_items", @@ -93516,7 +108208,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -93570,7 +108265,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -93613,7 +108312,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -93671,7 +108375,24 @@ } }, "title": "invoice_item_preview_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "discountable", + "discounts", + "invoiceitem", + "metadata", + "period", + "price", + "quantity", + "tax_behavior", + "tax_code", + "tax_rates", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -93702,7 +108423,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "style": "deepObject" }, @@ -93797,7 +108522,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -93828,7 +108556,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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" }, "unit_amount_decimal": { @@ -93842,7 +108570,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -93869,6 +108602,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -93906,14 +108643,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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).", @@ -93937,7 +108682,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -94025,7 +108774,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94099,11 +108851,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -94122,7 +108888,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -94155,7 +108924,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94219,7 +108991,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -94246,7 +109021,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -94272,7 +109053,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -94332,7 +109123,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -94359,7 +109154,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -94374,7 +109198,15 @@ } }, "title": "schedule_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amendments", + "billing_behavior", + "end_behavior", + "phases", + "prebilling", + "proration_behavior" + ] }, "style": "deepObject" }, @@ -94436,7 +109268,7 @@ "style": "deepObject" }, { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", "in": "query", "name": "subscription_cancel_at_period_end", "required": false, @@ -94521,7 +109353,7 @@ "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancel_now": { @@ -94563,7 +109395,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -94604,7 +109439,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94683,7 +109521,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -94710,7 +109551,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -94736,7 +109583,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -94785,7 +109644,21 @@ } }, "title": "subscription_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "cancel_at", + "cancel_at_period_end", + "cancel_now", + "default_tax_rates", + "items", + "prebilling", + "proration_behavior", + "proration_date", + "resume_at", + "start_date", + "trial_end" + ] }, "style": "deepObject" }, @@ -94811,7 +109684,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -94852,7 +109728,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -94931,7 +109810,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -94958,7 +109840,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -94984,7 +109872,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -95149,14 +110049,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "style": "deepObject" }, @@ -95236,7 +110144,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -95286,7 +110202,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Customer name.", @@ -95304,7 +110228,12 @@ "name" ], "title": "customer_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -95334,7 +110263,10 @@ } }, "title": "tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address" + ] }, "tax_exempt": { "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", @@ -95351,7 +110283,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_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", @@ -95369,6 +110301,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -95384,6 +110317,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -95440,13 +110374,24 @@ "value" ], "title": "data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] }, "type": "array" } }, "title": "customer_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "shipping", + "tax", + "tax_exempt", + "tax_ids" + ] }, "style": "deepObject" }, @@ -95478,7 +110423,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -95519,7 +110467,7 @@ "style": "deepObject" }, { - "description": "List of invoice items to add or update in the upcoming invoice preview.", + "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).", "explode": true, "in": "query", "name": "invoice_items", @@ -95566,7 +110514,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -95620,7 +110571,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -95663,7 +110618,12 @@ "product" ], "title": "one_time_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the invoice item.", @@ -95721,7 +110681,24 @@ } }, "title": "invoice_item_preview_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "discountable", + "discounts", + "invoiceitem", + "metadata", + "period", + "price", + "quantity", + "tax_behavior", + "tax_code", + "tax_rates", + "unit_amount", + "unit_amount_decimal" + ] }, "type": "array" }, @@ -95752,7 +110729,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "style": "deepObject" }, @@ -95857,7 +110838,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -95888,7 +110872,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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" }, "unit_amount_decimal": { @@ -95902,7 +110886,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -95929,6 +110918,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -95966,14 +110959,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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).", @@ -95997,7 +110998,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -96085,7 +111090,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -96159,11 +111167,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -96182,7 +111204,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -96215,7 +111240,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -96279,7 +111307,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -96306,7 +111337,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -96332,7 +111369,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -96392,7 +111439,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -96419,7 +111470,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -96434,7 +111514,15 @@ } }, "title": "schedule_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amendments", + "billing_behavior", + "end_behavior", + "phases", + "prebilling", + "proration_behavior" + ] }, "style": "deepObject" }, @@ -96507,7 +111595,7 @@ "style": "deepObject" }, { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", "in": "query", "name": "subscription_cancel_at_period_end", "required": false, @@ -96592,7 +111680,7 @@ "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancel_now": { @@ -96634,7 +111722,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -96675,7 +111766,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -96754,7 +111848,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -96781,7 +111878,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -96807,7 +111910,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -96856,7 +111971,21 @@ } }, "title": "subscription_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "cancel_at", + "cancel_at_period_end", + "cancel_now", + "default_tax_rates", + "items", + "prebilling", + "proration_behavior", + "proration_date", + "resume_at", + "start_date", + "trial_end" + ] }, "style": "deepObject" }, @@ -96882,7 +112011,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -96923,7 +112055,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -97002,7 +112137,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -97029,7 +112167,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -97055,7 +112199,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -97200,6 +112356,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -97481,14 +112643,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "collection_method": { "description": "Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.", @@ -97519,7 +112689,11 @@ "value" ], "title": "custom_field_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "name", + "value" + ] }, "type": "array" }, @@ -97601,7 +112775,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -97667,7 +112844,11 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] }, "metadata": { "anyOf": [ @@ -97753,7 +112934,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -97767,7 +112951,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -97794,7 +112982,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -97821,11 +113012,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "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" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -97836,16 +113027,20 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -97858,7 +113053,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "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.", @@ -97871,7 +113070,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "request_three_d_secure" + ] }, { "enum": [ @@ -97902,7 +113105,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -97910,7 +113116,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "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`.", @@ -97918,7 +113129,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -97950,7 +113165,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -97968,6 +113186,28 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -97998,7 +113238,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -98012,7 +113257,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -98025,7 +113274,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -98050,6 +113309,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -98078,7 +113338,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "default_mandate", + "payment_method_options", + "payment_method_types" + ] }, "rendering": { "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", @@ -98106,11 +113371,42 @@ } }, "title": "rendering_pdf_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "page_size" + ] + }, + "template": { + "description": "ID of the invoice rendering template to use for this invoice.", + "maxLength": 5000, + "type": "string" + }, + "template_version": { + "anyOf": [ + { + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The specific version of invoice rendering template to use for this invoice." } }, "title": "rendering_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_tax_display", + "custom_text", + "invoice_title", + "pdf", + "summary_items_data", + "template", + "template_version" + ] }, "shipping_cost": { "anyOf": [ @@ -98151,7 +113447,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -98177,11 +113477,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -98220,7 +113528,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "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" @@ -98231,7 +113543,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -98265,11 +113582,21 @@ "display_name" ], "title": "method_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } }, "title": "shipping_cost", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "shipping_rate", + "shipping_rate_data" + ] }, { "enum": [ @@ -98319,7 +113646,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Recipient name.", @@ -98347,7 +113682,12 @@ "name" ], "title": "recipient_shipping_with_optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] }, { "enum": [ @@ -98380,7 +113720,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, { "enum": [ @@ -98392,7 +113736,13 @@ "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. This will be unset if you POST an empty value." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "auto_advance", + "collection_method", + "description", + "metadata" + ] } } }, @@ -98422,6 +113772,449 @@ } } }, + "/v1/invoices/{invoice}/add_lines": { + "post": { + "description": "Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
", + "operationId": "PostInvoicesInvoiceAddLines", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to add.", + "items": { + "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" + }, + "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" + }, + "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.", + "type": "boolean" + }, + "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" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "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" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "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.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] + }, + "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. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "properties": { + "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" + }, + "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" + }, + "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" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] + }, + "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 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" + }, + "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" + ], + "title": "one_time_price_data_with_product_data", + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", + "properties": { + "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" + }, + "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" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 200, + "type": "string" + }, + "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.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object", + "x-stripeMostCommon": [ + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "percentage", + "state", + "tax_type" + ] + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate_data", + "taxable_amount" + ] + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "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 invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "title": "lines_data_param", + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "invoice_item", + "metadata", + "period", + "price", + "quantity" + ] + }, + "type": "array" + } + }, + "required": [ + "lines" + ], + "type": "object", + "x-stripeMostCommon": [ + "invoice_metadata", + "lines" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/invoices/{invoice}/finalize": { "post": { "description": "Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.
", @@ -98463,7 +114256,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "auto_advance" + ] } } }, @@ -98610,6 +114406,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -98728,7 +114530,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -98764,7 +114569,7 @@ "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=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` 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." }, "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.", @@ -98785,7 +114590,11 @@ "start" ], "title": "period", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", @@ -98841,7 +114650,14 @@ "name" ], "title": "product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] }, "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.", @@ -98866,7 +114682,12 @@ "currency" ], "title": "one_time_price_data_with_product_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Non-negative integer. The quantity of units for the line item.", @@ -98905,7 +114726,7 @@ }, "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, + "maxLength": 200, "type": "string" }, "percentage": { @@ -98943,7 +114764,17 @@ "percentage" ], "title": "tax_rate_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "percentage", + "state", + "tax_type" + ] }, "taxable_amount": { "description": "The amount on which tax is calculated, in cents (or local equivalent).", @@ -98956,7 +114787,12 @@ "taxable_amount" ], "title": "tax_amount_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate_data", + "taxable_amount" + ] }, "type": "array" }, @@ -98988,7 +114824,15 @@ "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "metadata", + "period", + "price", + "quantity" + ] } } }, @@ -99193,10 +115037,207 @@ } } }, - "/v1/invoices/{invoice}/send": { + "/v1/invoices/{invoice}/remove_lines": { + "post": { + "description": "Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
", + "operationId": "PostInvoicesInvoiceRemoveLines", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to remove.", + "items": { + "properties": { + "behavior": { + "description": "Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.", + "enum": [ + "delete", + "unassign" + ], + "type": "string" + }, + "id": { + "description": "ID of an existing line item to remove from this invoice.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "behavior", + "id" + ], + "title": "lines_data_param", + "type": "object", + "x-stripeMostCommon": [ + "behavior", + "id" + ] + }, + "type": "array" + } + }, + "required": [ + "lines" + ], + "type": "object", + "x-stripeMostCommon": [ + "invoice_metadata", + "lines" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoices/{invoice}/send": { + "post": { + "description": "Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
\n\nRequests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
\n\nRequests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
", + "operationId": "PostInvoicesInvoiceUpdateLines", "parameters": [ { "in": "path", @@ -99216,6 +115257,14 @@ "expand": { "explode": true, "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -99228,13 +115277,384 @@ "type": "string" }, "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. 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." + }, + "lines": { + "description": "The line items to update.", + "items": { + "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" + }, + "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" + }, + "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.", + "type": "boolean" + }, + "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" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "id": { + "description": "ID of an existing line item on the invoice.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. 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." + }, + "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.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object", + "x-stripeMostCommon": [ + "end", + "start" + ] + }, + "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. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "properties": { + "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" + }, + "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" + }, + "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" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object", + "x-stripeMostCommon": [ + "description", + "images", + "metadata", + "name", + "tax_code" + ] + }, + "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 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" + }, + "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" + ], + "title": "one_time_price_data_with_product_data", + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", + "properties": { + "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" + }, + "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" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 200, + "type": "string" + }, + "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.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object", + "x-stripeMostCommon": [ + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "percentage", + "state", + "tax_type" + ] + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_rate_data", + "taxable_amount" + ] + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "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 invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "required": [ + "id" + ], + "title": "lines_data_param", + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "id", + "metadata", + "period", + "price", + "quantity" + ] + }, + "type": "array" } }, - "type": "object" + "required": [ + "lines" + ], + "type": "object", + "x-stripeMostCommon": [ + "invoice_metadata", + "lines" + ] } } }, - "required": false + "required": true }, "responses": { "200": { @@ -99382,7 +115802,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -99508,6 +115934,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -99651,7 +116083,10 @@ "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -99744,7 +116179,11 @@ "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-stripeMostCommon": [ + "amount", + "metadata" + ] } } }, @@ -99833,7 +116272,10 @@ "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -99896,7 +116338,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -100057,6 +116505,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -100158,14 +116612,25 @@ "postal_code" ], "title": "required_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] } }, "required": [ "address" ], "title": "billing_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address" + ] }, "company": { "description": "Additional information about a `company` cardholder.", @@ -100177,7 +116642,10 @@ } }, "title": "company_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "email": { "description": "The cardholder's email address.", @@ -100226,11 +116694,19 @@ } }, "title": "terms_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "card_issuing_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "user_terms_acceptance" + ] }, "dob": { "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.", @@ -100254,7 +116730,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "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.", @@ -100282,15 +116763,30 @@ } }, "title": "person_verification_document_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "individual_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "dob", + "first_name", + "last_name", + "user_terms_acceptance", + "verification" + ] }, "metadata": { "additionalProperties": { @@ -101281,7 +117777,12 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" }, @@ -101291,7 +117792,17 @@ } }, "title": "authorization_controls_param_v2", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_network_ids", + "spending_limits", + "spending_limits_currency" + ] }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.", @@ -101315,7 +117826,14 @@ "billing", "name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing", + "email", + "metadata", + "name", + "phone_number" + ] } } }, @@ -101507,14 +118025,25 @@ "postal_code" ], "title": "required_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] } }, "required": [ "address" ], "title": "billing_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address" + ] }, "company": { "description": "Additional information about a `company` cardholder.", @@ -101526,7 +118055,10 @@ } }, "title": "company_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "email": { "description": "The cardholder's email address.", @@ -101575,11 +118107,19 @@ } }, "title": "terms_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "card_issuing_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "user_terms_acceptance" + ] }, "dob": { "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.", @@ -101603,7 +118143,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, "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.", @@ -101631,15 +118176,30 @@ } }, "title": "person_verification_document_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "individual_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "dob", + "first_name", + "last_name", + "user_terms_acceptance", + "verification" + ] }, "metadata": { "additionalProperties": { @@ -102626,7 +119186,12 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" }, @@ -102636,7 +119201,17 @@ } }, "title": "authorization_controls_param_v2", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_network_ids", + "spending_limits", + "spending_limits_currency" + ] }, "status": { "description": "Specifies whether to permit authorizations on this cardholder's cards.", @@ -102647,7 +119222,13 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing", + "email", + "metadata", + "phone_number" + ] } } }, @@ -102721,7 +119302,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -102903,6 +119490,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -102998,7 +119591,10 @@ } }, "title": "encrypted_pin_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "encrypted_number" + ] }, "replacement_for": { "description": "The card this is meant to be a replacement for (if any).", @@ -103075,7 +119671,37 @@ "postal_code" ], "title": "required_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] + }, + "address_validation": { + "description": "Address validation settings.", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + } + }, + "required": [ + "mode" + ], + "title": "address_validation_param", + "type": "object", + "x-stripeMostCommon": [ + "mode" + ] }, "customs": { "description": "Customs information for the shipment.", @@ -103087,7 +119713,10 @@ } }, "title": "customs_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eori_number" + ] }, "name": { "description": "The name printed on the shipping label when shipping the card.", @@ -103126,7 +119755,18 @@ "name" ], "title": "shipping_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_validation", + "customs", + "name", + "phone_number", + "require_signature", + "service", + "speed", + "type" + ] }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", @@ -104088,13 +120728,30 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" } }, "title": "authorization_controls_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_currencies", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_currencies", + "blocked_merchant_network_ids", + "max_approvals", + "spending_limits" + ] }, "status": { "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.", @@ -104117,7 +120774,14 @@ "currency", "type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cardholder", + "currency", + "metadata", + "status", + "type" + ] } } }, @@ -104245,6 +120909,10 @@ "explode": true, "style": "deepObject" }, + "shipping": { + "explode": true, + "style": "deepObject" + }, "spending_controls": { "explode": true, "style": "deepObject" @@ -104301,7 +120969,151 @@ } }, "title": "encrypted_pin_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "encrypted_number" + ] + }, + "shipping": { + "description": "Updated shipping information for the card.", + "properties": { + "address": { + "description": "The address that the card is shipped to.", + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "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" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "city", + "country", + "line1", + "postal_code" + ], + "title": "required_address", + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] + }, + "address_validation": { + "description": "Address validation settings.", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + } + }, + "required": [ + "mode" + ], + "title": "address_validation_param", + "type": "object", + "x-stripeMostCommon": [ + "mode" + ] + }, + "customs": { + "description": "Customs information for the shipment.", + "properties": { + "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" + } + }, + "title": "customs_param", + "type": "object", + "x-stripeMostCommon": [ + "eori_number" + ] + }, + "name": { + "description": "The name printed on the shipping label when shipping the card.", + "maxLength": 5000, + "type": "string" + }, + "phone_number": { + "description": "Phone number of the recipient of the shipment.", + "type": "string" + }, + "require_signature": { + "description": "Whether a signature is required for card delivery.", + "type": "boolean" + }, + "service": { + "description": "Shipment service.", + "enum": [ + "express", + "priority", + "standard" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "type": { + "description": "Packaging options.", + "enum": [ + "bulk", + "individual" + ], + "type": "string" + } + }, + "required": [ + "address", + "name" + ], + "title": "shipping_specs", + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_validation", + "customs", + "name", + "phone_number", + "require_signature", + "service", + "speed", + "type" + ] }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", @@ -105263,13 +122075,30 @@ "interval" ], "title": "spending_limits_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "categories", + "interval" + ] }, "type": "array" } }, "title": "authorization_controls_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allowed_categories", + "allowed_merchant_countries", + "allowed_merchant_currencies", + "allowed_merchant_network_ids", + "blocked_categories", + "blocked_merchant_countries", + "blocked_merchant_currencies", + "blocked_merchant_network_ids", + "max_approvals", + "spending_limits" + ] }, "status": { "description": "Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.", @@ -105282,7 +122111,12 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason", + "metadata", + "status" + ] } } }, @@ -105345,7 +122179,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -105484,6 +122324,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -105586,7 +122432,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105616,7 +122462,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105631,7 +122477,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105678,7 +122524,19 @@ } }, "title": "canceled", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_policy_provided", + "cancellation_reason", + "expected_at", + "explanation", + "product_description", + "product_type", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -105752,7 +122610,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105771,7 +122629,15 @@ } }, "title": "duplicate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "card_statement", + "cash_receipt", + "check_image", + "explanation", + "original_transaction" + ] }, { "enum": [ @@ -105803,7 +122669,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105817,7 +122683,11 @@ } }, "title": "fraudulent", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -105849,7 +122719,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105879,7 +122749,7 @@ "return_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105917,7 +122787,15 @@ } }, "title": "merchandise_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "received_at", + "return_description", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -105949,7 +122827,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105963,7 +122841,11 @@ } }, "title": "no_valid_authorization", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -106010,7 +122892,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106025,7 +122907,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106048,7 +122930,14 @@ } }, "title": "not_received", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "expected_at", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -106080,7 +122969,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106095,7 +122984,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106118,7 +123007,13 @@ } }, "title": "other", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -106180,7 +123075,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106195,7 +123090,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106224,7 +123119,14 @@ } }, "title": "service_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_reason", + "explanation", + "received_at" + ] }, { "enum": [ @@ -106237,7 +123139,18 @@ } }, "title": "evidence_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "no_valid_authorization", + "not_received", + "other", + "reason", + "service_not_as_described" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -106272,10 +123185,18 @@ "received_debit" ], "title": "treasury_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "received_debit" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "evidence", + "metadata", + "transaction" + ] } } }, @@ -106464,7 +123385,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106494,7 +123415,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106509,7 +123430,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106556,7 +123477,19 @@ } }, "title": "canceled", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_policy_provided", + "cancellation_reason", + "expected_at", + "explanation", + "product_description", + "product_type", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -106630,7 +123563,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106649,7 +123582,15 @@ } }, "title": "duplicate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "card_statement", + "cash_receipt", + "check_image", + "explanation", + "original_transaction" + ] }, { "enum": [ @@ -106681,7 +123622,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106695,7 +123636,11 @@ } }, "title": "fraudulent", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -106727,7 +123672,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106757,7 +123702,7 @@ "return_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106795,7 +123740,15 @@ } }, "title": "merchandise_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "received_at", + "return_description", + "return_status", + "returned_at" + ] }, { "enum": [ @@ -106827,7 +123780,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106841,7 +123794,11 @@ } }, "title": "no_valid_authorization", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation" + ] }, { "enum": [ @@ -106888,7 +123845,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106903,7 +123860,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106926,7 +123883,14 @@ } }, "title": "not_received", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "expected_at", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -106958,7 +123922,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106973,7 +123937,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106996,7 +123960,13 @@ } }, "title": "other", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "explanation", + "product_description", + "product_type" + ] }, { "enum": [ @@ -107058,7 +124028,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -107073,7 +124043,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -107102,7 +124072,14 @@ } }, "title": "service_not_as_described", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_documentation", + "canceled_at", + "cancellation_reason", + "explanation", + "received_at" + ] }, { "enum": [ @@ -107115,7 +124092,18 @@ } }, "title": "evidence_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "canceled", + "duplicate", + "fraudulent", + "merchandise_not_as_described", + "no_valid_authorization", + "not_received", + "other", + "reason", + "service_not_as_described" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -107143,7 +124131,11 @@ "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-stripeMostCommon": [ + "evidence", + "metadata" + ] } } }, @@ -107231,7 +124223,10 @@ "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -107335,7 +124330,11 @@ } }, "title": "preferences_list_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "is_default", + "is_platform_default" + ] }, "style": "deepObject" }, @@ -107421,6 +124420,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -107535,7 +124540,13 @@ } }, "title": "carrier_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "footer_body", + "footer_title", + "header_body", + "header_title" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -107579,7 +124590,10 @@ "is_default" ], "title": "preferences_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "is_default" + ] }, "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.", @@ -107589,7 +124603,17 @@ "required": [ "physical_bundle" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_logo", + "carrier_text", + "lookup_key", + "metadata", + "name", + "physical_bundle", + "preferences", + "transfer_lookup_key" + ] } } }, @@ -107817,7 +124841,13 @@ } }, "title": "carrier_text_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "footer_body", + "footer_title", + "header_body", + "header_title" + ] }, { "enum": [ @@ -107890,14 +124920,27 @@ "is_default" ], "title": "preferences_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "is_default" + ] }, "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": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_logo", + "carrier_text", + "lookup_key", + "metadata", + "name", + "physical_bundle", + "preferences", + "transfer_lookup_key" + ] } } }, @@ -108063,6 +125106,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -108194,7 +125243,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -108320,6 +125375,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -108454,7 +125515,10 @@ "required": [ "status" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "status" + ] } } }, @@ -108539,7 +125603,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -108605,7 +125675,8 @@ "capture", "refund" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "style": "form" } @@ -108664,6 +125735,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -108807,7 +125884,10 @@ "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -108937,7 +126017,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -109059,6 +126145,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -109160,7 +126252,11 @@ "enabled" ], "title": "automatic_payment_methods_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redirects", + "enabled" + ] }, "capture_method": { "description": "Controls when the funds will be captured from the customer's account.", @@ -109193,7 +126289,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 present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.", + "description": "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" }, @@ -109255,7 +126351,11 @@ "user_agent" ], "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", @@ -109271,14 +126371,23 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" + ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ] }, { "enum": [ @@ -109354,7 +126463,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -109408,7 +126522,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -109425,7 +126543,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -109472,7 +126594,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -109529,7 +126659,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -109550,7 +126686,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -109604,7 +126743,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -109653,7 +126795,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -109695,13 +126841,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -109728,11 +126883,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -109809,7 +126972,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -109827,7 +126993,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -109845,7 +127014,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -109866,7 +127039,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -109888,7 +127064,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -109981,7 +127160,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -110000,7 +127186,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this PaymentIntent.", @@ -110050,10 +127241,16 @@ } }, "title": "payment_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110074,7 +127271,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -110103,7 +127305,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -110111,7 +127313,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "purchase_details", + "setup_future_usage" + ] }, { "enum": [ @@ -110140,7 +127348,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -110149,7 +127357,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -110165,7 +127378,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110175,7 +127388,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -110199,7 +127415,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", @@ -110209,7 +127425,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "charge_metadata", + "charge_permission_id", + "setup_future_usage" + ] }, { "enum": [ @@ -110225,7 +127447,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110236,7 +127458,11 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "target_date" + ] }, { "enum": [ @@ -110251,8 +127477,17 @@ "anyOf": [ { "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110262,8 +127497,13 @@ "type": "string" } }, - "title": "payment_method_options_param", - "type": "object" + "title": "payment_intent_payment_method_options_param", + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date" + ] }, { "enum": [ @@ -110289,7 +127529,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110299,7 +127539,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -110320,7 +127564,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" @@ -110330,7 +127574,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code", + "mandate_options", + "setup_future_usage" + ] }, { "enum": [ @@ -110350,7 +127599,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110361,7 +127610,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -110401,11 +127654,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "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" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -110416,16 +127669,20 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -110438,7 +127695,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", @@ -110509,7 +127770,18 @@ "start_date" ], "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "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.", @@ -110523,6 +127795,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -110581,7 +127854,7 @@ "type": "boolean" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110693,11 +127966,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "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.", @@ -110726,11 +128007,56 @@ "version" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_indicator", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "payment_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_partial_amount", + "buy_now_pay_later_options", + "capture_method", + "cvc_token", + "installments", + "mandate_options", + "mcc", + "mit_exemption", + "moto", + "network", + "network_options", + "network_token", + "off_session_usage", + "recipient_details", + "request_decremental_authorization", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_multicapture", + "request_overcapture", + "request_partial_authorization", + "request_three_d_secure", + "require_cvc_recollection", + "sender_details", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji", + "statement_details", + "stored_credential_transaction_type", + "stored_credential_usage", + "three_d_secure", + "transaction_purpose" + ] }, { "enum": [ @@ -110766,11 +128092,24 @@ } }, "title": "routing_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested_priority" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "buy_now_pay_later_options", + "capture_method", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_partial_authorization", + "routing" + ] }, { "enum": [ @@ -110794,7 +128133,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -110805,7 +128144,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "request_incremental_authorization", + "restricted_transaction_categories", + "setup_future_usage" + ] }, { "enum": [ @@ -110836,7 +128181,10 @@ "country" ], "title": "eu_bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -110872,7 +128220,14 @@ "type" ], "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_account", + "id_bank_transfer", + "requested_address_types", + "type" + ] }, "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`.", @@ -110882,7 +128237,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -110890,7 +128245,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" + ] }, { "enum": [ @@ -110906,7 +128266,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -110914,7 +128274,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -110930,7 +128293,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -110938,7 +128301,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -110954,7 +128320,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -110962,7 +128328,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -110978,7 +128347,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -110986,7 +128355,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -111002,7 +128374,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -111012,7 +128384,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -111105,7 +128480,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111114,7 +128489,17 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "interoperability_token", + "line_items", + "partner_confirmation_token", + "payment_details", + "payment_method_category", + "preferred_locale", + "setup_future_usage" + ] }, { "enum": [ @@ -111189,7 +128574,7 @@ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111197,7 +128582,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "confirmation_number", + "expires_after_days", + "expires_at", + "fee_amount", + "product_description", + "setup_future_usage", + "tax_amount" + ] }, { "enum": [ @@ -111226,7 +128620,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -111236,7 +128630,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "persistent_token", + "request_multicapture", + "setup_future_usage" + ] }, { "enum": [ @@ -111260,7 +128660,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111268,7 +128668,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -111284,7 +128689,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111292,7 +128697,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -111312,7 +128720,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111320,7 +128728,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -111336,7 +128748,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111348,7 +128760,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "setup_future_usage", + "tos_shown_and_accepted" + ] }, { "enum": [ @@ -111364,7 +128781,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111372,7 +128789,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -111434,7 +128854,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -111444,7 +128864,18 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_delayed_notification", + "capture_method", + "line_items", + "preferred_locale", + "reference", + "reference_id", + "risk_correlation_id", + "setup_future_usage", + "subsellers" + ] }, { "enum": [ @@ -111469,7 +128900,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111477,7 +128908,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_seconds", + "expires_at", + "setup_future_usage" + ] }, { "enum": [ @@ -111493,7 +128929,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111501,7 +128937,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -111525,7 +128964,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", @@ -111535,7 +128974,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, { "enum": [ @@ -111554,10 +128997,14 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -111568,7 +129015,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date", + "verification_method" + ] }, { "enum": [ @@ -111598,7 +129051,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -111608,7 +129061,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -111639,7 +129096,7 @@ "description": "The order ID displayed in the Swish app after the payment is authorized." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111647,7 +129104,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorization_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -111663,7 +129125,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111671,7 +129133,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -111689,6 +129154,29 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -111724,7 +129212,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -111740,7 +129235,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -111758,7 +129256,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", @@ -111770,7 +129271,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -111791,7 +129292,15 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "preferred_settlement_speed", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -111822,7 +129331,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111833,7 +129342,12 @@ "client" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] }, { "enum": [ @@ -111849,7 +129363,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -111857,7 +129371,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -111870,7 +129387,76 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "alma", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "boleto_pilot", + "card", + "card_present", + "cashapp", + "customer_balance", + "demo_pay", + "dummy_auth_push", + "dummy_passthrough_card", + "eps", + "fpx", + "giropay", + "gopay", + "grabpay", + "id_bank_transfer", + "ideal", + "interac_present", + "kakao_pay", + "klarna", + "knet", + "konbini", + "kr_card", + "kr_market", + "link", + "mb_way", + "mobilepay", + "multibanco", + "naver_pay", + "ng_bank", + "ng_bank_transfer", + "ng_card", + "ng_market", + "ng_ussd", + "nz_bank_account", + "oxxo", + "p24", + "pay_by_bank", + "payco", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "qris", + "rechnung", + "revolut_pay", + "samsung_pay", + "sepa_debit", + "shopeepay", + "sofort", + "swish", + "twint", + "upi", + "us_bank_account", + "vipps", + "wechat_pay", + "zip" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to [\"card\"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", @@ -111890,7 +129476,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "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).", @@ -111901,7 +129491,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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": [ "off_session", "on_session" @@ -111946,7 +129536,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -111974,15 +129572,22 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, "statement_descriptor": { - "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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 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. The concatenated descriptor must contain 1-22 characters.", + "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" }, @@ -112002,7 +129607,11 @@ "destination" ], "title": "transfer_data_creation_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "destination" + ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).", @@ -112017,7 +129626,23 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "automatic_payment_methods", + "confirm", + "currency", + "customer", + "description", + "metadata", + "off_session", + "payment_method", + "receipt_email", + "setup_future_usage", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -112161,6 +129786,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -112349,7 +129982,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 present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.", + "description": "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" }, @@ -112384,7 +130017,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "payment_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.", + "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. To unset this field to null, pass in an empty string.", "maxLength": 5000, "type": "string" }, @@ -112421,7 +130054,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -112475,7 +130113,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -112492,7 +130134,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -112539,7 +130185,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -112596,7 +130250,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -112617,7 +130277,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -112671,7 +130334,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -112720,7 +130386,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -112762,13 +130432,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -112795,11 +130474,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -112876,7 +130563,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -112894,7 +130584,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -112912,7 +130605,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -112933,7 +130630,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -112955,7 +130655,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -113048,7 +130751,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -113067,7 +130777,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment-method-specific configuration for this PaymentIntent.", @@ -113117,10 +130832,16 @@ } }, "title": "payment_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113141,7 +130862,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -113170,7 +130896,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -113178,7 +130904,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "preferred_locale", + "purchase_details", + "setup_future_usage" + ] }, { "enum": [ @@ -113207,7 +130939,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -113216,7 +130948,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -113232,7 +130969,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113242,7 +130979,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -113266,7 +131006,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", @@ -113276,7 +131016,13 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "charge_metadata", + "charge_permission_id", + "setup_future_usage" + ] }, { "enum": [ @@ -113292,7 +131038,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113303,7 +131049,11 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage", + "target_date" + ] }, { "enum": [ @@ -113318,8 +131068,17 @@ "anyOf": [ { "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113329,8 +131088,13 @@ "type": "string" } }, - "title": "payment_method_options_param", - "type": "object" + "title": "payment_intent_payment_method_options_param", + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date" + ] }, { "enum": [ @@ -113356,7 +131120,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113366,7 +131130,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -113387,7 +131155,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" @@ -113397,7 +131165,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code", + "mandate_options", + "setup_future_usage" + ] }, { "enum": [ @@ -113417,7 +131190,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113428,7 +131201,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -113468,11 +131245,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "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" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -113483,16 +131260,20 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "count", + "interval", + "type" + ] }, { "enum": [ @@ -113505,7 +131286,11 @@ } }, "title": "installments_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "plan" + ] }, "mandate_options": { "description": "Configuration options for setting up an eMandate for cards issued in India.", @@ -113576,7 +131361,18 @@ "start_date" ], "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "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.", @@ -113590,6 +131386,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -113648,7 +131445,7 @@ "type": "boolean" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113760,11 +131557,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "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.", @@ -113793,11 +131598,56 @@ "version" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_indicator", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "payment_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_partial_amount", + "buy_now_pay_later_options", + "capture_method", + "cvc_token", + "installments", + "mandate_options", + "mcc", + "mit_exemption", + "moto", + "network", + "network_options", + "network_token", + "off_session_usage", + "recipient_details", + "request_decremental_authorization", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_multicapture", + "request_overcapture", + "request_partial_authorization", + "request_three_d_secure", + "require_cvc_recollection", + "sender_details", + "setup_future_usage", + "statement_descriptor_suffix_kana", + "statement_descriptor_suffix_kanji", + "statement_details", + "stored_credential_transaction_type", + "stored_credential_usage", + "three_d_secure", + "transaction_purpose" + ] }, { "enum": [ @@ -113833,11 +131683,24 @@ } }, "title": "routing_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested_priority" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "buy_now_pay_later_options", + "capture_method", + "request_extended_authorization", + "request_flexible_extended_authorization", + "request_incremental_authorization", + "request_incremental_authorization_support", + "request_partial_authorization", + "routing" + ] }, { "enum": [ @@ -113861,7 +131724,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -113872,7 +131735,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "request_incremental_authorization", + "restricted_transaction_categories", + "setup_future_usage" + ] }, { "enum": [ @@ -113903,7 +131772,10 @@ "country" ], "title": "eu_bank_transfer_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -113939,7 +131811,14 @@ "type" ], "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_account", + "id_bank_transfer", + "requested_address_types", + "type" + ] }, "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`.", @@ -113949,7 +131828,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -113957,7 +131836,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type", + "setup_future_usage" + ] }, { "enum": [ @@ -113973,7 +131857,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -113981,7 +131865,10 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -113997,7 +131884,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114005,7 +131892,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114021,7 +131911,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114029,7 +131919,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114045,7 +131938,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114053,7 +131946,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114069,7 +131965,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -114079,7 +131975,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114172,7 +132071,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114181,7 +132080,17 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "interoperability_token", + "line_items", + "partner_confirmation_token", + "payment_details", + "payment_method_category", + "preferred_locale", + "setup_future_usage" + ] }, { "enum": [ @@ -114256,7 +132165,7 @@ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114264,7 +132173,16 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "confirmation_number", + "expires_after_days", + "expires_at", + "fee_amount", + "product_description", + "setup_future_usage", + "tax_amount" + ] }, { "enum": [ @@ -114293,7 +132211,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -114303,7 +132221,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "persistent_token", + "request_multicapture", + "setup_future_usage" + ] }, { "enum": [ @@ -114327,7 +132251,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114335,7 +132259,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -114351,7 +132280,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114359,7 +132288,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114379,7 +132311,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114387,7 +132319,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_days", + "setup_future_usage" + ] }, { "enum": [ @@ -114403,7 +132339,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114415,7 +132351,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "installments", + "setup_future_usage", + "tos_shown_and_accepted" + ] }, { "enum": [ @@ -114431,7 +132372,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114439,7 +132380,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114501,7 +132445,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -114511,7 +132455,18 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_delayed_notification", + "capture_method", + "line_items", + "preferred_locale", + "reference", + "reference_id", + "risk_correlation_id", + "setup_future_usage", + "subsellers" + ] }, { "enum": [ @@ -114536,7 +132491,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114544,7 +132499,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "expires_after_seconds", + "expires_at", + "setup_future_usage" + ] }, { "enum": [ @@ -114560,7 +132520,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114568,7 +132528,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114592,7 +132555,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "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", @@ -114602,7 +132565,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "capture_method", + "setup_future_usage" + ] }, { "enum": [ @@ -114621,10 +132588,14 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -114635,7 +132606,13 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "setup_future_usage", + "target_date", + "verification_method" + ] }, { "enum": [ @@ -114665,7 +132642,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -114675,7 +132652,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language", + "setup_future_usage" + ] }, { "enum": [ @@ -114706,7 +132687,7 @@ "description": "The order ID displayed in the Swish app after the payment is authorized." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114714,7 +132695,12 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorization_method", + "reference", + "setup_future_usage" + ] }, { "enum": [ @@ -114730,7 +132716,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114738,7 +132724,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114756,6 +132745,29 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -114791,7 +132803,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -114807,7 +132826,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -114825,7 +132847,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "preferred_settlement_speed": { "description": "Preferred transaction settlement speed", @@ -114837,7 +132862,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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", @@ -114858,7 +132883,15 @@ } }, "title": "payment_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "preferred_settlement_speed", + "setup_future_usage", + "verification_method" + ] }, { "enum": [ @@ -114889,7 +132922,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114900,7 +132933,12 @@ "client" ], "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "app_id", + "client", + "setup_future_usage" + ] }, { "enum": [ @@ -114916,7 +132954,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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" ], @@ -114924,7 +132962,10 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "setup_future_usage" + ] }, { "enum": [ @@ -114937,7 +132978,76 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "alma", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "boleto_pilot", + "card", + "card_present", + "cashapp", + "customer_balance", + "demo_pay", + "dummy_auth_push", + "dummy_passthrough_card", + "eps", + "fpx", + "giropay", + "gopay", + "grabpay", + "id_bank_transfer", + "ideal", + "interac_present", + "kakao_pay", + "klarna", + "knet", + "konbini", + "kr_card", + "kr_market", + "link", + "mb_way", + "mobilepay", + "multibanco", + "naver_pay", + "ng_bank", + "ng_bank_transfer", + "ng_card", + "ng_market", + "ng_ussd", + "nz_bank_account", + "oxxo", + "p24", + "pay_by_bank", + "payco", + "paynow", + "paypal", + "payto", + "pix", + "promptpay", + "qris", + "rechnung", + "revolut_pay", + "samsung_pay", + "sepa_debit", + "shopeepay", + "sofort", + "swish", + "twint", + "upi", + "us_bank_account", + "vipps", + "wechat_pay", + "zip" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", @@ -114962,7 +133072,7 @@ "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)." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\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`.", + "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": [ "", "off_session", @@ -115009,7 +133119,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -115037,7 +133155,14 @@ "name" ], "title": "optional_fields_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] }, { "enum": [ @@ -115049,12 +133174,12 @@ "description": "Shipping information for this PaymentIntent." }, "statement_descriptor": { - "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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 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.", + "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" }, @@ -115067,14 +133192,30 @@ } }, "title": "transfer_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount" + ] }, "transfer_group": { "description": "A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "metadata", + "payment_method", + "receipt_email", + "setup_future_usage", + "shipping", + "statement_descriptor", + "statement_descriptor_suffix" + ] } } }, @@ -115149,7 +133290,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] } } }, @@ -115228,7 +133373,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason" + ] } } }, @@ -115332,12 +133480,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": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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 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. The concatenated descriptor must be 1-22 characters long.", + "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" }, @@ -115350,10 +133498,17 @@ } }, "title": "transfer_data_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_to_capture", + "metadata" + ] } } }, @@ -115385,7 +133540,7 @@ }, "/v1/payment_intents/{intent}/confirm": { "post": { - "description": "Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.
Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.\nThere is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.
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": [ { @@ -132334,7 +152558,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -132456,6 +152686,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -132576,7 +152812,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -132709,6 +152951,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -132765,7 +153013,11 @@ "value", "value_list" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "value", + "value_list" + ] } } }, @@ -132969,7 +153221,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -133080,6 +153338,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -133164,7 +153428,13 @@ "alias", "name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "alias", + "item_type", + "metadata", + "name" + ] } } }, @@ -133369,7 +153639,12 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "alias", + "metadata", + "name" + ] } } }, @@ -133401,7 +153676,7 @@ }, "/v1/refunds": { "get": { - "description": "Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.
", + "description": "Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
", "operationId": "GetRefunds", "parameters": [ { @@ -133442,7 +153717,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -133562,6 +153843,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -133676,7 +153963,18 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "charge", + "currency", + "customer", + "instructions_email", + "metadata", + "origin", + "payment_intent", + "reason" + ] } } }, @@ -133828,7 +154126,10 @@ "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -133957,7 +154258,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -134068,6 +154375,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -134798,7 +155111,161 @@ } }, "title": "run_parameter_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "age_bucket", + "all", + "amount", + "amount_filter", + "apple_subscriber", + "application_id", + "authentication_outcome_detailed", + "billing_analytics_metric", + "bucket_size", + "calculation_type", + "capability_type", + "card_bin", + "card_brand", + "card_brands", + "card_country", + "card_fingerprint", + "card_funding", + "card_number", + "card_type", + "card_types", + "cau_correction_factor", + "charge", + "chart_detail_page_id", + "cof", + "columns", + "compare_to_end", + "compare_to_start", + "connect_charge_type", + "connected_account", + "contract", + "conversion_currency", + "countries", + "country", + "currency", + "cursor", + "customer", + "customers", + "dataset_id", + "date_format", + "days_to_use", + "decimal_separator", + "digital_wallet", + "direction", + "download", + "entity_type", + "exchange_rate", + "exchange_rates", + "experiment_id", + "fee_category", + "filter_column", + "filter_columns", + "filter_currency", + "filter_value", + "filter_values", + "filters", + "first_day_of_week_offset", + "gateway_conversation_avs_outcome", + "gateway_conversation_cvc_outcome", + "google_order", + "group_by", + "group_by_key", + "group_id", + "group_type", + "grouped_column", + "grouped_columns", + "grouped_metadata_column", + "include_blocked_payments", + "include_connect_charges", + "interval_end", + "interval_start", + "invoice", + "invoice_line_item", + "ip_address", + "ip_country", + "is_eu_vat_moss", + "is_latam", + "is_link_in_pmm_supported", + "is_top_fraudy_attributes", + "is_unbilled", + "jurisdiction_key", + "limit", + "list_item", + "list_items", + "livemode", + "match_mode", + "match_status", + "max_churn", + "meter_id", + "min_trim_size", + "nci_filter_for", + "nci_mcc", + "numeric_filters", + "offset", + "payment_link_id", + "payment_method_type", + "payment_method_types", + "payment_methods", + "payout", + "payout_date_end", + "payout_date_start", + "payout_status", + "payout_type", + "platform", + "platform_id", + "product", + "product_feature_description", + "radar_bad_outcome_configuration", + "radar_fraud_outcomes", + "radar_good_outcomes", + "rate", + "recognition_end", + "recognition_start", + "recon_party_name", + "recon_space", + "recon_space_type", + "reconciliation_status", + "reference_id", + "reporting_category", + "reporting_string_filters", + "retries_correction_factor", + "rev_rec_month_summary_line_item", + "risk_score", + "rule_action", + "rule_attribute", + "rule_attribute_case_insensitive", + "rule_attribute_name_value", + "rule_id", + "rule_predicate_sql", + "secondary_cursor", + "seconds_since_card_first_seen", + "segment_id", + "sort_order", + "sorted_column", + "states", + "string_filters", + "tax_form_id", + "tax_type", + "taxable", + "timezone", + "total_charges_per_card_number_daily", + "total_fraud_volume", + "total_legitimate_volume", + "tracking_load_type", + "transaction_age_max", + "transaction_age_min", + "transaction_initiators", + "transaction_type", + "unit", + "ur", + "use_dispute_creation_date", + "used_network_tokens", + "view_type" + ] }, "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\"`.", @@ -134808,7 +155275,11 @@ "required": [ "report_type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "parameters", + "report_type" + ] } } }, @@ -134980,6 +155451,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -135099,7 +155576,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -135209,6 +155692,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -135396,7 +155885,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -135518,6 +156013,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -135580,7 +156081,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -135713,6 +156220,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -135802,7 +156315,11 @@ "enabled" ], "title": "automatic_payment_methods_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redirects", + "enabled" + ] }, "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.", @@ -135878,7 +156395,11 @@ "user_agent" ], "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", @@ -135894,14 +156415,23 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" + ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ] }, { "enum": [ @@ -135961,7 +156491,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -136015,7 +156550,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -136032,7 +156571,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -136079,7 +156622,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -136136,7 +156687,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -136157,7 +156714,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -136211,7 +156771,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -136260,7 +156823,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -136302,13 +156869,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -136335,11 +156911,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -136416,7 +157000,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -136434,7 +157021,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -136452,7 +157042,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -136473,7 +157067,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -136495,7 +157092,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -136588,7 +157188,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -136607,7 +157214,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", @@ -136675,7 +157287,14 @@ } }, "title": "setup_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -136689,13 +157308,40 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "verification_method" + ] }, "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-stripeMostCommon": [ + "charge_permission_id" + ] + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", + "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] + } + }, + "title": "setup_intent_payment_method_options_param", + "type": "object", + "x-stripeMostCommon": [ + "mandate_options" + ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", @@ -136774,7 +157420,19 @@ "start_date" ], "title": "setup_intent_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "currency", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "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.", @@ -136788,6 +157446,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -136874,11 +157533,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "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.", @@ -136902,11 +157569,32 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_preferred", + "gateway", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "setup_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "moto", + "network", + "network_token", + "request_name_verification", + "request_three_d_secure", + "three_d_secure", + "verify_card_account" + ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", @@ -136924,7 +157612,10 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "persistent_token" + ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", @@ -136936,7 +157627,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_agreement_id", + "currency", + "subsellers" + ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", @@ -136945,11 +157641,19 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, "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.", @@ -136957,6 +157661,29 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -136992,7 +157719,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -137008,7 +157742,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -137026,7 +157763,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -137040,11 +157780,35 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "verification_method" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "alipay", + "amazon_pay", + "bacs_debit", + "blik", + "card", + "card_present", + "demo_pay", + "dummy_auth_push", + "klarna", + "link", + "paypal", + "payto", + "sepa_debit", + "upi", + "us_bank_account" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to [\"card\"].", @@ -137075,7 +157839,11 @@ "currency" ], "title": "setup_intent_single_use_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] }, "usage": { "description": "Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.", @@ -137090,7 +157858,16 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "automatic_payment_methods", + "confirm", + "customer", + "description", + "metadata", + "payment_method", + "usage" + ] } } }, @@ -137296,7 +158073,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "payment_method": { - "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.", + "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" }, @@ -137333,7 +158110,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -137387,7 +158169,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -137404,7 +158190,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -137451,7 +158241,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -137508,7 +158306,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -137529,7 +158333,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -137583,7 +158390,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -137632,7 +158442,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -137674,13 +158488,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -137707,11 +158530,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -137788,7 +158619,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -137806,7 +158640,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -137824,7 +158661,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -137845,7 +158686,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -137867,7 +158711,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -137960,7 +158807,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -137979,7 +158833,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", @@ -138047,7 +158906,14 @@ } }, "title": "setup_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -138061,13 +158927,40 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "verification_method" + ] }, "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-stripeMostCommon": [ + "charge_permission_id" + ] + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", + "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] + } + }, + "title": "setup_intent_payment_method_options_param", + "type": "object", + "x-stripeMostCommon": [ + "mandate_options" + ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", @@ -138146,7 +159039,19 @@ "start_date" ], "title": "setup_intent_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "currency", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "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.", @@ -138160,6 +159065,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -138246,11 +159152,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "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.", @@ -138274,11 +159188,32 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_preferred", + "gateway", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "setup_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "moto", + "network", + "network_token", + "request_name_verification", + "request_three_d_secure", + "three_d_secure", + "verify_card_account" + ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", @@ -138296,7 +159231,10 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "persistent_token" + ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", @@ -138308,7 +159246,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_agreement_id", + "currency", + "subsellers" + ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", @@ -138317,11 +159260,19 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, "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.", @@ -138329,6 +159280,29 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -138364,7 +159338,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -138380,7 +159361,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -138398,7 +159382,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -138412,11 +159399,35 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "verification_method" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "alipay", + "amazon_pay", + "bacs_debit", + "blik", + "card", + "card_present", + "demo_pay", + "dummy_auth_push", + "klarna", + "link", + "paypal", + "payto", + "sepa_debit", + "upi", + "us_bank_account" + ] }, "payment_method_types": { "description": "The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to [\"card\"].", @@ -138427,7 +159438,13 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "description", + "metadata", + "payment_method" + ] } } }, @@ -138504,7 +159521,10 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancellation_reason" + ] } } }, @@ -138623,7 +159643,11 @@ "user_agent" ], "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.", @@ -138639,14 +159663,23 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "accepted_at", + "offline", + "online", + "type" + ] } }, "required": [ "customer_acceptance" ], "title": "secret_key_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ] }, { "enum": [ @@ -138674,7 +159707,11 @@ } }, "title": "online_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "user_agent" + ] }, "type": { "description": "The type of customer acceptance information included with the Mandate.", @@ -138690,7 +159727,11 @@ "type" ], "title": "customer_acceptance_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "online", + "type" + ] } }, "required": [ @@ -138698,6 +159739,9 @@ ], "title": "client_key_param", "type": "object", + "x-stripeMostCommon": [ + "customer_acceptance" + ], "x-stripeParam": { "class_name": "MandateDataPublishableKey" } @@ -138737,7 +159781,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -138791,7 +159840,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -138808,7 +159861,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -138855,7 +159912,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -138912,7 +159977,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -138933,7 +160004,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -138987,7 +160061,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -139036,7 +160113,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -139078,13 +160159,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -139111,11 +160201,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -139192,7 +160290,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -139210,7 +160311,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -139228,7 +160332,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -139249,7 +160357,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -139271,7 +160382,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -139364,7 +160478,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -139383,7 +160504,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "payment_method_options": { "description": "Payment method-specific configuration for this SetupIntent.", @@ -139451,7 +160577,14 @@ } }, "title": "setup_intent_payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "custom_mandate_url", + "default_for", + "interval_description", + "payment_schedule", + "transaction_type" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -139465,13 +160598,40 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "mandate_options", + "verification_method" + ] }, "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-stripeMostCommon": [ + "charge_permission_id" + ] + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", + "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object", + "x-stripeMostCommon": [ + "reference_prefix" + ] + } + }, + "title": "setup_intent_payment_method_options_param", + "type": "object", + "x-stripeMostCommon": [ + "mandate_options" + ] }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", @@ -139550,7 +160710,19 @@ "start_date" ], "title": "setup_intent_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "currency", + "description", + "end_date", + "interval", + "interval_count", + "reference", + "start_date", + "supported_types" + ] }, "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.", @@ -139564,6 +160736,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -139650,11 +160823,19 @@ "cb_avalgo" ], "title": "cartes_bancaires_network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cb_avalgo", + "cb_exemption", + "cb_score" + ] } }, "title": "network_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cartes_bancaires" + ] }, "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.", @@ -139678,11 +160859,32 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ares_trans_status", + "cryptogram", + "electronic_commerce_indicator", + "exemption_preferred", + "gateway", + "network_options", + "requestor_challenge_indicator", + "transaction_id", + "version" + ] } }, "title": "setup_intent_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "moto", + "network", + "network_token", + "request_name_verification", + "request_three_d_secure", + "three_d_secure", + "verify_card_account" + ] }, "card_present": { "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", @@ -139700,7 +160902,10 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "persistent_token" + ] }, "paypal": { "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.", @@ -139712,7 +160917,12 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_agreement_id", + "currency", + "subsellers" + ] }, "sepa_debit": { "description": "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.", @@ -139721,11 +160931,19 @@ "description": "Additional fields for Mandate creation", "properties": {}, "title": "payment_method_options_mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reference", + "reference_prefix" + ] } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, "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.", @@ -139733,6 +160951,29 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -139768,7 +161009,14 @@ } }, "title": "linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "manual_entry", + "permissions", + "prefetch", + "return_url" + ] }, "mandate_options": { "description": "Additional fields for Mandate creation", @@ -139784,7 +161032,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "collection_method" + ] }, "networks": { "description": "Additional fields for network related functions", @@ -139802,7 +161053,10 @@ } }, "title": "networks_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "verification_method": { "description": "Bank account verification method.", @@ -139816,11 +161070,35 @@ } }, "title": "setup_intent_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "mandate_options", + "networks", + "verification_method" + ] } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "alipay", + "amazon_pay", + "bacs_debit", + "blik", + "card", + "card_present", + "demo_pay", + "dummy_auth_push", + "klarna", + "link", + "paypal", + "payto", + "sepa_debit", + "upi", + "us_bank_account" + ] }, "return_url": { "description": "The URL to redirect your customer back to after they authenticate on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.", @@ -139831,7 +161109,10 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method" + ] } } }, @@ -139914,7 +161195,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amounts", + "descriptor_code" + ] } } }, @@ -139987,7 +161272,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -140108,6 +161399,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -140180,7 +161477,11 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] }, "minimum": { "description": "The lower bound of the estimated range. If empty, represents no lower bound.", @@ -140206,11 +161507,19 @@ "value" ], "title": "delivery_estimate_bound", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "unit", + "value" + ] } }, "title": "delivery_estimate", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "maximum", + "minimum" + ] }, "display_name": { "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -140257,7 +161566,11 @@ "amount" ], "title": "currency_option", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "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" @@ -140268,7 +161581,12 @@ "currency" ], "title": "fixed_amount", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "currency_options" + ] }, "metadata": { "additionalProperties": { @@ -140301,7 +161619,13 @@ "required": [ "display_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "display_name", + "fixed_amount", + "metadata", + "type" + ] } } }, @@ -140466,14 +161790,21 @@ } }, "title": "currency_option_update", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "tax_behavior" + ] }, "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" } }, "title": "fixed_amount_update", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency_options" + ] }, "metadata": { "anyOf": [ @@ -140502,7 +161833,12 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "fixed_amount", + "metadata" + ] } } }, @@ -140639,6 +161975,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -140825,7 +162167,10 @@ "contact_email" ], "title": "mandate_offline_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "contact_email" + ] }, "online": { "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", @@ -140846,7 +162191,12 @@ } }, "title": "mandate_online_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "status": { "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", @@ -140878,7 +162228,16 @@ "status" ], "title": "mandate_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "offline", + "online", + "status", + "type", + "user_agent" + ] }, "amount": { "anyOf": [ @@ -140922,7 +162281,14 @@ } }, "title": "mandate_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acceptance", + "amount", + "currency", + "interval", + "notification_method" + ] }, "metadata": { "additionalProperties": { @@ -140973,7 +162339,15 @@ } }, "title": "source_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "email": { "description": "Owner's email address.", @@ -140991,7 +162365,13 @@ } }, "title": "owner", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "receiver": { "description": "Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).", @@ -141008,7 +162388,10 @@ } }, "title": "receiver_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "refund_attributes_method" + ] }, "redirect": { "description": "Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).", @@ -141022,7 +162405,10 @@ "return_url" ], "title": "redirect_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "return_url" + ] }, "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.", @@ -141062,7 +162448,15 @@ } }, "title": "order_item_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "parent", + "quantity", + "type" + ] }, "type": "array" }, @@ -141107,7 +162501,15 @@ "line1" ], "title": "address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -141134,11 +162536,22 @@ "address" ], "title": "order_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] } }, "title": "shallow_order_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "items", + "shipping" + ] }, "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.", @@ -141164,7 +162577,18 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "metadata", + "original_source", + "owner", + "redirect", + "statement_descriptor", + "type" + ] } } }, @@ -141354,7 +162778,10 @@ "contact_email" ], "title": "mandate_offline_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "contact_email" + ] }, "online": { "description": "The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`", @@ -141375,7 +162802,12 @@ } }, "title": "mandate_online_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "status": { "description": "The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).", @@ -141407,7 +162839,16 @@ "status" ], "title": "mandate_acceptance_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "offline", + "online", + "status", + "type", + "user_agent" + ] }, "amount": { "anyOf": [ @@ -141451,7 +162892,14 @@ } }, "title": "mandate_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acceptance", + "amount", + "currency", + "interval", + "notification_method" + ] }, "metadata": { "anyOf": [ @@ -141508,7 +162956,15 @@ } }, "title": "source_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "email": { "description": "Owner's email address.", @@ -141526,7 +162982,13 @@ } }, "title": "owner", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "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.", @@ -141566,7 +163028,15 @@ } }, "title": "order_item_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "parent", + "quantity", + "type" + ] }, "type": "array" }, @@ -141611,7 +163081,15 @@ "line1" ], "title": "address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "carrier": { "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", @@ -141638,14 +163116,30 @@ "address" ], "title": "order_shipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "carrier", + "name", + "phone", + "tracking_number" + ] } }, "title": "order_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "items", + "shipping" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "metadata", + "owner" + ] } } }, @@ -141791,6 +163285,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -141862,7 +163362,10 @@ "required": [ "values" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "values" + ] } } }, @@ -142008,6 +163511,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -142074,7 +163583,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -142107,7 +163619,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -142189,7 +163704,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -142216,7 +163734,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "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`.", @@ -142263,7 +163787,15 @@ "required": [ "subscription" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "payment_behavior", + "price", + "proration_behavior", + "quantity", + "subscription" + ] } } }, @@ -142335,7 +163867,10 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "proration_behavior" + ] } } }, @@ -142490,7 +164025,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -142523,7 +164061,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -142562,7 +164103,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "off_session": { - "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", + "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "payment_behavior": { @@ -142619,7 +164160,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -142646,7 +164190,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "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`.", @@ -142685,7 +164235,14 @@ "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." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "payment_behavior", + "price", + "proration_behavior", + "quantity" + ] } } }, @@ -142830,6 +164387,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -142920,7 +164483,12 @@ "required": [ "quantity" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "action", + "quantity", + "timestamp" + ] } } }, @@ -142983,7 +164551,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -143020,7 +164594,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -143057,7 +164637,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -143141,7 +164727,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -143226,6 +164818,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -143314,14 +164912,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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).", @@ -143345,7 +164951,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -143429,11 +165039,26 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "subscription_schedule_default_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "on_behalf_of": { "anyOf": [ @@ -143466,7 +165091,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, { "enum": [ @@ -143479,7 +165108,19 @@ } }, "title": "default_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "default_payment_method", + "description", + "invoice_settings", + "on_behalf_of", + "transfer_data" + ] }, "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.", @@ -143550,7 +165191,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -143581,7 +165225,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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" }, "unit_amount_decimal": { @@ -143595,7 +165239,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -143622,6 +165271,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -143659,14 +165312,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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).", @@ -143690,7 +165351,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -143778,7 +165443,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -143841,11 +165509,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -143864,7 +165546,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -143897,7 +165582,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -143961,7 +165649,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -143988,7 +165679,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -144014,7 +165711,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -144058,7 +165765,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -144074,7 +165785,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "cancel_at_period_end", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -144095,7 +165835,13 @@ "description": "When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "customer", + "metadata", + "phases", + "start_date" + ] } } }, @@ -144265,14 +166011,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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).", @@ -144296,7 +166050,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -144380,11 +166138,26 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "subscription_schedule_default_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "on_behalf_of": { "anyOf": [ @@ -144417,7 +166190,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, { "enum": [ @@ -144430,7 +166207,19 @@ } }, "title": "default_settings_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "default_payment_method", + "description", + "invoice_settings", + "on_behalf_of", + "transfer_data" + ] }, "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.", @@ -144496,7 +166285,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -144527,7 +166319,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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" }, "unit_amount_decimal": { @@ -144541,7 +166333,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -144568,6 +166365,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -144605,14 +166406,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "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).", @@ -144636,7 +166445,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -144724,7 +166537,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -144798,11 +166614,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "days_until_due", + "description", + "footer", + "issuer", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", @@ -144821,7 +166651,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -144854,7 +166687,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -144918,7 +166754,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -144945,7 +166784,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", @@ -144971,7 +166816,17 @@ } }, "title": "configuration_item_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -145031,7 +166886,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial": { "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", @@ -145058,7 +166917,36 @@ "items" ], "title": "phase_configuration_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "add_invoice_items", + "application_fee_percent", + "automatic_tax", + "billing_cycle_anchor", + "billing_thresholds", + "collection_method", + "coupon", + "currency", + "default_payment_method", + "default_tax_rates", + "description", + "discounts", + "end_date", + "invoice_settings", + "items", + "iterations", + "metadata", + "on_behalf_of", + "pause_collection", + "proration_behavior", + "start_date", + "tax_filing_currency", + "transfer_data", + "trial", + "trial_continuation", + "trial_end", + "trial_settings" + ] }, "type": "array" }, @@ -145072,7 +166960,12 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "phases", + "proration_behavior" + ] } } }, @@ -145147,7 +167040,10 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "invoice_now" + ] } } }, @@ -145270,7 +167166,10 @@ "enabled" ], "title": "automatic_tax_filter_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, "style": "deepObject" }, @@ -145316,7 +167215,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -145326,6 +167231,7 @@ "style": "deepObject" }, { + "description": "Only return subscriptions whose current_period_end falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_end", @@ -145352,7 +167258,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -145362,6 +167274,7 @@ "style": "deepObject" }, { + "description": "Only return subscriptions whose current_period_start falls within the given date interval.", "explode": true, "in": "query", "name": "current_period_start", @@ -145388,7 +167301,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -145565,6 +167484,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -145687,7 +167612,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -145718,7 +167646,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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" }, "unit_amount_decimal": { @@ -145732,7 +167660,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -145759,6 +167692,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -145806,14 +167743,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "backdate_start_date": { "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.", @@ -145854,7 +167799,14 @@ "day_of_month" ], "title": "billing_cycle_anchor_config_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day_of_month", + "hour", + "minute", + "month", + "second" + ] }, "billing_thresholds": { "anyOf": [ @@ -145870,7 +167822,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -145887,7 +167843,7 @@ "type": "integer" }, "cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "collection_method": { @@ -145971,7 +167927,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -146033,11 +167992,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", @@ -146056,7 +168029,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -146089,7 +168065,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -146153,7 +168132,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -146180,7 +168162,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -146206,7 +168194,17 @@ } }, "title": "subscription_item_create_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "discounts", + "metadata", + "plan", + "price", + "quantity", + "tax_rates", + "trial" + ] }, "type": "array" }, @@ -146228,7 +168226,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "off_session": { - "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", + "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { @@ -146278,7 +168276,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -146292,7 +168293,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -146319,7 +168324,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -146356,7 +168364,12 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description" + ] }, "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.", @@ -146366,6 +168379,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -146388,7 +168402,13 @@ } }, "title": "subscription_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "mit_exemption", + "network", + "request_three_d_secure" + ] }, { "enum": [ @@ -146419,7 +168439,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -146427,7 +168450,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "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`.", @@ -146435,7 +168463,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -146467,7 +168499,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -146485,6 +168520,28 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -146515,7 +168572,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -146529,7 +168591,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -146542,7 +168608,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -146567,6 +168643,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -146594,7 +168671,7 @@ "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)." }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" @@ -146603,7 +168680,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_options", + "payment_method_types", + "save_default_payment_method" + ] }, "pending_invoice_item_interval": { "anyOf": [ @@ -146628,7 +168710,11 @@ "interval" ], "title": "pending_invoice_item_interval_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval", + "interval_count" + ] }, { "enum": [ @@ -146640,7 +168726,7 @@ "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "promotion_code": { - "description": "The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -146669,7 +168755,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, "trial_end": { "anyOf": [ @@ -146715,20 +168805,36 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] } }, "required": [ "customer" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancel_at_period_end", + "currency", + "customer", + "default_payment_method", + "description", + "items", + "metadata", + "payment_behavior" + ] } } }, @@ -146872,6 +168978,14 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "next_page", + "object", + "total_count", + "url" ] } } @@ -146893,7 +169007,7 @@ }, "/v1/subscriptions/{subscription_exposed_id}": { "delete": { - "description": "Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.
\n\nNote, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
\n\nBy default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
", + "description": "Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, you can no longer update the subscription or its metadata.
\n\nAny pending invoice items that you’ve created are still charged at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed.
\n\nBy default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
", "operationId": "DeleteSubscriptionsSubscriptionExposedId", "parameters": [ { @@ -146958,7 +169072,12 @@ } }, "title": "cancellation_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "comment", + "feedback", + "feedback_option" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -147073,7 +169192,7 @@ } }, "post": { - "description": "Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.
\n\nBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a
Switching prices does not normally change the billing date or generate an immediate charge unless:
\n\nIn these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.
\n\nIf you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.
If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.
", + "description": "Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the create preview endpoint.
\n\nBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a
Switching prices does not normally change the billing date or generate an immediate charge unless:
\n\nIn these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.
\n\nIf you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.
If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.
", "operationId": "PostSubscriptionsSubscriptionExposedId", "parameters": [ { @@ -147204,7 +169323,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -147235,7 +169357,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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" }, "unit_amount_decimal": { @@ -147249,7 +169371,12 @@ "product" ], "title": "one_time_price_data_with_negative_amounts", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item. Defaults to 1.", @@ -147276,6 +169403,10 @@ }, "title": "add_invoice_item_entry", "type": "object", + "x-stripeMostCommon": [ + "price", + "quantity" + ], "x-stripeParam": { "class_name": "AddInvoiceItem" } @@ -147323,14 +169454,22 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "required": [ "enabled" ], "title": "automatic_tax_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled", + "liability" + ] }, "billing_cycle_anchor": { "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", @@ -147356,7 +169495,11 @@ } }, "title": "billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_gte", + "reset_billing_cycle_anchor" + ] }, { "enum": [ @@ -147383,7 +169526,7 @@ "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancellation_details": { @@ -147421,7 +169564,12 @@ } }, "title": "cancellation_details_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "comment", + "feedback", + "feedback_option" + ] }, "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`.", @@ -147515,7 +169663,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -147577,11 +169728,25 @@ "type" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "type" + ] } }, "title": "invoice_settings_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_tax_ids", + "custom_fields", + "description", + "footer", + "issuer", + "rendering", + "send_hosted_payment_email", + "supported_payment_methods" + ] }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", @@ -147600,7 +169765,10 @@ "usage_gte" ], "title": "item_billing_thresholds_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "usage_gte" + ] }, { "enum": [ @@ -147641,7 +169809,10 @@ } }, "title": "discounts_data_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "coupon" + ] }, "type": "array" }, @@ -147720,7 +169891,10 @@ "interval" ], "title": "recurring_adhoc", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval" + ] }, "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.", @@ -147747,7 +169921,13 @@ "recurring" ], "title": "recurring_price_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "product", + "recurring", + "unit_amount" + ] }, "quantity": { "description": "Quantity for this item.", @@ -147773,7 +169953,19 @@ } }, "title": "subscription_item_update_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_thresholds", + "clear_usage", + "deleted", + "discounts", + "id", + "metadata", + "plan", + "price", + "quantity", + "tax_rates" + ] }, "type": "array" }, @@ -147795,7 +169987,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "off_session": { - "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", + "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { @@ -147835,7 +170027,11 @@ "behavior" ], "title": "pause_collection_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "behavior", + "resumes_at" + ] }, { "enum": [ @@ -147879,7 +170075,10 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "transaction_type" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -147893,7 +170092,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "verification_method" + ] }, { "enum": [ @@ -147920,7 +170123,10 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred_language" + ] }, { "enum": [ @@ -147957,7 +170163,12 @@ } }, "title": "mandate_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_type", + "description" + ] }, "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.", @@ -147967,6 +170178,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -147989,7 +170201,13 @@ } }, "title": "subscription_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "mandate_options", + "mit_exemption", + "network", + "request_three_d_secure" + ] }, { "enum": [ @@ -148020,7 +170238,10 @@ "country" ], "title": "eu_bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "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`.", @@ -148028,7 +170249,12 @@ } }, "title": "bank_transfer_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "eu_bank_transfer", + "id_bank_transfer", + "type" + ] }, "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`.", @@ -148036,7 +170262,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank_transfer", + "funding_type" + ] }, { "enum": [ @@ -148068,7 +170298,10 @@ { "properties": {}, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "verification_method" + ] }, { "enum": [ @@ -148086,6 +170319,28 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object", + "x-stripeMostCommon": [ + "account_subcategories", + "institution" + ] + }, "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`.", "items": { @@ -148116,7 +170371,12 @@ } }, "title": "invoice_linked_account_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "filters", + "permissions", + "prefetch" + ] }, "verification_method": { "description": "Verification method for the intent", @@ -148130,7 +170390,11 @@ } }, "title": "invoice_payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "financial_connections", + "verification_method" + ] }, { "enum": [ @@ -148143,7 +170407,17 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acss_debit", + "bancontact", + "card", + "customer_balance", + "id_bank_transfer", + "konbini", + "sepa_debit", + "us_bank_account" + ] }, "payment_method_types": { "anyOf": [ @@ -148168,6 +170442,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -148195,7 +170470,7 @@ "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)." }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" @@ -148204,7 +170479,12 @@ } }, "title": "payment_settings", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method_options", + "payment_method_types", + "save_default_payment_method" + ] }, "pending_invoice_item_interval": { "anyOf": [ @@ -148229,7 +170509,11 @@ "interval" ], "title": "pending_invoice_item_interval_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "interval", + "interval_count" + ] }, { "enum": [ @@ -148241,7 +170525,7 @@ "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "promotion_code": { - "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -148276,7 +170560,11 @@ "destination" ], "title": "transfer_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_percent", + "destination" + ] }, { "enum": [ @@ -148327,17 +170615,32 @@ "missing_payment_method" ], "title": "end_behavior", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "missing_payment_method" + ] } }, "required": [ "end_behavior" ], "title": "trial_settings_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "end_behavior" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cancel_at_period_end", + "default_payment_method", + "description", + "items", + "metadata", + "payment_behavior", + "proration_behavior" + ] } } }, @@ -148480,7 +170783,11 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_cycle_anchor", + "proration_behavior" + ] } } }, @@ -148512,7 +170819,7 @@ }, "/v1/tax/calculations": { "post": { - "description": "Calculates tax based on input and returns a Tax Calculation object.
Calculates tax based on the input and returns a Tax Calculation object.
Retrieves a Tax Calculation object, if the calculation hasn’t expired.
Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.
", @@ -149103,6 +171530,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -149245,6 +171678,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -149325,7 +171764,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "at": { "description": "Options for the registration in AT.", @@ -149346,7 +171788,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149363,7 +171808,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "au": { "description": "Options for the registration in AU.", @@ -149380,7 +171829,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "be": { "description": "Options for the registration in BE.", @@ -149401,7 +171853,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149418,7 +171873,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "bg": { "description": "Options for the registration in BG.", @@ -149439,7 +171898,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149456,7 +171918,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "bh": { "description": "Options for the registration in BH.", @@ -149473,7 +171939,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ca": { "description": "Options for the registration in CA.", @@ -149491,7 +171960,10 @@ "province" ], "title": "province_standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "province" + ] }, "type": { "description": "Type of registration to be created in Canada.", @@ -149507,7 +171979,11 @@ "type" ], "title": "canada", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "province_standard", + "type" + ] }, "ch": { "description": "Options for the registration in CH.", @@ -149524,7 +172000,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "cl": { "description": "Options for the registration in CL.", @@ -149541,7 +172020,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "co": { "description": "Options for the registration in CO.", @@ -149558,7 +172040,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "cy": { "description": "Options for the registration in CY.", @@ -149579,7 +172064,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149596,7 +172084,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "cz": { "description": "Options for the registration in CZ.", @@ -149617,7 +172109,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149634,7 +172129,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "de": { "description": "Options for the registration in DE.", @@ -149655,7 +172154,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149672,7 +172174,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "dk": { "description": "Options for the registration in DK.", @@ -149693,7 +172199,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149710,7 +172219,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "ee": { "description": "Options for the registration in EE.", @@ -149731,7 +172244,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149748,7 +172264,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "eg": { "description": "Options for the registration in EG.", @@ -149765,7 +172285,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "es": { "description": "Options for the registration in ES.", @@ -149786,7 +172309,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149803,7 +172329,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "fi": { "description": "Options for the registration in FI.", @@ -149824,7 +172354,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149841,7 +172374,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "fr": { "description": "Options for the registration in FR.", @@ -149862,7 +172399,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149879,7 +172419,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "gb": { "description": "Options for the registration in GB.", @@ -149896,7 +172440,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ge": { "description": "Options for the registration in GE.", @@ -149913,7 +172460,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "gr": { "description": "Options for the registration in GR.", @@ -149934,7 +172484,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149951,7 +172504,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "hr": { "description": "Options for the registration in HR.", @@ -149972,7 +172529,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -149989,7 +172549,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "hu": { "description": "Options for the registration in HU.", @@ -150010,7 +172574,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150027,7 +172594,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "id": { "description": "Options for the registration in ID.", @@ -150044,7 +172615,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ie": { "description": "Options for the registration in IE.", @@ -150065,7 +172639,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150082,7 +172659,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "is": { "description": "Options for the registration in IS.", @@ -150099,7 +172680,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "it": { "description": "Options for the registration in IT.", @@ -150120,7 +172704,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150137,7 +172724,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "jp": { "description": "Options for the registration in JP.", @@ -150154,7 +172745,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ke": { "description": "Options for the registration in KE.", @@ -150171,7 +172765,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "kr": { "description": "Options for the registration in KR.", @@ -150188,7 +172785,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "kz": { "description": "Options for the registration in KZ.", @@ -150205,7 +172805,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "lt": { "description": "Options for the registration in LT.", @@ -150226,7 +172829,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150243,7 +172849,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "lu": { "description": "Options for the registration in LU.", @@ -150264,7 +172874,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150281,7 +172894,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "lv": { "description": "Options for the registration in LV.", @@ -150302,7 +172919,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150319,7 +172939,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "mt": { "description": "Options for the registration in MT.", @@ -150340,7 +172964,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150357,7 +172984,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "mx": { "description": "Options for the registration in MX.", @@ -150374,7 +173005,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "my": { "description": "Options for the registration in MY.", @@ -150391,7 +173025,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "ng": { "description": "Options for the registration in NG.", @@ -150408,7 +173045,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "nl": { "description": "Options for the registration in NL.", @@ -150429,7 +173069,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150446,7 +173089,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "no": { "description": "Options for the registration in NO.", @@ -150463,7 +173110,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "nz": { "description": "Options for the registration in NZ.", @@ -150480,7 +173130,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "om": { "description": "Options for the registration in OM.", @@ -150497,7 +173150,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "pl": { "description": "Options for the registration in PL.", @@ -150518,7 +173174,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150535,7 +173194,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "pt": { "description": "Options for the registration in PT.", @@ -150556,7 +173219,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150573,7 +173239,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "ro": { "description": "Options for the registration in RO.", @@ -150594,7 +173264,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150611,7 +173284,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "sa": { "description": "Options for the registration in SA.", @@ -150628,7 +173305,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "se": { "description": "Options for the registration in SE.", @@ -150649,7 +173329,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150666,7 +173349,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "sg": { "description": "Options for the registration in SG.", @@ -150683,7 +173370,10 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "si": { "description": "Options for the registration in SI.", @@ -150704,7 +173394,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150721,7 +173414,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "sk": { "description": "Options for the registration in SK.", @@ -150742,7 +173439,10 @@ "place_of_supply_scheme" ], "title": "standard", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "place_of_supply_scheme" + ] }, "type": { "description": "Type of registration to be created in an EU country.", @@ -150759,7 +173459,11 @@ "type" ], "title": "europe", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "standard", + "type" + ] }, "th": { "description": "Options for the registration in TH.", @@ -150776,7 +173480,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "tr": { "description": "Options for the registration in TR.", @@ -150793,7 +173500,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "us": { "description": "Options for the registration in US.", @@ -150811,7 +173521,10 @@ "jurisdiction" ], "title": "local_amusement_tax", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "jurisdiction" + ] }, "local_lease_tax": { "description": "Options for the local lease tax registration.", @@ -150826,13 +173539,60 @@ "jurisdiction" ], "title": "local_lease_tax", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "jurisdiction" + ] }, "state": { "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", "maxLength": 5000, "type": "string" }, + "state_sales_tax": { + "description": "Options for the state sales tax registration.", + "properties": { + "elections": { + "description": "Elections for the state sales tax registration.", + "items": { + "properties": { + "jurisdiction": { + "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `003` (Allegheny County) and `60000` (Philadelphia City).", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "The type of the election for the state sales tax registration.", + "enum": [ + "local_use_tax", + "simplified_sellers_use_tax", + "single_local_use_tax" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "state_sales_tax_election", + "type": "object", + "x-stripeMostCommon": [ + "jurisdiction", + "type" + ] + }, + "type": "array" + } + }, + "required": [ + "elections" + ], + "title": "state_sales_tax", + "type": "object", + "x-stripeMostCommon": [ + "elections" + ] + }, "type": { "description": "Type of registration to be created in the US.", "enum": [ @@ -150850,7 +173610,14 @@ "type" ], "title": "united_states", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "local_amusement_tax", + "local_lease_tax", + "state", + "state_sales_tax", + "type" + ] }, "vn": { "description": "Options for the registration in VN.", @@ -150867,7 +173634,10 @@ "type" ], "title": "simplified", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] }, "za": { "description": "Options for the registration in ZA.", @@ -150884,11 +173654,75 @@ "type" ], "title": "default", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type" + ] } }, "title": "country_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ae", + "at", + "au", + "be", + "bg", + "bh", + "ca", + "ch", + "cl", + "co", + "cy", + "cz", + "de", + "dk", + "ee", + "eg", + "es", + "fi", + "fr", + "gb", + "ge", + "gr", + "hr", + "hu", + "id", + "ie", + "in", + "is", + "it", + "jp", + "ke", + "kr", + "kz", + "lt", + "lu", + "lv", + "mt", + "mx", + "my", + "ng", + "nl", + "no", + "nz", + "om", + "pl", + "pt", + "ro", + "sa", + "se", + "sg", + "si", + "sk", + "th", + "tr", + "tw", + "ua", + "us", + "vn", + "za" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -150909,7 +173743,13 @@ "country", "country_options" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active_from", + "country", + "country_options", + "expires_at" + ] } } }, @@ -151088,7 +173928,11 @@ "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active_from", + "expires_at" + ] } } }, @@ -151216,7 +174060,11 @@ } }, "title": "defaults_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_behavior", + "tax_code" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -151264,17 +174112,32 @@ } }, "title": "validated_country_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] } }, "required": [ "address" ], "title": "head_office_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "defaults", + "head_office" + ] } } }, @@ -151344,6 +174207,11 @@ "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" }, + "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.", + "format": "unix-time", + "type": "integer" + }, "reference": { "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.", "maxLength": 500, @@ -151354,7 +174222,12 @@ "calculation", "reference" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "calculation", + "metadata", + "reference" + ] } } }, @@ -151465,7 +174338,15 @@ "reference" ], "title": "transaction_line_item_reversal", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_tax", + "metadata", + "original_line_item", + "quantity", + "reference" + ] }, "type": "array" }, @@ -151511,7 +174392,11 @@ "amount_tax" ], "title": "transaction_shipping_cost_reversal", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "amount_tax" + ] } }, "required": [ @@ -151519,7 +174404,15 @@ "original_transaction", "reference" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "flat_amount", + "line_items", + "metadata", + "mode", + "original_transaction", + "reference" + ] } } }, @@ -151735,6 +174628,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -151854,240 +174753,257 @@ "object", "url" ], - "title": "TaxProductResourceTaxCodeList", + "title": "TaxProductResourceTaxCodeList", + "type": "object", + "x-expandableFields": [ + "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/tax_codes/{id}": { + "get": { + "description": "Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
", + "operationId": "GetTaxCodesId", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_code" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/tax_ids": { + "get": { + "description": "Returns a list of tax IDs.
", + "operationId": "GetTaxIds", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", + "explode": true, + "in": "query", + "name": "owner", + "required": false, + "schema": { + "properties": { + "account": { + "description": "Account the tax ID belongs to. Required when `type=account`", + "type": "string" + }, + "customer": { + "description": "Customer the tax ID belongs to. Required when `type=customer`", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "Type of owner referenced.", + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "owner_params", + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer", + "type" + ] + }, + "style": "deepObject" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "description": "Details about each object.", + "items": { + "$ref": "#/components/schemas/tax_id" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "TaxIDsList", "type": "object", "x-expandableFields": [ "data" - ] - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/tax_codes/{id}": { - "get": { - "description": "Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
", - "operationId": "GetTaxCodesId", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/tax_code" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/tax_ids": { - "get": { - "description": "Returns a list of tax IDs.
", - "operationId": "GetTaxIds", - "parameters": [ - { - "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "in": "query", - "name": "ending_before", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.", - "explode": true, - "in": "query", - "name": "owner", - "required": false, - "schema": { - "properties": { - "account": { - "description": "Account the tax ID belongs to. Required when `type=account`", - "type": "string" - }, - "customer": { - "description": "Customer the tax ID belongs to. Required when `type=customer`", - "maxLength": 5000, - "type": "string" - }, - "type": { - "description": "Type of owner referenced.", - "enum": [ - "account", - "application", - "customer", - "self" ], - "type": "string" - } - }, - "required": [ - "type" - ], - "title": "owner_params", - "type": "object" - }, - "style": "deepObject" - }, - { - "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "in": "query", - "name": "starting_after", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "", - "properties": { - "data": { - "description": "Details about each object.", - "items": { - "$ref": "#/components/schemas/tax_id" - }, - "type": "array" - }, - "has_more": { - "description": "True if this list has another page of items after this one that can be fetched.", - "type": "boolean" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "enum": [ - "list" - ], - "type": "string" - }, - "url": { - "description": "The URL where this list can be accessed.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ + "x-stripeMostCommon": [ "data", "has_more", "object", "url" - ], - "title": "TaxIDsList", - "type": "object", - "x-expandableFields": [ - "data" ] } } @@ -152160,10 +175076,15 @@ "type" ], "title": "owner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "customer", + "type" + ] }, "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_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", @@ -152181,6 +175102,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -152196,6 +175118,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -152251,7 +175174,11 @@ "type", "value" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "value" + ] } } }, @@ -152443,7 +175370,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -152564,6 +175497,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -152678,7 +175617,18 @@ "inclusive", "percentage" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "country", + "description", + "display_name", + "inclusive", + "jurisdiction", + "metadata", + "percentage", + "state" + ] } } }, @@ -152880,7 +175830,16 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "active", + "country", + "description", + "display_name", + "jurisdiction", + "metadata", + "state" + ] } } }, @@ -153027,6 +175986,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -153064,6 +176029,10 @@ "explode": true, "style": "deepObject" }, + "reboot_window": { + "explode": true, + "style": "deepObject" + }, "stripe_s700": { "explode": true, "style": "deepObject" @@ -153099,7 +176068,10 @@ } }, "title": "bbpos_wise_pose", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -153127,7 +176099,10 @@ "enabled" ], "title": "offline", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, { "enum": [ @@ -153138,6 +176113,30 @@ ], "description": "Configurations for collecting transactions offline." }, + "reboot_window": { + "description": "Reboot time settings for readers that support customized reboot time configuration.", + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "reboot_window", + "type": "object", + "x-stripeMostCommon": [ + "allow_reader_override", + "end_hour", + "start_hour" + ] + }, "stripe_s700": { "description": "An object containing device type specific settings for Stripe S700 readers", "properties": { @@ -153157,7 +176156,10 @@ } }, "title": "stripe_s700", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, "tipping": { "anyOf": [ @@ -153186,7 +176188,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "cad": { "description": "Tipping configuration for CAD", @@ -153211,7 +176218,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "chf": { "description": "Tipping configuration for CHF", @@ -153236,7 +176248,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "czk": { "description": "Tipping configuration for CZK", @@ -153261,7 +176278,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "dkk": { "description": "Tipping configuration for DKK", @@ -153286,7 +176308,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "eur": { "description": "Tipping configuration for EUR", @@ -153311,7 +176338,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "gbp": { "description": "Tipping configuration for GBP", @@ -153336,7 +176368,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "hkd": { "description": "Tipping configuration for HKD", @@ -153361,7 +176398,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "myr": { "description": "Tipping configuration for MYR", @@ -153386,7 +176428,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nok": { "description": "Tipping configuration for NOK", @@ -153411,7 +176458,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nzd": { "description": "Tipping configuration for NZD", @@ -153436,7 +176488,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sek": { "description": "Tipping configuration for SEK", @@ -153461,7 +176518,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sgd": { "description": "Tipping configuration for SGD", @@ -153486,7 +176548,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "usd": { "description": "Tipping configuration for USD", @@ -153511,11 +176578,32 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] } }, "title": "tipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aud", + "cad", + "chf", + "czk", + "dkk", + "eur", + "gbp", + "hkd", + "myr", + "nok", + "nzd", + "sek", + "sgd", + "usd" + ] }, { "enum": [ @@ -153545,10 +176633,19 @@ } }, "title": "verifone_p400", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bbpos_wisepos_e", + "stripe_s700", + "tipping", + "verifone_p400" + ] } } }, @@ -153734,6 +176831,10 @@ "explode": true, "style": "deepObject" }, + "reboot_window": { + "explode": true, + "style": "deepObject" + }, "stripe_s700": { "explode": true, "style": "deepObject" @@ -153770,7 +176871,10 @@ } }, "title": "bbpos_wise_pose", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, { "enum": [ @@ -153807,7 +176911,10 @@ "enabled" ], "title": "offline", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enabled" + ] }, { "enum": [ @@ -153818,6 +176925,40 @@ ], "description": "Configurations for collecting transactions offline." }, + "reboot_window": { + "anyOf": [ + { + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "reboot_window", + "type": "object", + "x-stripeMostCommon": [ + "allow_reader_override", + "end_hour", + "start_hour" + ] + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Reboot time settings for readers that support customized reboot time configuration." + }, "stripe_s700": { "anyOf": [ { @@ -153838,7 +176979,10 @@ } }, "title": "stripe_s700", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, { "enum": [ @@ -153876,7 +177020,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "cad": { "description": "Tipping configuration for CAD", @@ -153901,7 +177050,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "chf": { "description": "Tipping configuration for CHF", @@ -153926,7 +177080,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "czk": { "description": "Tipping configuration for CZK", @@ -153951,7 +177110,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "dkk": { "description": "Tipping configuration for DKK", @@ -153976,7 +177140,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "eur": { "description": "Tipping configuration for EUR", @@ -154001,7 +177170,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "gbp": { "description": "Tipping configuration for GBP", @@ -154026,7 +177200,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "hkd": { "description": "Tipping configuration for HKD", @@ -154051,7 +177230,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "myr": { "description": "Tipping configuration for MYR", @@ -154076,7 +177260,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nok": { "description": "Tipping configuration for NOK", @@ -154101,7 +177290,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "nzd": { "description": "Tipping configuration for NZD", @@ -154126,7 +177320,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sek": { "description": "Tipping configuration for SEK", @@ -154151,7 +177350,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "sgd": { "description": "Tipping configuration for SGD", @@ -154176,7 +177380,12 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] }, "usd": { "description": "Tipping configuration for USD", @@ -154201,11 +177410,32 @@ } }, "title": "currency_specific_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fixed_amounts", + "percentages", + "smart_tip_threshold" + ] } }, "title": "tipping", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aud", + "cad", + "chf", + "czk", + "dkk", + "eur", + "gbp", + "hkd", + "myr", + "nok", + "nzd", + "sek", + "sgd", + "usd" + ] }, { "enum": [ @@ -154236,7 +177466,10 @@ } }, "title": "verifone_p400", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "splashscreen" + ] }, { "enum": [ @@ -154248,7 +177481,13 @@ "description": "An object containing device type specific settings for Verifone P400 readers" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bbpos_wisepos_e", + "stripe_s700", + "tipping", + "verifone_p400" + ] } } }, @@ -154315,7 +177554,10 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "location" + ] } } }, @@ -154452,6 +177694,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -154531,15 +177779,23 @@ "country" ], "title": "create_location_address_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "configuration_overrides": { "description": "The ID of a configuration that will be used to customize all readers in this location.", - "maxLength": 1000, + "maxLength": 500, "type": "string" }, "display_name": { - "description": "A name for the location.", + "description": "A name for the location. Maximum length is 1000 characters.", "maxLength": 1000, "type": "string" }, @@ -154573,7 +177829,12 @@ "address", "display_name" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "display_name", + "metadata" + ] } } }, @@ -154802,7 +178063,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "configuration_overrides": { "anyOf": [ @@ -154850,7 +178119,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`." } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "display_name", + "metadata" + ] } } }, @@ -154905,6 +178179,7 @@ "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", + "stripe_s700", "verifone_P400" ], "type": "string", @@ -155050,6 +178325,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -155131,7 +178412,13 @@ "required": [ "registration_code" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "label", + "location", + "metadata", + "registration_code" + ] } } }, @@ -155362,7 +178649,11 @@ "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-stripeMostCommon": [ + "label", + "metadata" + ] } } }, @@ -155514,6 +178805,15 @@ "process_config": { "description": "Configuration overrides", "properties": { + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "enable_customer_cancellation": { "description": "Enables cancel button on transaction screens.", "type": "boolean" @@ -155531,17 +178831,32 @@ } }, "title": "tipping_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount_eligible" + ] } }, "title": "process_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redisplay", + "enable_customer_cancellation", + "moto", + "request_dynamic_currency_conversion", + "return_url", + "skip_tipping", + "tipping" + ] } }, "required": [ "payment_intent" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_intent" + ] } } }, @@ -155603,9 +178918,14 @@ "schema": { "additionalProperties": false, "properties": { - "customer_consent_collected": { - "description": "Customer Consent Collected", - "type": "boolean" + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -155624,7 +178944,11 @@ } }, "title": "process_setup_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enable_customer_cancellation", + "moto" + ] }, "setup_intent": { "description": "SetupIntent ID", @@ -155633,10 +178957,14 @@ } }, "required": [ - "customer_consent_collected", + "allow_redisplay", "setup_intent" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "allow_redisplay", + "setup_intent" + ] } } }, @@ -155744,14 +179072,25 @@ } }, "title": "refund_payment_config", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "enable_customer_cancellation" + ] }, "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": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "charge", + "metadata", + "payment_intent", + "refund_application_fee", + "reverse_transfer" + ] } } }, @@ -155844,7 +179183,12 @@ "quantity" ], "title": "line_item", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "quantity" + ] }, "type": "array" }, @@ -155863,7 +179207,13 @@ "total" ], "title": "cart", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "currency", + "line_items", + "tax", + "total" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -155884,7 +179234,11 @@ "required": [ "type" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cart", + "type" + ] } } }, @@ -155979,7 +179333,12 @@ "transit_number" ], "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "institution_number", + "transit_number" + ] }, "affirm": { "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", @@ -156033,7 +179392,11 @@ "bsb_number" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "bsb_number" + ] }, "bacs_debit": { "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", @@ -156050,7 +179413,11 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_number", + "sort_code" + ] }, "bancontact": { "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", @@ -156097,7 +179464,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -156154,7 +179529,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "blik": { "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", @@ -156175,7 +179556,10 @@ "tax_id" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "cashapp": { "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", @@ -156229,7 +179613,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "fpx": { "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", @@ -156278,7 +179665,11 @@ "bank" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "bank" + ] }, "giropay": { "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", @@ -156320,13 +179711,22 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "interac_present": { "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "device_identifier", + "device_type", + "emv", + "location" + ] }, "klarna": { "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", @@ -156353,11 +179753,19 @@ "year" ], "title": "date_of_birth", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "dob" + ] }, "konbini": { "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", @@ -156434,7 +179842,10 @@ } }, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank" + ] }, "paynow": { "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", @@ -156452,7 +179863,10 @@ "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", "properties": {}, "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tax_id" + ] }, "promptpay": { "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", @@ -156470,7 +179884,11 @@ } }, "title": "radar_options_with_hidden_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "session", + "skip_rules" + ] }, "revolut_pay": { "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", @@ -156491,7 +179909,10 @@ "iban" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "iban" + ] }, "sofort": { "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", @@ -156513,7 +179934,10 @@ "country" ], "title": "param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "country" + ] }, "swish": { "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", @@ -156606,7 +180030,14 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] }, "wechat_pay": { "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", @@ -156625,7 +180056,12 @@ "type" ], "title": "payment_method_data_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "return_url": { "description": "Return URL used to confirm the Intent.", @@ -156677,7 +180113,15 @@ } }, "title": "optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "name": { "description": "Recipient name.", @@ -156705,10 +180149,22 @@ "name" ], "title": "recipient_shipping_with_optional_fields_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "name", + "phone" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "payment_method", + "payment_method_data", + "return_url", + "setup_future_usage", + "shipping" + ] } } }, @@ -156792,7 +180248,11 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency" + ] } } }, @@ -156838,6 +180298,14 @@ "explode": true, "style": "deepObject" }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + }, "merchant_data": { "explode": true, "style": "deepObject" @@ -156871,7 +180339,11 @@ } }, "title": "amount_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "atm_fee", + "cashback_amount" + ] }, "authorization_method": { "description": "How the card details were provided. Defaults to online.", @@ -156901,6 +180373,197 @@ }, "type": "array" }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "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" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "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" + }, + "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" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_testmode_authorization_specs", + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "dynamic_purchase_controls_supported", + "purchase_type", + "reported_breakdown", + "service_type" + ] + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "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" + }, + "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": { + "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] + }, "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" @@ -157251,7 +180914,18 @@ } }, "title": "merchant_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "category", + "city", + "country", + "name", + "network_id", + "postal_code", + "state", + "terminal_id", + "url" + ] }, "network_data": { "description": "Details about the authorization, such as identifiers, set by the card network.", @@ -157263,7 +180937,10 @@ } }, "title": "network_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "acquiring_institution_id" + ] }, "verification_data": { "description": "Verifications that Stripe performed on information that the cardholder provided to the merchant.", @@ -157313,7 +180990,11 @@ "type" ], "title": "authentication_exemption_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "claimed_by", + "type" + ] }, "cvc_check": { "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.", @@ -157352,11 +181033,22 @@ "result" ], "title": "three_d_secure_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "result" + ] } }, "title": "verification_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address_line1_check", + "address_postal_code_check", + "authentication_exemption", + "cvc_check", + "expiry_check", + "three_d_secure" + ] }, "wallet": { "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.", @@ -157372,7 +181064,12 @@ "amount", "card" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "card", + "currency" + ] } } }, @@ -157453,6 +181150,140 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "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" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "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" + }, + "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" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -157505,7 +181336,15 @@ } }, "title": "flight_segment_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "arrival_airport_code", + "carrier", + "departure_airport_code", + "flight_number", + "service_class", + "stopover_allowed" + ] }, "type": "array" }, @@ -157516,11 +181355,23 @@ } }, "title": "flight_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "departure_at", + "passenger_name", + "refundable", + "segments", + "travel_agency" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "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" + }, "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", @@ -157560,7 +181411,14 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", @@ -157576,7 +181434,11 @@ } }, "title": "lodging_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "check_in_at", + "nights" + ] }, "receipt": { "description": "The line items in the purchase.", @@ -157598,7 +181460,13 @@ } }, "title": "receipt_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "quantity", + "total", + "unit_cost" + ] }, "type": "array" }, @@ -157609,7 +181477,87 @@ } }, "title": "purchase_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fleet", + "flight", + "fuel", + "lodging", + "receipt", + "reference" + ] + } + }, + "type": "object", + "x-stripeMostCommon": [ + "capture_amount", + "close_authorization", + "purchase_details" + ] + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.authorization" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/test_helpers/issuing/authorizations/{authorization}/expire": { + "post": { + "description": "Expire a test-mode Authorization.
", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire", + "parameters": [ + { + "in": "path", + "name": "authorization", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -157642,10 +181590,10 @@ } } }, - "/v1/test_helpers/issuing/authorizations/{authorization}/expire": { + "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { "post": { - "description": "Expire a test-mode Authorization.
", - "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire", + "description": "Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", "parameters": [ { "in": "path", @@ -157665,6 +181613,14 @@ "expand": { "explode": true, "style": "deepObject" + }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -157677,13 +181633,213 @@ "type": "string" }, "type": "array" + }, + "final_amount": { + "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" + }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "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" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "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" + }, + "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" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "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" + }, + "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": { + "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] } }, - "type": "object" + "required": [ + "final_amount" + ], + "type": "object", + "x-stripeMostCommon": [ + "final_amount" + ] } } }, - "required": false + "required": true }, "responses": { "200": { @@ -157757,7 +181913,11 @@ "required": [ "increment_amount" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "increment_amount", + "is_amount_controllable" + ] } } }, @@ -157828,7 +181988,10 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "reverse_amount" + ] } } }, @@ -158338,13 +182501,20 @@ } }, "title": "rejection_reasons_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_logo", + "carrier_text" + ] } }, "required": [ "rejection_reasons" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "rejection_reasons" + ] } } }, @@ -158765,11 +182935,156 @@ } }, "title": "merchant_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "category", + "city", + "country", + "name", + "network_id", + "postal_code", + "state", + "terminal_id", + "url" + ] }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "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" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "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" + }, + "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" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -158822,7 +183137,15 @@ } }, "title": "flight_segment_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "arrival_airport_code", + "carrier", + "departure_airport_code", + "flight_number", + "service_class", + "stopover_allowed" + ] }, "type": "array" }, @@ -158833,11 +183156,23 @@ } }, "title": "flight_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "departure_at", + "passenger_name", + "refundable", + "segments", + "travel_agency" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "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" + }, "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", @@ -158877,7 +183212,14 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", @@ -158893,7 +183235,11 @@ } }, "title": "lodging_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "check_in_at", + "nights" + ] }, "receipt": { "description": "The line items in the purchase.", @@ -158915,7 +183261,13 @@ } }, "title": "receipt_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "quantity", + "total", + "unit_cost" + ] }, "type": "array" }, @@ -158926,14 +183278,27 @@ } }, "title": "purchase_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fleet", + "flight", + "fuel", + "lodging", + "receipt", + "reference" + ] } }, "required": [ "amount", "card" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "card", + "currency" + ] } } }, @@ -159354,11 +183719,156 @@ } }, "title": "merchant_data_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "category", + "city", + "country", + "name", + "network_id", + "postal_code", + "state", + "terminal_id", + "url" + ] }, "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "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" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object", + "x-stripeMostCommon": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ] + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object", + "x-stripeMostCommon": [ + "gross_amount_decimal" + ] + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "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" + }, + "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" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object", + "x-stripeMostCommon": [ + "local_amount_decimal", + "national_amount_decimal" + ] + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object", + "x-stripeMostCommon": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object", + "x-stripeMostCommon": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ] + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -159411,7 +183921,15 @@ } }, "title": "flight_segment_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "arrival_airport_code", + "carrier", + "departure_airport_code", + "flight_number", + "service_class", + "stopover_allowed" + ] }, "type": "array" }, @@ -159422,11 +183940,23 @@ } }, "title": "flight_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "departure_at", + "passenger_name", + "refundable", + "segments", + "travel_agency" + ] }, "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "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" + }, "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", @@ -159466,7 +183996,14 @@ } }, "title": "fuel_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ] }, "lodging": { "description": "Information about lodging that was purchased with this transaction.", @@ -159482,7 +184019,11 @@ } }, "title": "lodging_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "check_in_at", + "nights" + ] }, "receipt": { "description": "The line items in the purchase.", @@ -159504,7 +184045,13 @@ } }, "title": "receipt_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "quantity", + "total", + "unit_cost" + ] }, "type": "array" }, @@ -159515,14 +184062,27 @@ } }, "title": "purchase_details_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "fleet", + "flight", + "fuel", + "lodging", + "receipt", + "reference" + ] } }, "required": [ "amount", "card" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "card", + "currency" + ] } } }, @@ -159593,7 +184153,10 @@ "type": "integer" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "refund_amount" + ] } } }, @@ -159739,7 +184302,10 @@ } }, "title": "card_present", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "number" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -159759,7 +184325,10 @@ } }, "title": "interac_present", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "number" + ] }, "type": { "description": "Simulated payment type.", @@ -159771,7 +184340,11 @@ "x-stripeBypassValidation": true } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_present", + "type" + ] } } }, @@ -159908,6 +184481,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -159963,7 +184542,11 @@ "required": [ "frozen_time" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "frozen_time", + "name" + ] } } }, @@ -160157,7 +184740,10 @@ "required": [ "frozen_time" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "frozen_time" + ] } } }, @@ -160251,10 +184837,16 @@ } }, "title": "failure_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "failure_details" + ] } } }, @@ -160474,7 +185066,10 @@ "trace_id" ], "title": "ach_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "trace_id" + ] }, "type": { "description": "The US bank account network used to send funds.", @@ -160487,6 +185082,11 @@ "us_domestic_wire": { "description": "US domestic wire network tracking details.", "properties": { + "chips": { + "description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + }, "imad": { "description": "IMAD for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, @@ -160499,20 +185099,33 @@ } }, "title": "us_domestic_wire_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "chips", + "imad", + "omad" + ] } }, "required": [ "type" ], "title": "tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "type", + "us_domestic_wire" + ] } }, "required": [ "tracking_details" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tracking_details" + ] } } }, @@ -160737,10 +185350,16 @@ } }, "title": "returned_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "returned_details" + ] } } }, @@ -160826,7 +185445,10 @@ "trace_id" ], "title": "ach_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "trace_id" + ] }, "type": { "description": "The US bank account network used to send funds.", @@ -160839,6 +185461,11 @@ "us_domestic_wire": { "description": "US domestic wire network tracking details.", "properties": { + "chips": { + "description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + }, "imad": { "description": "IMAD for funds sent over the `us_domestic_wire` network.", "maxLength": 5000, @@ -160851,20 +185478,33 @@ } }, "title": "us_domestic_wire_tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "chips", + "imad", + "omad" + ] } }, "required": [ "type" ], "title": "tracking_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "type", + "us_domestic_wire" + ] } }, "required": [ "tracking_details" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "tracking_details" + ] } } }, @@ -161089,10 +185729,16 @@ } }, "title": "returned_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "code" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "returned_details" + ] } } }, @@ -161197,14 +185843,23 @@ } }, "title": "us_bank_account_source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_name", + "account_number", + "routing_number" + ] } }, "required": [ "type" ], "title": "source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "us_bank_account" + ] }, "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.", @@ -161221,7 +185876,15 @@ "financial_account", "network" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "financial_account", + "initiating_payment_method_details", + "network" + ] } } }, @@ -161326,14 +185989,23 @@ } }, "title": "us_bank_account_source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_name", + "account_number", + "routing_number" + ] } }, "required": [ "type" ], "title": "source_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "type", + "us_bank_account" + ] }, "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.", @@ -161349,7 +186021,15 @@ "financial_account", "network" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "financial_account", + "initiating_payment_method_details", + "network" + ] } } }, @@ -161471,7 +186151,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the company's primary address (Japan only).", @@ -161513,7 +186201,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the company's primary address (Japan only).", @@ -161555,14 +186253,24 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "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](https://docs.stripe.com/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.", + "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" }, "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](https://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.", + "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" }, "export_license_id": { @@ -161591,7 +186299,7 @@ "type": "string" }, "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](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.", + "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" }, "ownership_declaration": { @@ -161613,7 +186321,12 @@ } }, "title": "company_ownership_declaration", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] }, "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.", @@ -161630,7 +186343,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", + "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.", "enum": [ "", "free_zone_establishment", @@ -161693,15 +186406,54 @@ } }, "title": "verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "document" + ] } }, "title": "connect_js_account_token_company_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "contact_point_verification_address", + "cross_border_transaction_classifications", + "directors_provided", + "executives_provided", + "export_license_id", + "export_purpose_code", + "fiscal_code", + "invoicing_recipient_code", + "name", + "name_kana", + "name_kanji", + "owners_provided", + "ownership_declaration", + "ownership_declaration_shown_and_signed", + "pan", + "phone", + "registered_email", + "registration_date", + "registration_number", + "stock_data", + "structure", + "tax_deduction_account_number", + "tax_id", + "tax_id_registrar", + "vat_id", + "vat_registration_status", + "verification" + ] }, "individual": { "description": "Information about the person represented by the account.", @@ -161741,7 +186493,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the individual's primary address (Japan only).", @@ -161783,7 +186543,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the individual's primary address (Japan only).", @@ -161825,7 +186595,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -161850,7 +186630,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -161903,12 +186688,12 @@ "type": "string" }, "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](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "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" }, "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](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "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" }, @@ -161996,7 +186781,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "Describes the person’s relationship to the account.", @@ -162034,7 +186827,17 @@ } }, "title": "individual_relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "controller", + "director", + "executive", + "officer", + "owner", + "partner", + "percent_ownership", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", @@ -162059,7 +186862,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -162076,23 +186883,64 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, "title": "individual_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "address_kana", + "address_kanji", + "birth_city", + "birth_country", + "dob", + "email", + "first_name", + "first_name_kana", + "first_name_kanji", + "full_name_aliases", + "gender", + "id_number", + "id_number_secondary", + "last_name", + "last_name_kana", + "last_name_kanji", + "maiden_name", + "metadata", + "phone", + "political_exposure", + "registered_address", + "relationship", + "ssn_last_4", + "verification" + ] }, "tos_shown_and_accepted": { - "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://docs.stripe.com/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", + "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" } }, "title": "connect_js_account_token_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "business_type", + "company", + "individual", + "tos_shown_and_accepted" + ] }, "bank_account": { "description": "The bank account this token will represent.", @@ -162153,7 +187001,19 @@ ], "title": "token_create_bank_account", "type": "object", - "x-stripeBypassValidation": true + "x-stripeBypassValidation": true, + "x-stripeMostCommon": [ + "account_holder_name", + "account_holder_type", + "account_number", + "account_type", + "country", + "currency", + "debit_agreement_shown_and_accepted", + "debit_agreement_type", + "payment_method", + "routing_number" + ] }, "card": { "anyOf": [ @@ -162228,7 +187088,10 @@ } }, "title": "networks_param_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "preferred" + ] }, "number": { "description": "The card number, as a string without any separators.", @@ -162243,6 +187106,21 @@ ], "title": "credit_card_specs", "type": "object", + "x-stripeMostCommon": [ + "address_city", + "address_country", + "address_line1", + "address_line2", + "address_state", + "address_zip", + "currency", + "cvc", + "exp_month", + "exp_year", + "name", + "networks", + "number" + ], "x-stripeParam": { "class_name": "Card" } @@ -162273,7 +187151,10 @@ "cvc" ], "title": "cvc_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "cvc" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -162287,7 +187168,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.", @@ -162318,11 +187199,20 @@ } }, "title": "settings_terms_of_service_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "date", + "ip", + "user_agent" + ] } }, "title": "person_additional_tos_acceptances_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "representative" + ] }, "address": { "description": "The person's address.", @@ -162359,7 +187249,15 @@ } }, "title": "legal_entity_and_kyc_address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "address_kana": { "description": "The Kana variation of the person's address (Japan only).", @@ -162401,7 +187299,17 @@ } }, "title": "japan_address_kana_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "address_kanji": { "description": "The Kanji variation of the person's address (Japan only).", @@ -162443,7 +187351,17 @@ } }, "title": "japan_address_kanji_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "db_code", + "line1", + "line2", + "postal_code", + "state", + "town" + ] }, "dob": { "anyOf": [ @@ -162468,7 +187386,12 @@ "year" ], "title": "date_of_birth_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "day", + "month", + "year" + ] }, { "enum": [ @@ -162505,7 +187428,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "passport": { "description": "One or more documents showing the person's passport page with photo and personal data.", @@ -162530,7 +187456,10 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] }, "visa": { "description": "One or more documents showing the person's visa required for living in the country where they are residing.", @@ -162555,11 +187484,20 @@ } }, "title": "documents_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "files" + ] } }, "title": "person_documents_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "DASHBOARD_proof_of_liveness", + "company_authorization", + "passport", + "visa" + ] }, "email": { "description": "The person's email address.", @@ -162698,7 +187636,15 @@ } }, "title": "address_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, "relationship": { "description": "The relationship that this person has with the account's legal entity.", @@ -162744,7 +187690,20 @@ } }, "title": "relationship_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "authorizer", + "controller", + "director", + "executive", + "legal_guardian", + "officer", + "owner", + "partner", + "percent_ownership", + "representative", + "title" + ] }, "ssn_last_4": { "description": "The last four digits of the person's Social Security number (U.S. only).", @@ -162768,7 +187727,11 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] }, "document": { "description": "An identifying document, either a passport or local ID card.", @@ -162785,15 +187748,35 @@ } }, "title": "person_verification_document_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "back", + "front" + ] } }, "title": "person_verification_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "additional_document", + "document" + ] } }, "title": "person_token_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "dob", + "email", + "first_name", + "id_number", + "last_name", + "metadata", + "phone", + "relationship", + "ssn_last_4" + ] }, "pii": { "description": "The PII this token represents.", @@ -162805,10 +187788,21 @@ } }, "title": "pii_token_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "id_number" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account", + "bank_account", + "card", + "cvc_update", + "person", + "pii" + ] } } }, @@ -162939,7 +187933,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -162976,7 +187976,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -163104,6 +188110,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -163198,7 +188210,13 @@ "amount", "currency" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "metadata" + ] } } }, @@ -163357,7 +188375,11 @@ "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-stripeMostCommon": [ + "description", + "metadata" + ] } } }, @@ -163487,7 +188509,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -163621,6 +188649,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -163663,7 +188697,7 @@ "type": "integer" }, "currency": { - "description": "3-letter [ISO code for currency](https://stripe.com/docs/payouts).", + "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).", "type": "string" }, "description": { @@ -163714,7 +188748,14 @@ "currency", "destination" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "destination", + "metadata" + ] } } }, @@ -163861,6 +188902,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -163949,7 +188996,12 @@ "type": "boolean" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "description", + "metadata" + ] } } }, @@ -164108,7 +189160,11 @@ "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-stripeMostCommon": [ + "description", + "metadata" + ] } } }, @@ -164282,7 +189338,10 @@ "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-stripeMostCommon": [ + "metadata" + ] } } }, @@ -164455,6 +189514,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -164516,7 +189581,11 @@ "required": [ "received_credit" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "received_credit" + ] } } }, @@ -164771,6 +189840,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -164832,7 +189907,11 @@ "required": [ "received_debit" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "metadata", + "received_debit" + ] } } }, @@ -164963,7 +190042,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -165074,6 +190159,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -165146,7 +190237,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", @@ -165160,7 +190254,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", @@ -165177,11 +190274,19 @@ "requested" ], "title": "aba_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank", + "forwarding", + "requested" + ] } }, "title": "financial_addresses", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aba" + ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", @@ -165198,11 +190303,18 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] } }, "title": "inbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach" + ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", @@ -165216,7 +190328,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", @@ -165233,7 +190348,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", @@ -165247,11 +190366,18 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_payments", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", @@ -165268,7 +190394,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", @@ -165282,15 +190412,31 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] } }, "title": "feature_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "deposit_insurance", + "financial_addresses", + "inbound_transfers", + "intra_stripe_flows", + "outbound_payments", + "outbound_transfers" + ] }, "metadata": { "additionalProperties": { @@ -165320,7 +190466,13 @@ } }, "title": "platform_restrictions", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "inbound_flows", + "outbound_flows", + "received_credits", + "received_debits" + ] }, "supported_currencies": { "description": "The currencies the FinancialAccount can hold a balance in.", @@ -165334,7 +190486,13 @@ "required": [ "supported_currencies" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features", + "metadata", + "platform_restrictions", + "supported_currencies" + ] } } }, @@ -165493,7 +190651,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", @@ -165507,7 +190668,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "financial_addresses": { "description": "Contains Features that add FinancialAddresses to the FinancialAccount.", @@ -165524,11 +190688,19 @@ "requested" ], "title": "aba_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank", + "forwarding", + "requested" + ] } }, "title": "financial_addresses", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aba" + ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", @@ -165545,11 +190717,18 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] } }, "title": "inbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach" + ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", @@ -165563,7 +190742,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", @@ -165580,7 +190762,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", @@ -165594,11 +190780,18 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_payments", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", @@ -165615,7 +190808,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", @@ -165629,15 +190826,31 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] } }, "title": "feature_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "deposit_insurance", + "financial_addresses", + "inbound_transfers", + "intra_stripe_flows", + "outbound_payments", + "outbound_transfers" + ] }, "metadata": { "additionalProperties": { @@ -165667,10 +190880,21 @@ } }, "title": "platform_restrictions", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "inbound_flows", + "outbound_flows", + "received_credits", + "received_debits" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "features", + "metadata", + "platform_restrictions" + ] } } }, @@ -165834,7 +191058,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "deposit_insurance": { "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.", @@ -165848,7 +191075,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -165873,11 +191103,19 @@ "requested" ], "title": "aba_access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "bank", + "forwarding", + "requested" + ] } }, "title": "financial_addresses", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "aba" + ] }, "inbound_transfers": { "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.", @@ -165894,11 +191132,18 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] } }, "title": "inbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach" + ] }, "intra_stripe_flows": { "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).", @@ -165912,7 +191157,10 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] }, "outbound_payments": { "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.", @@ -165929,7 +191177,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundPayments API.", @@ -165943,11 +191195,18 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_payments", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] }, "outbound_transfers": { "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.", @@ -165964,7 +191223,11 @@ "requested" ], "title": "access_with_ach_details", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested", + "same_day" + ] }, "us_domestic_wire": { "description": "Enables US domestic wire transfers via the OutboundTransfers API.", @@ -165978,14 +191241,30 @@ "requested" ], "title": "access", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "requested" + ] } }, "title": "outbound_transfers", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "us_domestic_wire" + ] } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "card_issuing", + "deposit_insurance", + "financial_addresses", + "inbound_transfers", + "intra_stripe_flows", + "outbound_payments", + "outbound_transfers" + ] } } }, @@ -166148,6 +191427,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -166234,7 +191519,16 @@ "financial_account", "origin_payment_method" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "financial_account", + "metadata", + "origin_payment_method", + "statement_descriptor" + ] } } }, @@ -166432,7 +191726,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -166582,6 +191882,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -166696,7 +192002,15 @@ } }, "title": "billing_details_address", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "city", + "country", + "line1", + "line2", + "postal_code", + "state" + ] }, { "enum": [ @@ -166753,7 +192067,13 @@ } }, "title": "billing_details_inner_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "address", + "email", + "name", + "phone" + ] }, "financial_account": { "description": "Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.", @@ -166810,14 +192130,26 @@ } }, "title": "payment_method_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "account_holder_type", + "account_number", + "account_type", + "financial_connections_account", + "routing_number" + ] } }, "required": [ "type" ], "title": "payment_method_data", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "billing_details", + "metadata", + "type" + ] }, "destination_payment_method_options": { "description": "Payment method-specific configuration for this OutboundPayment.", @@ -166836,7 +192168,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "network" + ] }, { "enum": [ @@ -166849,7 +192185,10 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "us_bank_account" + ] }, "end_user_details": { "description": "End user details.", @@ -166867,7 +192206,11 @@ "present" ], "title": "end_user_details_params", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ip_address", + "present" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -166899,7 +192242,20 @@ "currency", "financial_account" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "customer", + "description", + "destination_payment_method", + "destination_payment_method_data", + "destination_payment_method_options", + "end_user_details", + "financial_account", + "metadata", + "statement_descriptor" + ] } } }, @@ -167198,6 +192554,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -167274,7 +192636,11 @@ } }, "title": "payment_method_options_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "ach", + "network" + ] }, { "enum": [ @@ -167287,7 +192653,10 @@ } }, "title": "payment_method_options", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "us_bank_account" + ] }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -167319,7 +192688,17 @@ "currency", "financial_account" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "amount", + "currency", + "description", + "destination_payment_method", + "destination_payment_method_options", + "financial_account", + "metadata", + "statement_descriptor" + ] } } }, @@ -167559,7 +192938,10 @@ "source_flow_type" ], "title": "linked_flows_param", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "source_flow_type" + ] }, "style": "deepObject" }, @@ -167644,6 +193026,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -167863,6 +193251,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -167983,7 +193377,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -168019,7 +193419,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -168166,6 +193572,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -168286,7 +193698,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -168412,7 +193830,13 @@ } }, "title": "range_query_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "gt", + "gte", + "lt", + "lte" + ] }, { "type": "integer" @@ -168422,7 +193846,10 @@ } }, "title": "status_transition_timestamp_specs", - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "posted_at" + ] }, "style": "deepObject" } @@ -168481,6 +193908,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -168675,6 +194108,12 @@ "type": "object", "x-expandableFields": [ "data" + ], + "x-stripeMostCommon": [ + "data", + "has_more", + "object", + "url" ] } } @@ -168823,7 +194262,9 @@ "2022-11-15", "2023-08-16", "2023-10-16", - "2024-04-10" + "2024-04-10", + "2024-06-20", + "2024-09-30.acacia" ], "maxLength": 5000, "type": "string", @@ -168863,6 +194304,7 @@ "application_fee.refund.updated", "application_fee.refunded", "balance.available", + "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", @@ -168940,6 +194382,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -168948,6 +194391,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -168960,6 +194404,7 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_personalization_design.activated", @@ -169126,7 +194571,14 @@ "enabled_events", "url" ], - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "api_version", + "description", + "enabled_events", + "metadata", + "url" + ] } } }, @@ -169347,6 +194799,7 @@ "application_fee.refund.updated", "application_fee.refunded", "balance.available", + "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", @@ -169424,6 +194877,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -169432,6 +194886,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -169444,6 +194899,7 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_personalization_design.activated", @@ -169606,7 +195062,13 @@ "type": "string" } }, - "type": "object" + "type": "object", + "x-stripeMostCommon": [ + "description", + "enabled_events", + "metadata", + "url" + ] } } }, diff --git a/pkg/cmd/resources_cmds.go b/pkg/cmd/resources_cmds.go index de16fa4c..6bb852da 100644 --- a/pkg/cmd/resources_cmds.go +++ b/pkg/cmd/resources_cmds.go @@ -62,6 +62,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { rFeeRefundsCmd := resource.NewResourceCmd(rootCmd, "fee_refunds") rFileLinksCmd := resource.NewResourceCmd(rootCmd, "file_links") rFilesCmd := resource.NewResourceCmd(rootCmd, "files") + rInvoiceRenderingTemplatesCmd := resource.NewResourceCmd(rootCmd, "invoice_rendering_templates") rInvoiceitemsCmd := resource.NewResourceCmd(rootCmd, "invoiceitems") rInvoicesCmd := resource.NewResourceCmd(rootCmd, "invoices") rLineItemsCmd := resource.NewResourceCmd(rootCmd, "line_items") @@ -103,6 +104,10 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { rUsageRecordsCmd := resource.NewResourceCmd(rootCmd, "usage_records") rWebhookEndpointsCmd := resource.NewResourceCmd(rootCmd, "webhook_endpoints") rAppsSecretsCmd := resource.NewResourceCmd(nsAppsCmd.Cmd, "secrets") + rBillingAlertsCmd := resource.NewResourceCmd(nsBillingCmd.Cmd, "alerts") + rBillingCreditBalanceSummarysCmd := resource.NewResourceCmd(nsBillingCmd.Cmd, "credit_balance_summarys") + rBillingCreditBalanceTransactionsCmd := resource.NewResourceCmd(nsBillingCmd.Cmd, "credit_balance_transactions") + rBillingCreditGrantsCmd := resource.NewResourceCmd(nsBillingCmd.Cmd, "credit_grants") rBillingMeterEventAdjustmentsCmd := resource.NewResourceCmd(nsBillingCmd.Cmd, "meter_event_adjustments") rBillingMeterEventSummarysCmd := resource.NewResourceCmd(nsBillingCmd.Cmd, "meter_event_summarys") rBillingMeterEventsCmd := resource.NewResourceCmd(nsBillingCmd.Cmd, "meter_events") @@ -220,6 +225,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "components.payouts.features.instant_payouts": "boolean", "components.payouts.features.standard_payouts": "boolean", "components.payouts_list.enabled": "boolean", + "components.tax_registrations.enabled": "boolean", + "components.tax_settings.enabled": "boolean", }, &Config) resource.NewOperationCmd(rAccountsCmd.Cmd, "capabilities", "/v1/accounts/{account}/capabilities", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rAccountsCmd.Cmd, "create", "/v1/accounts", http.MethodPost, map[string]string{ @@ -871,6 +878,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "amount": "integer", "credit_amount": "integer", "effective_at": "integer", + "email_type": "string", "invoice": "string", "memo": "string", "out_of_band_amount": "integer", @@ -891,6 +899,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "amount": "integer", "credit_amount": "integer", "effective_at": "integer", + "email_type": "string", "invoice": "string", "memo": "string", "out_of_band_amount": "integer", @@ -902,6 +911,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "amount": "integer", "credit_amount": "integer", "effective_at": "integer", + "email_type": "string", "ending_before": "string", "invoice": "string", "limit": "integer", @@ -938,9 +948,16 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { }, &Config) resource.NewOperationCmd(rCustomerCashBalanceTransactionsCmd.Cmd, "retrieve", "/v1/customers/{customer}/cash_balance_transactions/{transaction}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rCustomerSessionsCmd.Cmd, "create", "/v1/customer_sessions", http.MethodPost, map[string]string{ - "components.buy_button.enabled": "boolean", - "components.pricing_table.enabled": "boolean", - "customer": "string", + "components.buy_button.enabled": "boolean", + "components.payment_element.enabled": "boolean", + "components.payment_element.features.payment_method_allow_redisplay_filters": "array", + "components.payment_element.features.payment_method_redisplay": "string", + "components.payment_element.features.payment_method_redisplay_limit": "integer", + "components.payment_element.features.payment_method_remove": "string", + "components.payment_element.features.payment_method_save": "string", + "components.payment_element.features.payment_method_save_usage": "string", + "components.pricing_table.enabled": "boolean", + "customer": "string", }, &Config) resource.NewOperationCmd(rCustomersCmd.Cmd, "balance_transactions", "/v1/customers/{customer}/balance_transactions", http.MethodGet, map[string]string{ "ending_before": "string", @@ -1152,6 +1169,17 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "starting_after": "string", }, &Config) resource.NewOperationCmd(rFilesCmd.Cmd, "retrieve", "/v1/files/{file}", http.MethodGet, map[string]string{}, &Config) + resource.NewOperationCmd(rInvoiceRenderingTemplatesCmd.Cmd, "archive", "/v1/invoice_rendering_templates/{template}/archive", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rInvoiceRenderingTemplatesCmd.Cmd, "list", "/v1/invoice_rendering_templates", http.MethodGet, map[string]string{ + "ending_before": "string", + "limit": "integer", + "starting_after": "string", + "status": "string", + }, &Config) + resource.NewOperationCmd(rInvoiceRenderingTemplatesCmd.Cmd, "retrieve", "/v1/invoice_rendering_templates/{template}", http.MethodGet, map[string]string{ + "version": "integer", + }, &Config) + resource.NewOperationCmd(rInvoiceRenderingTemplatesCmd.Cmd, "unarchive", "/v1/invoice_rendering_templates/{template}/unarchive", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rInvoiceitemsCmd.Cmd, "create", "/v1/invoiceitems", http.MethodPost, map[string]string{ "amount": "integer", "currency": "string", @@ -1205,6 +1233,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "unit_amount": "integer", "unit_amount_decimal": "string", }, &Config) + resource.NewOperationCmd(rInvoicesCmd.Cmd, "add_lines", "/v1/invoices/{invoice}/add_lines", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "create", "/v1/invoices", http.MethodPost, map[string]string{ "account_tax_ids": "array", "application_fee_amount": "integer", @@ -1234,6 +1263,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "pending_invoice_items_behavior": "string", "rendering.amount_tax_display": "string", "rendering.pdf.page_size": "string", + "rendering.template": "string", + "rendering.template_version": "integer", "shipping_cost.shipping_rate": "string", "shipping_cost.shipping_rate_data.delivery_estimate.maximum.unit": "string", "shipping_cost.shipping_rate_data.delivery_estimate.maximum.value": "integer", @@ -1310,6 +1341,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "payment_method": "string", "source": "string", }, &Config) + resource.NewOperationCmd(rInvoicesCmd.Cmd, "remove_lines", "/v1/invoices/{invoice}/remove_lines", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "retrieve", "/v1/invoices/{invoice}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "search", "/v1/invoices/search", http.MethodGet, map[string]string{ "limit": "integer", @@ -1384,8 +1416,11 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "payment_settings.payment_method_types": "array", "rendering.amount_tax_display": "string", "rendering.pdf.page_size": "string", + "rendering.template": "string", + "rendering.template_version": "integer", "statement_descriptor": "string", }, &Config) + resource.NewOperationCmd(rInvoicesCmd.Cmd, "update_lines", "/v1/invoices/{invoice}/update_lines", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "void_invoice", "/v1/invoices/{invoice}/void", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rLineItemsCmd.Cmd, "list", "/v1/invoices/{invoice}/lines", http.MethodGet, map[string]string{ "ending_before": "string", @@ -1654,6 +1689,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "subscription_data.trial_period_days": "integer", "subscription_data.trial_settings.end_behavior.missing_payment_method": "string", "tax_id_collection.enabled": "boolean", + "tax_id_collection.required": "string", "transfer_data.amount": "integer", "transfer_data.destination": "string", }, &Config) @@ -1696,6 +1732,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "subscription_data.invoice_settings.issuer.account": "string", "subscription_data.invoice_settings.issuer.type": "string", "tax_id_collection.enabled": "boolean", + "tax_id_collection.required": "string", }, &Config) resource.NewOperationCmd(rPaymentMethodConfigurationsCmd.Cmd, "create", "/v1/payment_method_configurations", http.MethodPost, map[string]string{ "acss_debit.display_preference.preference": "string", @@ -1737,6 +1774,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "sepa_debit.display_preference.preference": "string", "sofort.display_preference.preference": "string", "swish.display_preference.preference": "string", + "twint.display_preference.preference": "string", "us_bank_account.display_preference.preference": "string", "wechat_pay.display_preference.preference": "string", "zip.display_preference.preference": "string", @@ -1788,6 +1826,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "sepa_debit.display_preference.preference": "string", "sofort.display_preference.preference": "string", "swish.display_preference.preference": "string", + "twint.display_preference.preference": "string", "us_bank_account.display_preference.preference": "string", "wechat_pay.display_preference.preference": "string", "zip.display_preference.preference": "string", @@ -2129,27 +2168,31 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { }, &Config) resource.NewOperationCmd(rProductFeaturesCmd.Cmd, "retrieve", "/v1/products/{product}/features/{id}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rProductsCmd.Cmd, "create", "/v1/products", http.MethodPost, map[string]string{ - "active": "boolean", - "default_price_data.currency": "string", - "default_price_data.recurring.interval": "string", - "default_price_data.recurring.interval_count": "integer", - "default_price_data.tax_behavior": "string", - "default_price_data.unit_amount": "integer", - "default_price_data.unit_amount_decimal": "string", - "description": "string", - "id": "string", - "images": "array", - "name": "string", - "package_dimensions.height": "number", - "package_dimensions.length": "number", - "package_dimensions.weight": "number", - "package_dimensions.width": "number", - "shippable": "boolean", - "statement_descriptor": "string", - "tax_code": "string", - "type": "string", - "unit_label": "string", - "url": "string", + "active": "boolean", + "default_price_data.currency": "string", + "default_price_data.custom_unit_amount.enabled": "boolean", + "default_price_data.custom_unit_amount.maximum": "integer", + "default_price_data.custom_unit_amount.minimum": "integer", + "default_price_data.custom_unit_amount.preset": "integer", + "default_price_data.recurring.interval": "string", + "default_price_data.recurring.interval_count": "integer", + "default_price_data.tax_behavior": "string", + "default_price_data.unit_amount": "integer", + "default_price_data.unit_amount_decimal": "string", + "description": "string", + "id": "string", + "images": "array", + "name": "string", + "package_dimensions.height": "number", + "package_dimensions.length": "number", + "package_dimensions.weight": "number", + "package_dimensions.width": "number", + "shippable": "boolean", + "statement_descriptor": "string", + "tax_code": "string", + "type": "string", + "unit_label": "string", + "url": "string", }, &Config) resource.NewOperationCmd(rProductsCmd.Cmd, "delete", "/v1/products/{id}", http.MethodDelete, map[string]string{}, &Config) resource.NewOperationCmd(rProductsCmd.Cmd, "list", "/v1/products", http.MethodGet, map[string]string{ @@ -2327,72 +2370,73 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "confirm", "/v1/setup_intents/{intent}/confirm", http.MethodPost, map[string]string{ "confirmation_token": "string", "payment_method": "string", - "payment_method_data.acss_debit.account_number": "string", - "payment_method_data.acss_debit.institution_number": "string", - "payment_method_data.acss_debit.transit_number": "string", - "payment_method_data.allow_redisplay": "string", - "payment_method_data.au_becs_debit.account_number": "string", - "payment_method_data.au_becs_debit.bsb_number": "string", - "payment_method_data.bacs_debit.account_number": "string", - "payment_method_data.bacs_debit.sort_code": "string", - "payment_method_data.billing_details.email": "string", - "payment_method_data.billing_details.name": "string", - "payment_method_data.billing_details.phone": "string", - "payment_method_data.boleto.tax_id": "string", - "payment_method_data.eps.bank": "string", - "payment_method_data.fpx.account_holder_type": "string", - "payment_method_data.fpx.bank": "string", - "payment_method_data.ideal.bank": "string", - "payment_method_data.klarna.dob.day": "integer", - "payment_method_data.klarna.dob.month": "integer", - "payment_method_data.klarna.dob.year": "integer", - "payment_method_data.p24.bank": "string", - "payment_method_data.radar_options.session": "string", - "payment_method_data.sepa_debit.iban": "string", - "payment_method_data.sofort.country": "string", - "payment_method_data.type": "string", - "payment_method_data.us_bank_account.account_holder_type": "string", - "payment_method_data.us_bank_account.account_number": "string", - "payment_method_data.us_bank_account.account_type": "string", - "payment_method_data.us_bank_account.financial_connections_account": "string", - "payment_method_data.us_bank_account.routing_number": "string", - "payment_method_options.acss_debit.currency": "string", - "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", - "payment_method_options.acss_debit.mandate_options.default_for": "array", - "payment_method_options.acss_debit.mandate_options.interval_description": "string", - "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", - "payment_method_options.acss_debit.mandate_options.transaction_type": "string", - "payment_method_options.acss_debit.verification_method": "string", - "payment_method_options.card.mandate_options.amount": "integer", - "payment_method_options.card.mandate_options.amount_type": "string", - "payment_method_options.card.mandate_options.currency": "string", - "payment_method_options.card.mandate_options.description": "string", - "payment_method_options.card.mandate_options.end_date": "integer", - "payment_method_options.card.mandate_options.interval": "string", - "payment_method_options.card.mandate_options.interval_count": "integer", - "payment_method_options.card.mandate_options.reference": "string", - "payment_method_options.card.mandate_options.start_date": "integer", - "payment_method_options.card.mandate_options.supported_types": "array", - "payment_method_options.card.moto": "boolean", - "payment_method_options.card.network": "string", - "payment_method_options.card.request_three_d_secure": "string", - "payment_method_options.card.three_d_secure.ares_trans_status": "string", - "payment_method_options.card.three_d_secure.cryptogram": "string", - "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", - "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", - "payment_method_options.card.three_d_secure.transaction_id": "string", - "payment_method_options.card.three_d_secure.version": "string", - "payment_method_options.link.persistent_token": "string", - "payment_method_options.paypal.billing_agreement_id": "string", - "payment_method_options.us_bank_account.financial_connections.permissions": "array", - "payment_method_options.us_bank_account.financial_connections.prefetch": "array", - "payment_method_options.us_bank_account.financial_connections.return_url": "string", - "payment_method_options.us_bank_account.mandate_options.collection_method": "string", - "payment_method_options.us_bank_account.networks.requested": "array", - "payment_method_options.us_bank_account.verification_method": "string", + "payment_method_data.acss_debit.account_number": "string", + "payment_method_data.acss_debit.institution_number": "string", + "payment_method_data.acss_debit.transit_number": "string", + "payment_method_data.allow_redisplay": "string", + "payment_method_data.au_becs_debit.account_number": "string", + "payment_method_data.au_becs_debit.bsb_number": "string", + "payment_method_data.bacs_debit.account_number": "string", + "payment_method_data.bacs_debit.sort_code": "string", + "payment_method_data.billing_details.email": "string", + "payment_method_data.billing_details.name": "string", + "payment_method_data.billing_details.phone": "string", + "payment_method_data.boleto.tax_id": "string", + "payment_method_data.eps.bank": "string", + "payment_method_data.fpx.account_holder_type": "string", + "payment_method_data.fpx.bank": "string", + "payment_method_data.ideal.bank": "string", + "payment_method_data.klarna.dob.day": "integer", + "payment_method_data.klarna.dob.month": "integer", + "payment_method_data.klarna.dob.year": "integer", + "payment_method_data.p24.bank": "string", + "payment_method_data.radar_options.session": "string", + "payment_method_data.sepa_debit.iban": "string", + "payment_method_data.sofort.country": "string", + "payment_method_data.type": "string", + "payment_method_data.us_bank_account.account_holder_type": "string", + "payment_method_data.us_bank_account.account_number": "string", + "payment_method_data.us_bank_account.account_type": "string", + "payment_method_data.us_bank_account.financial_connections_account": "string", + "payment_method_data.us_bank_account.routing_number": "string", + "payment_method_options.acss_debit.currency": "string", + "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", + "payment_method_options.acss_debit.mandate_options.default_for": "array", + "payment_method_options.acss_debit.mandate_options.interval_description": "string", + "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", + "payment_method_options.acss_debit.mandate_options.transaction_type": "string", + "payment_method_options.acss_debit.verification_method": "string", + "payment_method_options.card.mandate_options.amount": "integer", + "payment_method_options.card.mandate_options.amount_type": "string", + "payment_method_options.card.mandate_options.currency": "string", + "payment_method_options.card.mandate_options.description": "string", + "payment_method_options.card.mandate_options.end_date": "integer", + "payment_method_options.card.mandate_options.interval": "string", + "payment_method_options.card.mandate_options.interval_count": "integer", + "payment_method_options.card.mandate_options.reference": "string", + "payment_method_options.card.mandate_options.start_date": "integer", + "payment_method_options.card.mandate_options.supported_types": "array", + "payment_method_options.card.moto": "boolean", + "payment_method_options.card.network": "string", + "payment_method_options.card.request_three_d_secure": "string", + "payment_method_options.card.three_d_secure.ares_trans_status": "string", + "payment_method_options.card.three_d_secure.cryptogram": "string", + "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", + "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", + "payment_method_options.card.three_d_secure.transaction_id": "string", + "payment_method_options.card.three_d_secure.version": "string", + "payment_method_options.link.persistent_token": "string", + "payment_method_options.paypal.billing_agreement_id": "string", + "payment_method_options.us_bank_account.financial_connections.filters.account_subcategories": "array", + "payment_method_options.us_bank_account.financial_connections.permissions": "array", + "payment_method_options.us_bank_account.financial_connections.prefetch": "array", + "payment_method_options.us_bank_account.financial_connections.return_url": "string", + "payment_method_options.us_bank_account.mandate_options.collection_method": "string", + "payment_method_options.us_bank_account.networks.requested": "array", + "payment_method_options.us_bank_account.verification_method": "string", "return_url": "string", "use_stripe_sdk": "boolean", }, &Config) @@ -2408,78 +2452,79 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "on_behalf_of": "string", "payment_method": "string", "payment_method_configuration": "string", - "payment_method_data.acss_debit.account_number": "string", - "payment_method_data.acss_debit.institution_number": "string", - "payment_method_data.acss_debit.transit_number": "string", - "payment_method_data.allow_redisplay": "string", - "payment_method_data.au_becs_debit.account_number": "string", - "payment_method_data.au_becs_debit.bsb_number": "string", - "payment_method_data.bacs_debit.account_number": "string", - "payment_method_data.bacs_debit.sort_code": "string", - "payment_method_data.billing_details.email": "string", - "payment_method_data.billing_details.name": "string", - "payment_method_data.billing_details.phone": "string", - "payment_method_data.boleto.tax_id": "string", - "payment_method_data.eps.bank": "string", - "payment_method_data.fpx.account_holder_type": "string", - "payment_method_data.fpx.bank": "string", - "payment_method_data.ideal.bank": "string", - "payment_method_data.klarna.dob.day": "integer", - "payment_method_data.klarna.dob.month": "integer", - "payment_method_data.klarna.dob.year": "integer", - "payment_method_data.p24.bank": "string", - "payment_method_data.radar_options.session": "string", - "payment_method_data.sepa_debit.iban": "string", - "payment_method_data.sofort.country": "string", - "payment_method_data.type": "string", - "payment_method_data.us_bank_account.account_holder_type": "string", - "payment_method_data.us_bank_account.account_number": "string", - "payment_method_data.us_bank_account.account_type": "string", - "payment_method_data.us_bank_account.financial_connections_account": "string", - "payment_method_data.us_bank_account.routing_number": "string", - "payment_method_options.acss_debit.currency": "string", - "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", - "payment_method_options.acss_debit.mandate_options.default_for": "array", - "payment_method_options.acss_debit.mandate_options.interval_description": "string", - "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", - "payment_method_options.acss_debit.mandate_options.transaction_type": "string", - "payment_method_options.acss_debit.verification_method": "string", - "payment_method_options.card.mandate_options.amount": "integer", - "payment_method_options.card.mandate_options.amount_type": "string", - "payment_method_options.card.mandate_options.currency": "string", - "payment_method_options.card.mandate_options.description": "string", - "payment_method_options.card.mandate_options.end_date": "integer", - "payment_method_options.card.mandate_options.interval": "string", - "payment_method_options.card.mandate_options.interval_count": "integer", - "payment_method_options.card.mandate_options.reference": "string", - "payment_method_options.card.mandate_options.start_date": "integer", - "payment_method_options.card.mandate_options.supported_types": "array", - "payment_method_options.card.moto": "boolean", - "payment_method_options.card.network": "string", - "payment_method_options.card.request_three_d_secure": "string", - "payment_method_options.card.three_d_secure.ares_trans_status": "string", - "payment_method_options.card.three_d_secure.cryptogram": "string", - "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", - "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", - "payment_method_options.card.three_d_secure.transaction_id": "string", - "payment_method_options.card.three_d_secure.version": "string", - "payment_method_options.link.persistent_token": "string", - "payment_method_options.paypal.billing_agreement_id": "string", - "payment_method_options.us_bank_account.financial_connections.permissions": "array", - "payment_method_options.us_bank_account.financial_connections.prefetch": "array", - "payment_method_options.us_bank_account.financial_connections.return_url": "string", - "payment_method_options.us_bank_account.mandate_options.collection_method": "string", - "payment_method_options.us_bank_account.networks.requested": "array", - "payment_method_options.us_bank_account.verification_method": "string", - "payment_method_types": "array", - "return_url": "string", - "single_use.amount": "integer", - "single_use.currency": "string", - "usage": "string", - "use_stripe_sdk": "boolean", + "payment_method_data.acss_debit.account_number": "string", + "payment_method_data.acss_debit.institution_number": "string", + "payment_method_data.acss_debit.transit_number": "string", + "payment_method_data.allow_redisplay": "string", + "payment_method_data.au_becs_debit.account_number": "string", + "payment_method_data.au_becs_debit.bsb_number": "string", + "payment_method_data.bacs_debit.account_number": "string", + "payment_method_data.bacs_debit.sort_code": "string", + "payment_method_data.billing_details.email": "string", + "payment_method_data.billing_details.name": "string", + "payment_method_data.billing_details.phone": "string", + "payment_method_data.boleto.tax_id": "string", + "payment_method_data.eps.bank": "string", + "payment_method_data.fpx.account_holder_type": "string", + "payment_method_data.fpx.bank": "string", + "payment_method_data.ideal.bank": "string", + "payment_method_data.klarna.dob.day": "integer", + "payment_method_data.klarna.dob.month": "integer", + "payment_method_data.klarna.dob.year": "integer", + "payment_method_data.p24.bank": "string", + "payment_method_data.radar_options.session": "string", + "payment_method_data.sepa_debit.iban": "string", + "payment_method_data.sofort.country": "string", + "payment_method_data.type": "string", + "payment_method_data.us_bank_account.account_holder_type": "string", + "payment_method_data.us_bank_account.account_number": "string", + "payment_method_data.us_bank_account.account_type": "string", + "payment_method_data.us_bank_account.financial_connections_account": "string", + "payment_method_data.us_bank_account.routing_number": "string", + "payment_method_options.acss_debit.currency": "string", + "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", + "payment_method_options.acss_debit.mandate_options.default_for": "array", + "payment_method_options.acss_debit.mandate_options.interval_description": "string", + "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", + "payment_method_options.acss_debit.mandate_options.transaction_type": "string", + "payment_method_options.acss_debit.verification_method": "string", + "payment_method_options.card.mandate_options.amount": "integer", + "payment_method_options.card.mandate_options.amount_type": "string", + "payment_method_options.card.mandate_options.currency": "string", + "payment_method_options.card.mandate_options.description": "string", + "payment_method_options.card.mandate_options.end_date": "integer", + "payment_method_options.card.mandate_options.interval": "string", + "payment_method_options.card.mandate_options.interval_count": "integer", + "payment_method_options.card.mandate_options.reference": "string", + "payment_method_options.card.mandate_options.start_date": "integer", + "payment_method_options.card.mandate_options.supported_types": "array", + "payment_method_options.card.moto": "boolean", + "payment_method_options.card.network": "string", + "payment_method_options.card.request_three_d_secure": "string", + "payment_method_options.card.three_d_secure.ares_trans_status": "string", + "payment_method_options.card.three_d_secure.cryptogram": "string", + "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", + "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", + "payment_method_options.card.three_d_secure.transaction_id": "string", + "payment_method_options.card.three_d_secure.version": "string", + "payment_method_options.link.persistent_token": "string", + "payment_method_options.paypal.billing_agreement_id": "string", + "payment_method_options.us_bank_account.financial_connections.filters.account_subcategories": "array", + "payment_method_options.us_bank_account.financial_connections.permissions": "array", + "payment_method_options.us_bank_account.financial_connections.prefetch": "array", + "payment_method_options.us_bank_account.financial_connections.return_url": "string", + "payment_method_options.us_bank_account.mandate_options.collection_method": "string", + "payment_method_options.us_bank_account.networks.requested": "array", + "payment_method_options.us_bank_account.verification_method": "string", + "payment_method_types": "array", + "return_url": "string", + "single_use.amount": "integer", + "single_use.currency": "string", + "usage": "string", + "use_stripe_sdk": "boolean", }, &Config) resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "list", "/v1/setup_intents", http.MethodGet, map[string]string{ "attach_to_self": "boolean", @@ -2500,73 +2545,74 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "flow_directions": "array", "payment_method": "string", "payment_method_configuration": "string", - "payment_method_data.acss_debit.account_number": "string", - "payment_method_data.acss_debit.institution_number": "string", - "payment_method_data.acss_debit.transit_number": "string", - "payment_method_data.allow_redisplay": "string", - "payment_method_data.au_becs_debit.account_number": "string", - "payment_method_data.au_becs_debit.bsb_number": "string", - "payment_method_data.bacs_debit.account_number": "string", - "payment_method_data.bacs_debit.sort_code": "string", - "payment_method_data.billing_details.email": "string", - "payment_method_data.billing_details.name": "string", - "payment_method_data.billing_details.phone": "string", - "payment_method_data.boleto.tax_id": "string", - "payment_method_data.eps.bank": "string", - "payment_method_data.fpx.account_holder_type": "string", - "payment_method_data.fpx.bank": "string", - "payment_method_data.ideal.bank": "string", - "payment_method_data.klarna.dob.day": "integer", - "payment_method_data.klarna.dob.month": "integer", - "payment_method_data.klarna.dob.year": "integer", - "payment_method_data.p24.bank": "string", - "payment_method_data.radar_options.session": "string", - "payment_method_data.sepa_debit.iban": "string", - "payment_method_data.sofort.country": "string", - "payment_method_data.type": "string", - "payment_method_data.us_bank_account.account_holder_type": "string", - "payment_method_data.us_bank_account.account_number": "string", - "payment_method_data.us_bank_account.account_type": "string", - "payment_method_data.us_bank_account.financial_connections_account": "string", - "payment_method_data.us_bank_account.routing_number": "string", - "payment_method_options.acss_debit.currency": "string", - "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", - "payment_method_options.acss_debit.mandate_options.default_for": "array", - "payment_method_options.acss_debit.mandate_options.interval_description": "string", - "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", - "payment_method_options.acss_debit.mandate_options.transaction_type": "string", - "payment_method_options.acss_debit.verification_method": "string", - "payment_method_options.card.mandate_options.amount": "integer", - "payment_method_options.card.mandate_options.amount_type": "string", - "payment_method_options.card.mandate_options.currency": "string", - "payment_method_options.card.mandate_options.description": "string", - "payment_method_options.card.mandate_options.end_date": "integer", - "payment_method_options.card.mandate_options.interval": "string", - "payment_method_options.card.mandate_options.interval_count": "integer", - "payment_method_options.card.mandate_options.reference": "string", - "payment_method_options.card.mandate_options.start_date": "integer", - "payment_method_options.card.mandate_options.supported_types": "array", - "payment_method_options.card.moto": "boolean", - "payment_method_options.card.network": "string", - "payment_method_options.card.request_three_d_secure": "string", - "payment_method_options.card.three_d_secure.ares_trans_status": "string", - "payment_method_options.card.three_d_secure.cryptogram": "string", - "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", - "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", - "payment_method_options.card.three_d_secure.transaction_id": "string", - "payment_method_options.card.three_d_secure.version": "string", - "payment_method_options.link.persistent_token": "string", - "payment_method_options.paypal.billing_agreement_id": "string", - "payment_method_options.us_bank_account.financial_connections.permissions": "array", - "payment_method_options.us_bank_account.financial_connections.prefetch": "array", - "payment_method_options.us_bank_account.financial_connections.return_url": "string", - "payment_method_options.us_bank_account.mandate_options.collection_method": "string", - "payment_method_options.us_bank_account.networks.requested": "array", - "payment_method_options.us_bank_account.verification_method": "string", - "payment_method_types": "array", + "payment_method_data.acss_debit.account_number": "string", + "payment_method_data.acss_debit.institution_number": "string", + "payment_method_data.acss_debit.transit_number": "string", + "payment_method_data.allow_redisplay": "string", + "payment_method_data.au_becs_debit.account_number": "string", + "payment_method_data.au_becs_debit.bsb_number": "string", + "payment_method_data.bacs_debit.account_number": "string", + "payment_method_data.bacs_debit.sort_code": "string", + "payment_method_data.billing_details.email": "string", + "payment_method_data.billing_details.name": "string", + "payment_method_data.billing_details.phone": "string", + "payment_method_data.boleto.tax_id": "string", + "payment_method_data.eps.bank": "string", + "payment_method_data.fpx.account_holder_type": "string", + "payment_method_data.fpx.bank": "string", + "payment_method_data.ideal.bank": "string", + "payment_method_data.klarna.dob.day": "integer", + "payment_method_data.klarna.dob.month": "integer", + "payment_method_data.klarna.dob.year": "integer", + "payment_method_data.p24.bank": "string", + "payment_method_data.radar_options.session": "string", + "payment_method_data.sepa_debit.iban": "string", + "payment_method_data.sofort.country": "string", + "payment_method_data.type": "string", + "payment_method_data.us_bank_account.account_holder_type": "string", + "payment_method_data.us_bank_account.account_number": "string", + "payment_method_data.us_bank_account.account_type": "string", + "payment_method_data.us_bank_account.financial_connections_account": "string", + "payment_method_data.us_bank_account.routing_number": "string", + "payment_method_options.acss_debit.currency": "string", + "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", + "payment_method_options.acss_debit.mandate_options.default_for": "array", + "payment_method_options.acss_debit.mandate_options.interval_description": "string", + "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", + "payment_method_options.acss_debit.mandate_options.transaction_type": "string", + "payment_method_options.acss_debit.verification_method": "string", + "payment_method_options.card.mandate_options.amount": "integer", + "payment_method_options.card.mandate_options.amount_type": "string", + "payment_method_options.card.mandate_options.currency": "string", + "payment_method_options.card.mandate_options.description": "string", + "payment_method_options.card.mandate_options.end_date": "integer", + "payment_method_options.card.mandate_options.interval": "string", + "payment_method_options.card.mandate_options.interval_count": "integer", + "payment_method_options.card.mandate_options.reference": "string", + "payment_method_options.card.mandate_options.start_date": "integer", + "payment_method_options.card.mandate_options.supported_types": "array", + "payment_method_options.card.moto": "boolean", + "payment_method_options.card.network": "string", + "payment_method_options.card.request_three_d_secure": "string", + "payment_method_options.card.three_d_secure.ares_trans_status": "string", + "payment_method_options.card.three_d_secure.cryptogram": "string", + "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", + "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", + "payment_method_options.card.three_d_secure.transaction_id": "string", + "payment_method_options.card.three_d_secure.version": "string", + "payment_method_options.link.persistent_token": "string", + "payment_method_options.paypal.billing_agreement_id": "string", + "payment_method_options.us_bank_account.financial_connections.filters.account_subcategories": "array", + "payment_method_options.us_bank_account.financial_connections.permissions": "array", + "payment_method_options.us_bank_account.financial_connections.prefetch": "array", + "payment_method_options.us_bank_account.financial_connections.return_url": "string", + "payment_method_options.us_bank_account.mandate_options.collection_method": "string", + "payment_method_options.us_bank_account.networks.requested": "array", + "payment_method_options.us_bank_account.verification_method": "string", + "payment_method_types": "array", }, &Config) resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "verify_microdeposits", "/v1/setup_intents/{intent}/verify_microdeposits", http.MethodPost, map[string]string{ "amounts": "array", @@ -3206,6 +3252,58 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "limit": "integer", "starting_after": "string", }, &Config) + resource.NewOperationCmd(rBillingAlertsCmd.Cmd, "activate", "/v1/billing/alerts/{id}/activate", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rBillingAlertsCmd.Cmd, "archive", "/v1/billing/alerts/{id}/archive", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rBillingAlertsCmd.Cmd, "create", "/v1/billing/alerts", http.MethodPost, map[string]string{ + "alert_type": "string", + "title": "string", + "usage_threshold.gte": "integer", + "usage_threshold.meter": "string", + "usage_threshold.recurrence": "string", + }, &Config) + resource.NewOperationCmd(rBillingAlertsCmd.Cmd, "deactivate", "/v1/billing/alerts/{id}/deactivate", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rBillingAlertsCmd.Cmd, "list", "/v1/billing/alerts", http.MethodGet, map[string]string{ + "alert_type": "string", + "ending_before": "string", + "limit": "integer", + "meter": "string", + "starting_after": "string", + }, &Config) + resource.NewOperationCmd(rBillingAlertsCmd.Cmd, "retrieve", "/v1/billing/alerts/{id}", http.MethodGet, map[string]string{}, &Config) + resource.NewOperationCmd(rBillingCreditBalanceSummarysCmd.Cmd, "retrieve", "/v1/billing/credit_balance_summary", http.MethodGet, map[string]string{ + "customer": "string", + }, &Config) + resource.NewOperationCmd(rBillingCreditBalanceTransactionsCmd.Cmd, "list", "/v1/billing/credit_balance_transactions", http.MethodGet, map[string]string{ + "credit_grant": "string", + "customer": "string", + "ending_before": "string", + "limit": "integer", + "starting_after": "string", + }, &Config) + resource.NewOperationCmd(rBillingCreditBalanceTransactionsCmd.Cmd, "retrieve", "/v1/billing/credit_balance_transactions/{id}", http.MethodGet, map[string]string{}, &Config) + resource.NewOperationCmd(rBillingCreditGrantsCmd.Cmd, "create", "/v1/billing/credit_grants", http.MethodPost, map[string]string{ + "amount.monetary.currency": "string", + "amount.monetary.value": "integer", + "amount.type": "string", + "applicability_config.scope.price_type": "string", + "category": "string", + "customer": "string", + "effective_at": "integer", + "expires_at": "integer", + "name": "string", + }, &Config) + resource.NewOperationCmd(rBillingCreditGrantsCmd.Cmd, "expire", "/v1/billing/credit_grants/{id}/expire", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rBillingCreditGrantsCmd.Cmd, "list", "/v1/billing/credit_grants", http.MethodGet, map[string]string{ + "customer": "string", + "ending_before": "string", + "limit": "integer", + "starting_after": "string", + }, &Config) + resource.NewOperationCmd(rBillingCreditGrantsCmd.Cmd, "retrieve", "/v1/billing/credit_grants/{id}", http.MethodGet, map[string]string{}, &Config) + resource.NewOperationCmd(rBillingCreditGrantsCmd.Cmd, "update", "/v1/billing/credit_grants/{id}", http.MethodPost, map[string]string{ + "expires_at": "integer", + }, &Config) + resource.NewOperationCmd(rBillingCreditGrantsCmd.Cmd, "void_grant", "/v1/billing/credit_grants/{id}/void", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rBillingMeterEventAdjustmentsCmd.Cmd, "create", "/v1/billing/meter_event_adjustments", http.MethodPost, map[string]string{ "cancel.identifier": "string", "event_name": "string", @@ -3446,9 +3544,10 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "subscription_data.trial_end": "integer", "subscription_data.trial_period_days": "integer", "subscription_data.trial_settings.end_behavior.missing_payment_method": "string", - "success_url": "string", - "tax_id_collection.enabled": "boolean", - "ui_mode": "string", + "success_url": "string", + "tax_id_collection.enabled": "boolean", + "tax_id_collection.required": "string", + "ui_mode": "string", }, &Config) resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "expire", "/v1/checkout/sessions/{session}/expire", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "list", "/v1/checkout/sessions", http.MethodGet, map[string]string{ @@ -3468,6 +3567,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "starting_after": "string", }, &Config) resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "retrieve", "/v1/checkout/sessions/{session}", http.MethodGet, map[string]string{}, &Config) + resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "update", "/v1/checkout/sessions/{session}", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "cancel", "/v1/climate/orders/{order}/cancel", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "create", "/v1/climate/orders", http.MethodPost, map[string]string{ "amount": "integer", @@ -3542,13 +3642,14 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "features": "array", }, &Config) resource.NewOperationCmd(rFinancialConnectionsSessionsCmd.Cmd, "create", "/v1/financial_connections/sessions", http.MethodPost, map[string]string{ - "account_holder.account": "string", - "account_holder.customer": "string", - "account_holder.type": "string", - "filters.countries": "array", - "permissions": "array", - "prefetch": "array", - "return_url": "string", + "account_holder.account": "string", + "account_holder.customer": "string", + "account_holder.type": "string", + "filters.account_subcategories": "array", + "filters.countries": "array", + "permissions": "array", + "prefetch": "array", + "return_url": "string", }, &Config) resource.NewOperationCmd(rFinancialConnectionsSessionsCmd.Cmd, "retrieve", "/v1/financial_connections/sessions/{session}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rFinancialConnectionsTransactionsCmd.Cmd, "list", "/v1/financial_connections/transactions", http.MethodGet, map[string]string{ @@ -3586,6 +3687,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "client_reference_id": "string", "provided_details.email": "string", "provided_details.phone": "string", + "related_customer": "string", "return_url": "string", "type": "string", "verification_flow": "string", @@ -3595,6 +3697,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "created": "integer", "ending_before": "string", "limit": "integer", + "related_customer": "string", "starting_after": "string", "status": "string", }, &Config) @@ -3617,48 +3720,95 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rIssuingAuthorizationsCmd.Cmd, "retrieve", "/v1/issuing/authorizations/{authorization}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingAuthorizationsCmd.Cmd, "update", "/v1/issuing/authorizations/{authorization}", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "capture", "/v1/test_helpers/issuing/authorizations/{authorization}/capture", http.MethodPost, map[string]string{ - "capture_amount": "integer", - "close_authorization": "boolean", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "capture_amount": "integer", + "close_authorization": "boolean", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "create", "/v1/test_helpers/issuing/authorizations", http.MethodPost, map[string]string{ - "amount": "integer", - "amount_details.atm_fee": "integer", - "amount_details.cashback_amount": "integer", - "authorization_method": "string", - "card": "string", - "currency": "string", - "is_amount_controllable": "boolean", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "network_data.acquiring_institution_id": "string", - "verification_data.address_line1_check": "string", - "verification_data.address_postal_code_check": "string", - "verification_data.authentication_exemption.claimed_by": "string", - "verification_data.authentication_exemption.type": "string", - "verification_data.cvc_check": "string", - "verification_data.expiry_check": "string", - "verification_data.three_d_secure.result": "string", + "amount": "integer", + "amount_details.atm_fee": "integer", + "amount_details.cashback_amount": "integer", + "authorization_method": "string", + "card": "string", + "currency": "string", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + "is_amount_controllable": "boolean", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "network_data.acquiring_institution_id": "string", + "verification_data.address_line1_check": "string", + "verification_data.address_postal_code_check": "string", + "verification_data.authentication_exemption.claimed_by": "string", + "verification_data.authentication_exemption.type": "string", + "verification_data.cvc_check": "string", + "verification_data.expiry_check": "string", + "verification_data.three_d_secure.result": "string", "wallet": "string", }, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "expire", "/v1/test_helpers/issuing/authorizations/{authorization}/expire", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "finalize_amount", "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount", http.MethodPost, map[string]string{ + "final_amount": "integer", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + }, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "increment", "/v1/test_helpers/issuing/authorizations/{authorization}/increment", http.MethodPost, map[string]string{ "increment_amount": "integer", "is_amount_controllable": "boolean", @@ -3750,6 +3900,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "shipping.address.line2": "string", "shipping.address.postal_code": "string", "shipping.address.state": "string", + "shipping.address_validation.mode": "string", "shipping.customs.eori_number": "string", "shipping.name": "string", "shipping.phone_number": "string", @@ -3781,6 +3932,19 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "cancellation_reason": "string", "personalization_design": "string", "pin.encrypted_number": "string", + "shipping.address.city": "string", + "shipping.address.country": "string", + "shipping.address.line1": "string", + "shipping.address.line2": "string", + "shipping.address.postal_code": "string", + "shipping.address.state": "string", + "shipping.address_validation.mode": "string", + "shipping.customs.eori_number": "string", + "shipping.name": "string", + "shipping.phone_number": "string", + "shipping.require_signature": "boolean", + "shipping.service": "string", + "shipping.type": "string", "spending_controls.allowed_categories": "array", "spending_controls.allowed_merchant_countries": "array", "spending_controls.blocked_categories": "array", @@ -3877,54 +4041,78 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rIssuingTransactionsCmd.Cmd, "retrieve", "/v1/issuing/transactions/{transaction}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingTransactionsCmd.Cmd, "update", "/v1/issuing/transactions/{transaction}", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "create_force_capture", "/v1/test_helpers/issuing/transactions/create_force_capture", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "create_unlinked_refund", "/v1/test_helpers/issuing/transactions/create_unlinked_refund", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "refund", "/v1/test_helpers/issuing/transactions/{transaction}/refund", http.MethodPost, map[string]string{ "refund_amount": "integer", @@ -4020,6 +4208,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "limit": "integer", "starting_after": "string", }, &Config) + resource.NewOperationCmd(rTaxCalculationsCmd.Cmd, "retrieve", "/v1/tax/calculations/{calculation}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rTaxRegistrationsCmd.Cmd, "create", "/v1/tax/registrations", http.MethodPost, map[string]string{ "active_from": "string", "country": "string", @@ -4136,6 +4325,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { }, &Config) resource.NewOperationCmd(rTaxTransactionsCmd.Cmd, "create_from_calculation", "/v1/tax/transactions/create_from_calculation", http.MethodPost, map[string]string{ "calculation": "string", + "posted_at": "integer", "reference": "string", }, &Config) resource.NewOperationCmd(rTaxTransactionsCmd.Cmd, "create_reversal", "/v1/tax/transactions/create_reversal", http.MethodPost, map[string]string{ @@ -4155,6 +4345,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rTerminalConfigurationsCmd.Cmd, "create", "/v1/terminal/configurations", http.MethodPost, map[string]string{ "bbpos_wisepos_e.splashscreen": "string", "name": "string", + "reboot_window.end_hour": "integer", + "reboot_window.start_hour": "integer", "stripe_s700.splashscreen": "string", "verifone_p400.splashscreen": "string", }, &Config) @@ -4216,13 +4408,14 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "status": "string", }, &Config) resource.NewOperationCmd(rTerminalReadersCmd.Cmd, "process_payment_intent", "/v1/terminal/readers/{reader}/process_payment_intent", http.MethodPost, map[string]string{ - "payment_intent": "string", + "payment_intent": "string", + "process_config.allow_redisplay": "string", "process_config.enable_customer_cancellation": "boolean", "process_config.skip_tipping": "boolean", "process_config.tipping.amount_eligible": "integer", }, &Config) resource.NewOperationCmd(rTerminalReadersCmd.Cmd, "process_setup_intent", "/v1/terminal/readers/{reader}/process_setup_intent", http.MethodPost, map[string]string{ - "customer_consent_collected": "boolean", + "allow_redisplay": "string", "process_config.enable_customer_cancellation": "boolean", "setup_intent": "string", }, &Config) @@ -4298,48 +4491,95 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "capture", "/v1/test_helpers/issuing/authorizations/{authorization}/capture", http.MethodPost, map[string]string{ - "capture_amount": "integer", - "close_authorization": "boolean", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "capture_amount": "integer", + "close_authorization": "boolean", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "create", "/v1/test_helpers/issuing/authorizations", http.MethodPost, map[string]string{ - "amount": "integer", - "amount_details.atm_fee": "integer", - "amount_details.cashback_amount": "integer", - "authorization_method": "string", - "card": "string", - "currency": "string", - "is_amount_controllable": "boolean", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "network_data.acquiring_institution_id": "string", - "verification_data.address_line1_check": "string", - "verification_data.address_postal_code_check": "string", - "verification_data.authentication_exemption.claimed_by": "string", - "verification_data.authentication_exemption.type": "string", - "verification_data.cvc_check": "string", - "verification_data.expiry_check": "string", - "verification_data.three_d_secure.result": "string", + "amount": "integer", + "amount_details.atm_fee": "integer", + "amount_details.cashback_amount": "integer", + "authorization_method": "string", + "card": "string", + "currency": "string", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + "is_amount_controllable": "boolean", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "network_data.acquiring_institution_id": "string", + "verification_data.address_line1_check": "string", + "verification_data.address_postal_code_check": "string", + "verification_data.authentication_exemption.claimed_by": "string", + "verification_data.authentication_exemption.type": "string", + "verification_data.cvc_check": "string", + "verification_data.expiry_check": "string", + "verification_data.three_d_secure.result": "string", "wallet": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "expire", "/v1/test_helpers/issuing/authorizations/{authorization}/expire", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "finalize_amount", "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount", http.MethodPost, map[string]string{ + "final_amount": "integer", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "increment", "/v1/test_helpers/issuing/authorizations/{authorization}/increment", http.MethodPost, map[string]string{ "increment_amount": "integer", "is_amount_controllable": "boolean", @@ -4358,54 +4598,78 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "rejection_reasons.carrier_text": "array", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "create_force_capture", "/v1/test_helpers/issuing/transactions/create_force_capture", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "create_unlinked_refund", "/v1/test_helpers/issuing/transactions/create_unlinked_refund", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "refund", "/v1/test_helpers/issuing/transactions/{transaction}/refund", http.MethodPost, map[string]string{ "refund_amount": "integer", @@ -4442,10 +4706,11 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "returned_details.code": "string", }, &Config) resource.NewOperationCmd(rTestHelpersTreasuryOutboundPaymentsCmd.Cmd, "update", "/v1/test_helpers/treasury/outbound_payments/{id}", http.MethodPost, map[string]string{ - "tracking_details.ach.trace_id": "string", - "tracking_details.type": "string", - "tracking_details.us_domestic_wire.imad": "string", - "tracking_details.us_domestic_wire.omad": "string", + "tracking_details.ach.trace_id": "string", + "tracking_details.type": "string", + "tracking_details.us_domestic_wire.chips": "string", + "tracking_details.us_domestic_wire.imad": "string", + "tracking_details.us_domestic_wire.omad": "string", }, &Config) resource.NewOperationCmd(rTestHelpersTreasuryOutboundTransfersCmd.Cmd, "fail", "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rTestHelpersTreasuryOutboundTransfersCmd.Cmd, "post", "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post", http.MethodPost, map[string]string{}, &Config) @@ -4453,10 +4718,11 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "returned_details.code": "string", }, &Config) resource.NewOperationCmd(rTestHelpersTreasuryOutboundTransfersCmd.Cmd, "update", "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}", http.MethodPost, map[string]string{ - "tracking_details.ach.trace_id": "string", - "tracking_details.type": "string", - "tracking_details.us_domestic_wire.imad": "string", - "tracking_details.us_domestic_wire.omad": "string", + "tracking_details.ach.trace_id": "string", + "tracking_details.type": "string", + "tracking_details.us_domestic_wire.chips": "string", + "tracking_details.us_domestic_wire.imad": "string", + "tracking_details.us_domestic_wire.omad": "string", }, &Config) resource.NewOperationCmd(rTestHelpersTreasuryReceivedCreditsCmd.Cmd, "create", "/v1/test_helpers/treasury/received_credits", http.MethodPost, map[string]string{ "amount": "integer", @@ -4611,10 +4877,11 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "returned_details.code": "string", }, &Config) resource.NewOperationCmd(rTreasuryOutboundPaymentsTestHelpersCmd.Cmd, "update", "/v1/test_helpers/treasury/outbound_payments/{id}", http.MethodPost, map[string]string{ - "tracking_details.ach.trace_id": "string", - "tracking_details.type": "string", - "tracking_details.us_domestic_wire.imad": "string", - "tracking_details.us_domestic_wire.omad": "string", + "tracking_details.ach.trace_id": "string", + "tracking_details.type": "string", + "tracking_details.us_domestic_wire.chips": "string", + "tracking_details.us_domestic_wire.imad": "string", + "tracking_details.us_domestic_wire.omad": "string", }, &Config) resource.NewOperationCmd(rTreasuryOutboundTransfersCmd.Cmd, "cancel", "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rTreasuryOutboundTransfersCmd.Cmd, "create", "/v1/treasury/outbound_transfers", http.MethodPost, map[string]string{ @@ -4639,10 +4906,11 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "returned_details.code": "string", }, &Config) resource.NewOperationCmd(rTreasuryOutboundTransfersTestHelpersCmd.Cmd, "update", "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}", http.MethodPost, map[string]string{ - "tracking_details.ach.trace_id": "string", - "tracking_details.type": "string", - "tracking_details.us_domestic_wire.imad": "string", - "tracking_details.us_domestic_wire.omad": "string", + "tracking_details.ach.trace_id": "string", + "tracking_details.type": "string", + "tracking_details.us_domestic_wire.chips": "string", + "tracking_details.us_domestic_wire.imad": "string", + "tracking_details.us_domestic_wire.omad": "string", }, &Config) resource.NewOperationCmd(rTreasuryReceivedCreditsCmd.Cmd, "list", "/v1/treasury/received_credits", http.MethodGet, map[string]string{ "ending_before": "string", diff --git a/pkg/proxy/events_list.go b/pkg/proxy/events_list.go index 7c28a915..3a9ed70c 100644 --- a/pkg/proxy/events_list.go +++ b/pkg/proxy/events_list.go @@ -14,6 +14,7 @@ var validEvents = map[string]bool{ "application_fee.refund.updated": true, "application_fee.refunded": true, "balance.available": true, + "billing.alert.triggered": true, "billing_portal.configuration.created": true, "billing_portal.configuration.updated": true, "billing_portal.session.created": true, @@ -91,6 +92,7 @@ var validEvents = map[string]bool{ "invoice.finalization_failed": true, "invoice.finalized": true, "invoice.marked_uncollectible": true, + "invoice.overdue": true, "invoice.paid": true, "invoice.payment_action_required": true, "invoice.payment_failed": true, @@ -99,6 +101,7 @@ var validEvents = map[string]bool{ "invoice.upcoming": true, "invoice.updated": true, "invoice.voided": true, + "invoice.will_be_due": true, "invoiceitem.created": true, "invoiceitem.deleted": true, "issuing_authorization.created": true, @@ -111,6 +114,7 @@ var validEvents = map[string]bool{ "issuing_dispute.closed": true, "issuing_dispute.created": true, "issuing_dispute.funds_reinstated": true, + "issuing_dispute.funds_rescinded": true, "issuing_dispute.submitted": true, "issuing_dispute.updated": true, "issuing_personalization_design.activated": true,