From 13a948cd2d9313ee817db78b394be50bdf596f7c Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Thu, 12 Dec 2024 10:40:16 -0800 Subject: [PATCH] Update OpenAPI for 92c1e753bf35cfbe0c2b8cf1525224b1e78f2657 (#1276) Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- api/openapi-spec/spec3.sdk.json | 1530 +++++++++++++++++++++++++++---- pkg/cmd/resources_cmds.go | 9 + 2 files changed, 1360 insertions(+), 179 deletions(-) diff --git a/api/openapi-spec/spec3.sdk.json b/api/openapi-spec/spec3.sdk.json index e89739c7..a9094e19 100644 --- a/api/openapi-spec/spec3.sdk.json +++ b/api/openapi-spec/spec3.sdk.json @@ -417,6 +417,7 @@ }, "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).", + "format": "currency", "nullable": true, "type": "string" }, @@ -1200,7 +1201,7 @@ "type": "array" }, "current_deadline": { - "description": "Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.", + "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.", "format": "unix-time", "nullable": true, "type": "integer" @@ -1512,7 +1513,7 @@ "type": "array" }, "current_deadline": { - "description": "Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.", + "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.", "format": "unix-time", "nullable": true, "type": "integer" @@ -1733,6 +1734,7 @@ }, "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).", + "format": "currency", "type": "string" } }, @@ -2523,6 +2525,34 @@ "in_package": "" } }, + "amazon_pay_underlying_payment_method_funding_details": { + "description": "", + "properties": { + "card": { + "$ref": "#/components/schemas/payment_method_details_passthrough_card" + }, + "type": { + "description": "funding type of the underlying payment method.", + "enum": [ + "card" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "amazon_pay_underlying_payment_method_funding_details", + "type": "object", + "x-expandableFields": [ + "card" + ], + "x-stripeMostCommon": [ + "card", + "type" + ] + }, "api_errors": { "description": "", "properties": { @@ -2725,6 +2755,16 @@ "maxLength": 40000, "type": "string" }, + "network_advice_code": { + "description": "For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.", + "maxLength": 5000, + "type": "string" + }, + "network_decline_code": { + "description": "For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.", + "maxLength": 5000, + "type": "string" + }, "param": { "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.", "maxLength": 5000, @@ -3005,6 +3045,7 @@ }, "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).", + "format": "currency", "type": "string" }, "fee_source": { @@ -3335,6 +3376,15 @@ "automatic_tax": { "description": "", "properties": { + "disabled_reason": { + "description": "If Stripe disabled automatic tax, this enum describes why.", + "enum": [ + "finalization_requires_location_inputs", + "finalization_system_error" + ], + "nullable": true, + "type": "string" + }, "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" @@ -3360,6 +3410,7 @@ } }, "required": [ + "disabled_reason", "enabled", "liability", "status" @@ -3370,6 +3421,7 @@ "liability" ], "x-stripeMostCommon": [ + "disabled_reason", "enabled", "liability", "status" @@ -3480,6 +3532,7 @@ }, "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).", + "format": "currency", "type": "string" }, "source_types": { @@ -3535,6 +3588,7 @@ }, "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).", + "format": "currency", "type": "string" }, "net_available": { @@ -3638,6 +3692,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -3709,7 +3764,7 @@ "type": "string" }, "type": { - "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.", + "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.", "enum": [ "adjustment", "advance", @@ -3738,6 +3793,8 @@ "payout", "payout_cancel", "payout_failure", + "payout_minimum_balance_hold", + "payout_minimum_balance_release", "refund", "refund_failure", "reserve_transaction", @@ -3936,6 +3993,7 @@ }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", + "format": "currency", "type": "string" }, "customer": { @@ -4941,7 +4999,7 @@ } }, "effective_at": { - "description": "The time when the billing credits become effective—when they're eligible for use.", + "description": "The time when the billing credits become effective-when they're eligible for use.", "format": "unix-time", "nullable": true, "type": "integer" @@ -5108,7 +5166,7 @@ } }, "billing.meter": { - "description": "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)", + "description": "Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -5266,7 +5324,7 @@ } }, "billing.meter_event": { - "description": "A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.\nMeter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.", + "description": "Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -5594,9 +5652,19 @@ "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" }, + "credits_application_invoice_voided": { + "anyOf": [ + { + "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_application_invoice_voided" + } + ], + "description": "Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.", + "nullable": true + }, "type": { "description": "The type of credit transaction.", "enum": [ + "credits_application_invoice_voided", "credits_granted" ], "type": "string" @@ -5609,13 +5677,57 @@ "title": "BillingCreditGrantsResourceBalanceCredit", "type": "object", "x-expandableFields": [ - "amount" + "amount", + "credits_application_invoice_voided" ], "x-stripeMostCommon": [ "amount", + "credits_application_invoice_voided", "type" ] }, + "billing_credit_grants_resource_balance_credits_application_invoice_voided": { + "description": "", + "properties": { + "invoice": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/invoice" + } + ], + "description": "The invoice to which the reinstated billing credits were originally applied.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/invoice" + } + ] + } + }, + "invoice_line_item": { + "description": "The invoice line item to which the reinstated billing credits were originally applied.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "invoice", + "invoice_line_item" + ], + "title": "BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided", + "type": "object", + "x-expandableFields": [ + "invoice" + ], + "x-stripeMostCommon": [ + "invoice", + "invoice_line_item" + ] + }, "billing_credit_grants_resource_balance_credits_applied": { "description": "", "properties": { @@ -5729,7 +5841,7 @@ "description": "", "properties": { "price_type": { - "description": "The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.", + "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.", "enum": [ "metered" ], @@ -6580,6 +6692,7 @@ }, "currency": { "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", + "format": "currency", "nullable": true, "type": "string" }, @@ -6695,6 +6808,15 @@ ], "type": "string" }, + "regulated_status": { + "description": "Status of a card based on the card issuer.", + "enum": [ + "regulated", + "unregulated" + ], + "nullable": true, + "type": "string" + }, "status": { "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.", "maxLength": 5000, @@ -7059,6 +7181,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -7728,7 +7851,7 @@ } }, "charge.refund.updated": { - "description": "Occurs whenever a refund is updated, on selected payment methods.", + "description": "Occurs whenever a refund is updated on selected payment methods. For updates on all refunds, listen to `refund.updated` instead.", "properties": { "object": { "$ref": "#/components/schemas/refund" @@ -7744,7 +7867,7 @@ } }, "charge.refunded": { - "description": "Occurs whenever a charge is refunded, including partial refunds.", + "description": "Occurs whenever a charge is refunded, including partial refunds. Listen to `refund.created` for information about the refund.", "properties": { "object": { "$ref": "#/components/schemas/charge" @@ -7816,6 +7939,18 @@ "charge_outcome": { "description": "", "properties": { + "network_advice_code": { + "description": "For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "network_decline_code": { + "description": "For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "network_status": { "description": "Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as \"pending\" on a cardholder's statement.", "maxLength": 5000, @@ -7869,6 +8004,8 @@ } }, "required": [ + "network_advice_code", + "network_decline_code", "network_status", "reason", "seller_message", @@ -7880,6 +8017,8 @@ "rule" ], "x-stripeMostCommon": [ + "network_advice_code", + "network_decline_code", "network_status", "reason", "risk_level", @@ -8022,6 +8161,7 @@ }, "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).", + "format": "currency", "nullable": true, "type": "string" }, @@ -9529,10 +9669,19 @@ }, "checkout_payment_method_options_mandate_options_bacs_debit": { "description": "", - "properties": {}, + "properties": { + "reference_prefix": { + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", + "maxLength": 5000, + "type": "string" + } + }, "title": "checkout_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference_prefix" + ], "x-stripeResource": { "class_name": "BacsDebitMandateOptions", "in_package": "" @@ -9540,10 +9689,19 @@ }, "checkout_payment_method_options_mandate_options_sepa_debit": { "description": "", - "properties": {}, + "properties": { + "reference_prefix": { + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", + "maxLength": 5000, + "type": "string" + } + }, "title": "checkout_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference_prefix" + ], "x-stripeResource": { "class_name": "SepaDebitMandateOptions", "in_package": "" @@ -11324,6 +11482,7 @@ }, "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).", + "format": "currency", "type": "string" }, "destination": { @@ -11424,7 +11583,7 @@ "description": "", "properties": { "disable_stripe_user_authentication": { - "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.", "type": "boolean" }, "external_account_collection": { @@ -11673,7 +11832,7 @@ "description": "", "properties": { "disable_stripe_user_authentication": { - "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.", "type": "boolean" }, "edit_payout_schedule": { @@ -11895,6 +12054,7 @@ }, "currency": { "description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.", + "format": "currency", "nullable": true, "type": "string" }, @@ -12188,6 +12348,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -14392,6 +14553,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -16582,6 +16744,7 @@ }, "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).", + "format": "currency", "type": "string" }, "enhanced_eligibility_types": { @@ -16761,15 +16924,20 @@ "properties": { "visa_compelling_evidence_3": { "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3" + }, + "visa_compliance": { + "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compliance" } }, "title": "DisputeEnhancedEligibility", "type": "object", "x-expandableFields": [ - "visa_compelling_evidence_3" + "visa_compelling_evidence_3", + "visa_compliance" ], "x-stripeMostCommon": [ - "visa_compelling_evidence_3" + "visa_compelling_evidence_3", + "visa_compliance" ] }, "dispute_enhanced_eligibility_visa_compelling_evidence3": { @@ -16811,20 +16979,47 @@ "status" ] }, + "dispute_enhanced_eligibility_visa_compliance": { + "description": "", + "properties": { + "status": { + "description": "Visa Compelling Evidence 3.0 eligibility status.", + "enum": [ + "fee_acknowledged", + "requires_fee_acknowledgement" + ], + "type": "string" + } + }, + "required": [ + "status" + ], + "title": "DisputeEnhancedEligibilityVisaCompliance", + "type": "object", + "x-expandableFields": [], + "x-stripeMostCommon": [ + "status" + ] + }, "dispute_enhanced_evidence": { "description": "", "properties": { "visa_compelling_evidence_3": { "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3" + }, + "visa_compliance": { + "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compliance" } }, "title": "DisputeEnhancedEvidence", "type": "object", "x-expandableFields": [ - "visa_compelling_evidence_3" + "visa_compelling_evidence_3", + "visa_compliance" ], "x-stripeMostCommon": [ - "visa_compelling_evidence_3" + "visa_compelling_evidence_3", + "visa_compliance" ] }, "dispute_enhanced_evidence_visa_compelling_evidence3": { @@ -16862,6 +17057,24 @@ "prior_undisputed_transactions" ] }, + "dispute_enhanced_evidence_visa_compliance": { + "description": "", + "properties": { + "fee_acknowledged": { + "description": "A field acknowledging the fee incurred when countering a Visa Compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute, and you may incur a $500 fee if the case is lost.", + "type": "boolean" + } + }, + "required": [ + "fee_acknowledged" + ], + "title": "DisputeEnhancedEvidenceVisaCompliance", + "type": "object", + "x-expandableFields": [], + "x-stripeMostCommon": [ + "fee_acknowledged" + ] + }, "dispute_evidence": { "description": "", "properties": { @@ -18602,6 +18815,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -18668,6 +18882,7 @@ }, "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).", + "format": "currency", "type": "string" }, "fee": { @@ -19989,6 +20204,7 @@ }, "currency": { "description": "Currency of objects to be included in the report run.", + "format": "currency", "type": "string" }, "interval_end": { @@ -20202,7 +20418,8 @@ "card_cvc", "card_expiry", "card_number", - "cardholder_name" + "cardholder_name", + "request_signature" ], "type": "string" }, @@ -20546,11 +20763,17 @@ "funding_instructions_bank_transfer_iban_record": { "description": "Iban Records contain E.U. bank account details per the SEPA format.", "properties": { + "account_holder_address": { + "$ref": "#/components/schemas/address" + }, "account_holder_name": { "description": "The name of the person or business that owns the bank account", "maxLength": 5000, "type": "string" }, + "bank_address": { + "$ref": "#/components/schemas/address" + }, "bic": { "description": "The BIC/SWIFT code of the account.", "maxLength": 5000, @@ -20568,16 +20791,23 @@ } }, "required": [ + "account_holder_address", "account_holder_name", + "bank_address", "bic", "country", "iban" ], "title": "FundingInstructionsBankTransferIbanRecord", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "account_holder_address", + "bank_address" + ], "x-stripeMostCommon": [ + "account_holder_address", "account_holder_name", + "bank_address", "bic", "country", "iban" @@ -20586,6 +20816,9 @@ "funding_instructions_bank_transfer_sort_code_record": { "description": "Sort Code Records contain U.K. bank account details per the sort code format.", "properties": { + "account_holder_address": { + "$ref": "#/components/schemas/address" + }, "account_holder_name": { "description": "The name of the person or business that owns the bank account", "maxLength": 5000, @@ -20596,6 +20829,9 @@ "maxLength": 5000, "type": "string" }, + "bank_address": { + "$ref": "#/components/schemas/address" + }, "sort_code": { "description": "The six-digit sort code", "maxLength": 5000, @@ -20603,16 +20839,23 @@ } }, "required": [ + "account_holder_address", "account_holder_name", "account_number", + "bank_address", "sort_code" ], "title": "FundingInstructionsBankTransferSortCodeRecord", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "account_holder_address", + "bank_address" + ], "x-stripeMostCommon": [ + "account_holder_address", "account_holder_name", "account_number", + "bank_address", "sort_code" ], "x-stripeResource": { @@ -20623,6 +20866,17 @@ "funding_instructions_bank_transfer_spei_record": { "description": "SPEI Records contain Mexico bank account details per the SPEI format.", "properties": { + "account_holder_address": { + "$ref": "#/components/schemas/address" + }, + "account_holder_name": { + "description": "The account holder name", + "maxLength": 5000, + "type": "string" + }, + "bank_address": { + "$ref": "#/components/schemas/address" + }, "bank_code": { "description": "The three-digit bank code", "maxLength": 5000, @@ -20640,14 +20894,23 @@ } }, "required": [ + "account_holder_address", + "account_holder_name", + "bank_address", "bank_code", "bank_name", "clabe" ], "title": "FundingInstructionsBankTransferSpeiRecord", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "account_holder_address", + "bank_address" + ], "x-stripeMostCommon": [ + "account_holder_address", + "account_holder_name", + "bank_address", "bank_code", "bank_name", "clabe" @@ -20716,6 +20979,9 @@ "funding_instructions_bank_transfer_zengin_record": { "description": "Zengin Records contain Japan bank account details per the Zengin format.", "properties": { + "account_holder_address": { + "$ref": "#/components/schemas/address" + }, "account_holder_name": { "description": "The account holder name", "maxLength": 5000, @@ -20734,6 +21000,9 @@ "nullable": true, "type": "string" }, + "bank_address": { + "$ref": "#/components/schemas/address" + }, "bank_code": { "description": "The bank code of the account", "maxLength": 5000, @@ -20760,9 +21029,11 @@ } }, "required": [ + "account_holder_address", "account_holder_name", "account_number", "account_type", + "bank_address", "bank_code", "bank_name", "branch_code", @@ -20770,11 +21041,16 @@ ], "title": "FundingInstructionsBankTransferZenginRecord", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "account_holder_address", + "bank_address" + ], "x-stripeMostCommon": [ + "account_holder_address", "account_holder_name", "account_number", "account_type", + "bank_address", "bank_code", "bank_name", "branch_code", @@ -22611,6 +22887,7 @@ }, "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).", + "format": "currency", "type": "string" }, "custom_fields": { @@ -23335,6 +23612,7 @@ "x-resourceId": "invoice", "x-stripeMostCommon": [ "auto_advance", + "automatic_tax", "charge", "collection_method", "currency", @@ -24709,6 +24987,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -25309,18 +25588,23 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -25328,6 +25612,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -25343,6 +25628,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -25354,12 +25640,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -25367,6 +25657,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -25379,12 +25670,16 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "unknown", "us_ein", "uy_ruc", @@ -25392,7 +25687,9 @@ "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "type": "string" }, @@ -25723,6 +26020,7 @@ }, "currency": { "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "fleet": { @@ -25766,6 +26064,7 @@ }, "merchant_currency": { "description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "merchant_data": { @@ -25897,6 +26196,7 @@ "status", "transactions", "verification_data", + "verified_by_fraud_challenge", "wallet" ], "title": "IssuingAuthorization", @@ -26053,6 +26353,7 @@ }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.", + "format": "currency", "type": "string" }, "cvc": { @@ -26548,6 +26849,7 @@ }, "currency": { "description": "The currency the `transaction` was made in.", + "format": "currency", "type": "string" }, "evidence": { @@ -27270,6 +27572,7 @@ }, "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).", + "format": "currency", "type": "string" }, "dispute": { @@ -27307,6 +27610,7 @@ }, "merchant_currency": { "description": "The currency with which the merchant is taking payment.", + "format": "currency", "type": "string" }, "merchant_data": { @@ -27999,6 +28303,12 @@ "nullable": true, "type": "string" }, + "tax_id": { + "description": "The seller's tax identification number. Currently populated for French merchants only.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "terminal_id": { "description": "An ID assigned by the seller to the location of the sale.", "maxLength": 5000, @@ -28036,6 +28346,7 @@ "network_id", "postal_code", "state", + "tax_id", "terminal_id", "url" ] @@ -28094,6 +28405,7 @@ }, "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).", + "format": "currency", "type": "string" }, "is_amount_controllable": { @@ -28106,6 +28418,7 @@ }, "merchant_currency": { "description": "The local currency the merchant is requesting to authorize.", + "format": "currency", "type": "string" }, "network_risk_score": { @@ -29118,6 +29431,7 @@ }, "spending_limits_currency": { "description": "Currency of the amounts within `spending_limits`. Always the same as the currency of the card.", + "format": "currency", "nullable": true, "type": "string" } @@ -30446,6 +30760,7 @@ }, "spending_limits_currency": { "description": "Currency of the amounts within `spending_limits`.", + "format": "currency", "nullable": true, "type": "string" } @@ -33169,11 +33484,13 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.", "maxLength": 5000, + "nullable": true, "type": "string" }, "discounts": { @@ -33223,6 +33540,7 @@ "amount_tax", "amount_total", "currency", + "description", "id", "object", "price", @@ -33928,6 +34246,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -34881,6 +35200,7 @@ }, "currency": { "description": "The currency of the payment on a single use mandate.", + "format": "currency", "type": "string" } }, @@ -35054,7 +35374,8 @@ "financial_account", "us_bank_account" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "us_bank_account": { "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account" @@ -35914,6 +36235,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -36854,6 +37176,7 @@ }, "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).", + "format": "currency", "nullable": true, "type": "string" }, @@ -38222,10 +38545,19 @@ }, "payment_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", - "properties": {}, + "properties": { + "reference_prefix": { + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", + "maxLength": 5000, + "type": "string" + } + }, "title": "payment_intent_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference_prefix" + ], "x-stripeResource": { "class_name": "BacsDebitMandateOptions", "in_package": "" @@ -38233,10 +38565,19 @@ }, "payment_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", - "properties": {}, + "properties": { + "reference_prefix": { + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", + "maxLength": 5000, + "type": "string" + } + }, "title": "payment_intent_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference_prefix" + ], "x-stripeResource": { "class_name": "SepaDebitMandateOptions", "in_package": "" @@ -38298,7 +38639,7 @@ "description": "", "properties": { "reference": { - "description": "The order ID displayed in the Swish app after the payment is authorized.", + "description": "A reference for this payment to be displayed in the Swish app.", "maxLength": 35, "nullable": true, "type": "string" @@ -38564,6 +38905,7 @@ }, "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).", + "format": "currency", "type": "string" }, "custom_fields": { @@ -39919,7 +40261,8 @@ "ZW", "ZZ" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "type": "array" } @@ -40833,6 +41176,15 @@ "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, + "regulated_status": { + "description": "Status of a card based on the card issuer.", + "enum": [ + "regulated", + "unregulated" + ], + "nullable": true, + "type": "string" + }, "three_d_secure_usage": { "anyOf": [ { @@ -40890,6 +41242,7 @@ "issuer", "last4", "networks", + "regulated_status", "three_d_secure_usage", "wallet" ] @@ -42272,10 +42625,19 @@ }, "payment_method_details_amazon_pay": { "description": "", - "properties": {}, + "properties": { + "funding": { + "$ref": "#/components/schemas/amazon_pay_underlying_payment_method_funding_details" + } + }, "title": "payment_method_details_amazon_pay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "funding" + ], + "x-stripeMostCommon": [ + "funding" + ] }, "payment_method_details_au_becs_debit": { "description": "", @@ -42642,9 +43004,24 @@ "description": "If this card has network token credentials, this contains the details of the network token credentials.", "nullable": true }, + "network_transaction_id": { + "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "overcapture": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture" }, + "regulated_status": { + "description": "Status of a card based on the card issuer.", + "enum": [ + "regulated", + "unregulated" + ], + "nullable": true, + "type": "string" + }, "three_d_secure": { "anyOf": [ { @@ -42716,7 +43093,9 @@ "multicapture", "network", "network_token", + "network_transaction_id", "overcapture", + "regulated_status", "three_d_secure", "wallet" ] @@ -44341,6 +44720,64 @@ "verified_name" ] }, + "payment_method_details_passthrough_card": { + "description": "", + "properties": { + "brand": { + "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "country": { + "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "exp_month": { + "description": "Two-digit number representing the card's expiration month.", + "nullable": true, + "type": "integer" + }, + "exp_year": { + "description": "Four-digit number representing the card's expiration year.", + "nullable": true, + "type": "integer" + }, + "funding": { + "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "last4": { + "description": "The last four digits of the card.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "brand", + "country", + "exp_month", + "exp_year", + "funding", + "last4" + ], + "title": "payment_method_details_passthrough_card", + "type": "object", + "x-expandableFields": [], + "x-stripeMostCommon": [ + "brand", + "country", + "exp_month", + "exp_year", + "funding", + "last4" + ] + }, "payment_method_details_payco": { "description": "", "properties": { @@ -44481,10 +44918,19 @@ }, "payment_method_details_revolut_pay": { "description": "", - "properties": {}, + "properties": { + "funding": { + "$ref": "#/components/schemas/revolut_pay_underlying_payment_method_funding_details" + } + }, "title": "payment_method_details_revolut_pay", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "funding" + ], + "x-stripeMostCommon": [ + "funding" + ] }, "payment_method_details_samsung_pay": { "description": "", @@ -48138,7 +48584,8 @@ "ZW", "ZZ" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "type": "array" } @@ -48265,18 +48712,23 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -48284,6 +48736,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -48299,6 +48752,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -48310,12 +48764,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -48323,6 +48781,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -48335,12 +48794,16 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "unknown", "us_ein", "uy_ruc", @@ -48348,7 +48811,9 @@ "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "type": "string" }, @@ -48604,6 +49069,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -48809,6 +49275,7 @@ "source_type", "statement_descriptor", "status", + "trace_id", "type" ], "title": "Payout", @@ -49723,6 +50190,7 @@ }, "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).", + "format": "currency", "type": "string" }, "id": { @@ -50762,7 +51230,8 @@ "required": [ "default_allowed_updates", "enabled", - "proration_behavior" + "proration_behavior", + "schedule_at_period_end" ], "title": "PortalSubscriptionUpdate", "type": "object", @@ -50829,6 +51298,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -53498,6 +53968,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -54656,6 +55127,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -54917,6 +55389,34 @@ "type": "review.opened" } }, + "revolut_pay_underlying_payment_method_funding_details": { + "description": "", + "properties": { + "card": { + "$ref": "#/components/schemas/payment_method_details_passthrough_card" + }, + "type": { + "description": "funding type of the underlying payment method.", + "enum": [ + "card" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "revolut_pay_underlying_payment_method_funding_details", + "type": "object", + "x-expandableFields": [ + "card" + ], + "x-stripeMostCommon": [ + "card", + "type" + ] + }, "rule": { "description": "", "properties": { @@ -55068,6 +55568,14 @@ "schedules_phase_automatic_tax": { "description": "", "properties": { + "disabled_reason": { + "description": "If Stripe disabled automatic tax, this enum describes why.", + "enum": [ + "requires_location_inputs" + ], + "nullable": true, + "type": "string" + }, "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" @@ -55083,6 +55591,7 @@ } }, "required": [ + "disabled_reason", "enabled", "liability" ], @@ -55092,6 +55601,7 @@ "liability" ], "x-stripeMostCommon": [ + "disabled_reason", "enabled", "liability" ] @@ -57028,6 +57538,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -57202,10 +57713,19 @@ }, "setup_intent_payment_method_options_mandate_options_bacs_debit": { "description": "", - "properties": {}, + "properties": { + "reference_prefix": { + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.", + "maxLength": 5000, + "type": "string" + } + }, "title": "setup_intent_payment_method_options_mandate_options_bacs_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference_prefix" + ], "x-stripeResource": { "class_name": "BacsDebitMandateOptions", "in_package": "" @@ -57213,10 +57733,19 @@ }, "setup_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", - "properties": {}, + "properties": { + "reference_prefix": { + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.", + "maxLength": 5000, + "type": "string" + } + }, "title": "setup_intent_payment_method_options_mandate_options_sepa_debit", "type": "object", "x-expandableFields": [], + "x-stripeMostCommon": [ + "reference_prefix" + ], "x-stripeResource": { "class_name": "SepaDebitMandateOptions", "in_package": "" @@ -57623,6 +58152,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -57730,6 +58260,7 @@ }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.", + "format": "currency", "nullable": true, "type": "string" }, @@ -58255,6 +58786,7 @@ }, "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).", + "format": "currency", "type": "string" }, "email": { @@ -58547,6 +59079,7 @@ }, "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).", + "format": "currency", "type": "string" }, "gbp_credit_transfer": { @@ -59724,6 +60257,7 @@ }, "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).", + "format": "currency", "type": "string" }, "current_period_end": { @@ -60198,6 +60732,7 @@ ], "x-resourceId": "subscription", "x-stripeMostCommon": [ + "automatic_tax", "cancel_at_period_end", "currency", "current_period_end", @@ -60281,6 +60816,14 @@ "subscription_automatic_tax": { "description": "", "properties": { + "disabled_reason": { + "description": "If Stripe disabled automatic tax, this enum describes why.", + "enum": [ + "requires_location_inputs" + ], + "nullable": true, + "type": "string" + }, "enabled": { "description": "Whether Stripe automatically computes tax on this subscription.", "type": "boolean" @@ -60296,6 +60839,7 @@ } }, "required": [ + "disabled_reason", "enabled", "liability" ], @@ -60305,6 +60849,7 @@ "liability" ], "x-stripeMostCommon": [ + "disabled_reason", "enabled", "liability" ] @@ -61296,6 +61841,7 @@ }, "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).", + "format": "currency", "type": "string" }, "default_payment_method": { @@ -61612,6 +62158,14 @@ "subscription_schedules_resource_default_settings_automatic_tax": { "description": "", "properties": { + "disabled_reason": { + "description": "If Stripe disabled automatic tax, this enum describes why.", + "enum": [ + "requires_location_inputs" + ], + "nullable": true, + "type": "string" + }, "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" @@ -61627,6 +62181,7 @@ } }, "required": [ + "disabled_reason", "enabled", "liability" ], @@ -61636,6 +62191,7 @@ "liability" ], "x-stripeMostCommon": [ + "disabled_reason", "enabled", "liability" ] @@ -63211,18 +63767,23 @@ "nullable": true }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -63230,6 +63791,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -63245,6 +63807,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -63256,12 +63819,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -63269,6 +63836,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -63281,12 +63849,16 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "unknown", "us_ein", "uy_ruc", @@ -63294,7 +63866,9 @@ "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "type": "string" }, @@ -64150,18 +64724,23 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -64169,6 +64748,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -64184,6 +64764,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -64195,12 +64776,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -64208,6 +64793,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -64220,12 +64806,16 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "unknown", "us_ein", "uy_ruc", @@ -64233,7 +64823,9 @@ "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "type": "string" }, @@ -65886,6 +66478,7 @@ "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).", + "format": "currency", "type": "string" }, "line_items": { @@ -67273,6 +67866,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -67621,6 +68215,7 @@ }, "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).", + "format": "currency", "type": "string" }, "destination_payment_refund": { @@ -67898,6 +68493,7 @@ }, "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).", + "format": "currency", "type": "string" }, "financial_account": { @@ -68095,6 +68691,7 @@ }, "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).", + "format": "currency", "type": "string" }, "financial_account": { @@ -68669,6 +69266,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -68977,6 +69575,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -69365,6 +69964,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -69723,6 +70323,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -69962,6 +70563,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -70170,6 +70772,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -70364,6 +70967,7 @@ }, "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).", + "format": "currency", "type": "string" }, "effective_at": { @@ -70622,50 +71226,6 @@ "in_package": "" } }, - "treasury_financial_accounts_resource_ach_toggle_settings": { - "description": "Toggle settings for enabling/disabling an ACH specific feature", - "properties": { - "requested": { - "description": "Whether the FinancialAccount should have the Feature.", - "type": "boolean" - }, - "status": { - "description": "Whether the Feature is operational.", - "enum": [ - "active", - "pending", - "restricted" - ], - "type": "string" - }, - "status_details": { - "description": "Additional details; includes at least one entry when the status is not `active`.", - "items": { - "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" - }, - "type": "array" - } - }, - "required": [ - "requested", - "status", - "status_details" - ], - "title": "TreasuryFinancialAccountsResourceAchToggleSettings", - "type": "object", - "x-expandableFields": [ - "status_details" - ], - "x-stripeMostCommon": [ - "requested", - "status", - "status_details" - ], - "x-stripeResource": { - "class_name": "AchToggleSettings", - "in_package": "" - } - }, "treasury_financial_accounts_resource_balance": { "description": "Balance information for the FinancialAccount", "properties": { @@ -70800,11 +71360,55 @@ "in_package": "" } }, + "treasury_financial_accounts_resource_inbound_ach_toggle_settings": { + "description": "Toggle settings for enabling/disabling an inbound ACH specific feature", + "properties": { + "requested": { + "description": "Whether the FinancialAccount should have the Feature.", + "type": "boolean" + }, + "status": { + "description": "Whether the Feature is operational.", + "enum": [ + "active", + "pending", + "restricted" + ], + "type": "string" + }, + "status_details": { + "description": "Additional details; includes at least one entry when the status is not `active`.", + "items": { + "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" + }, + "type": "array" + } + }, + "required": [ + "requested", + "status", + "status_details" + ], + "title": "TreasuryFinancialAccountsResourceInboundAchToggleSettings", + "type": "object", + "x-expandableFields": [ + "status_details" + ], + "x-stripeMostCommon": [ + "requested", + "status", + "status_details" + ], + "x-stripeResource": { + "class_name": "InboundAchToggleSettings", + "in_package": "" + } + }, "treasury_financial_accounts_resource_inbound_transfers": { "description": "InboundTransfers contains inbound transfers features for a FinancialAccount.", "properties": { "ach": { - "$ref": "#/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings" + "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_ach_toggle_settings" } }, "title": "TreasuryFinancialAccountsResourceInboundTransfers", @@ -70820,11 +71424,55 @@ "in_package": "" } }, + "treasury_financial_accounts_resource_outbound_ach_toggle_settings": { + "description": "Toggle settings for enabling/disabling an outbound ACH specific feature", + "properties": { + "requested": { + "description": "Whether the FinancialAccount should have the Feature.", + "type": "boolean" + }, + "status": { + "description": "Whether the Feature is operational.", + "enum": [ + "active", + "pending", + "restricted" + ], + "type": "string" + }, + "status_details": { + "description": "Additional details; includes at least one entry when the status is not `active`.", + "items": { + "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details" + }, + "type": "array" + } + }, + "required": [ + "requested", + "status", + "status_details" + ], + "title": "TreasuryFinancialAccountsResourceOutboundAchToggleSettings", + "type": "object", + "x-expandableFields": [ + "status_details" + ], + "x-stripeMostCommon": [ + "requested", + "status", + "status_details" + ], + "x-stripeResource": { + "class_name": "OutboundAchToggleSettings", + "in_package": "" + } + }, "treasury_financial_accounts_resource_outbound_payments": { "description": "Settings related to Outbound Payments features on a Financial Account", "properties": { "ach": { - "$ref": "#/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings" + "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" @@ -70849,7 +71497,7 @@ "description": "OutboundTransfers contains outbound transfers features for a FinancialAccount.", "properties": { "ach": { - "$ref": "#/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings" + "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings" }, "us_domestic_wire": { "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings" @@ -72452,7 +73100,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2024-11-20.acacia", + "version": "2024-12-18.acacia", "x-stripeSpecFilename": "spec3.sdk" }, "openapi": "3.0.0", @@ -72681,7 +73329,7 @@ "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { - "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.", "type": "boolean" }, "external_account_collection": { @@ -72718,7 +73366,7 @@ "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { - "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.", "type": "boolean" }, "external_account_collection": { @@ -72755,7 +73403,7 @@ "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { - "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.", "type": "boolean" }, "edit_payout_schedule": { @@ -72831,7 +73479,7 @@ "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { - "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.", "type": "boolean" }, "external_account_collection": { @@ -72962,7 +73610,7 @@ "description": "The list of features enabled in the embedded component.", "properties": { "disable_stripe_user_authentication": { - "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.", "type": "boolean" }, "edit_payout_schedule": { @@ -73398,6 +74046,7 @@ }, "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).", + "format": "currency", "type": "string" }, "fiscal_year_end": { @@ -73437,6 +74086,7 @@ }, "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).", + "format": "currency", "type": "string" } }, @@ -74856,6 +75506,7 @@ }, "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).", + "format": "currency", "type": "string" }, "documents": { @@ -75021,7 +75672,7 @@ "x-stripeBypassValidation": true }, "groups": { - "description": "A hash of account group type to tokens. These are account groups this account should be added to", + "description": "A hash of account group type to tokens. These are account groups this account should be added to.", "properties": { "payments_pricing": { "anyOf": [ @@ -76166,6 +76817,7 @@ }, "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).", + "format": "currency", "type": "string" }, "fiscal_year_end": { @@ -76205,6 +76857,7 @@ }, "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).", + "format": "currency", "type": "string" } }, @@ -76302,7 +76955,7 @@ "type": "string" } }, - "title": "business_profile_specs", + "title": "business_profile_update_specs", "type": "object", "x-stripeMostCommon": [ "annual_revenue", @@ -77504,7 +78157,7 @@ ] } }, - "title": "company_specs", + "title": "company_update_specs", "type": "object", "x-stripeMostCommon": [ "address", @@ -77541,6 +78194,7 @@ }, "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).", + "format": "currency", "type": "string" }, "documents": { @@ -77706,7 +78360,7 @@ "x-stripeBypassValidation": true }, "groups": { - "description": "A hash of account group type to tokens. These are account groups this account should be added to", + "description": "A hash of account group type to tokens. These are account groups this account should be added to.", "properties": { "payments_pricing": { "anyOf": [ @@ -78176,7 +78830,7 @@ ] } }, - "title": "individual_specs", + "title": "individual_update_specs", "type": "object", "x-stripeMostCommon": [ "address", @@ -83065,6 +83719,7 @@ "name": "currency", "required": false, "schema": { + "format": "currency", "type": "string" }, "style": "form" @@ -83139,7 +83794,7 @@ "style": "form" }, { - "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.", + "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.", "in": "query", "name": "type", "required": false, @@ -83875,7 +84530,7 @@ }, "/v1/billing/credit_balance_summary": { "get": { - "description": "

Retrieves the credit balance summary for a customer

", + "description": "

Retrieves the credit balance summary for a customer.

", "operationId": "GetBillingCreditBalanceSummary", "parameters": [ { @@ -83916,7 +84571,7 @@ "description": "The billing credit applicability scope for which to fetch credit balance summary.", "properties": { "price_type": { - "description": "The price type for which credit grants can apply. We currently only support the `metered` price type.", + "description": "The price type that credit grants can apply to. We currently only support the `metered` price type.", "enum": [ "metered" ], @@ -84000,7 +84655,7 @@ }, "/v1/billing/credit_balance_transactions": { "get": { - "description": "

Retrieve a list of credit balance transactions

", + "description": "

Retrieve a list of credit balance transactions.

", "operationId": "GetBillingCreditBalanceTransactions", "parameters": [ { @@ -84155,7 +84810,7 @@ }, "/v1/billing/credit_balance_transactions/{id}": { "get": { - "description": "

Retrieves a credit balance transaction

", + "description": "

Retrieves a credit balance transaction.

", "operationId": "GetBillingCreditBalanceTransactionsId", "parameters": [ { @@ -84367,7 +85022,7 @@ "summary": "List credit grants" }, "post": { - "description": "

Creates a credit grant

", + "description": "

Creates a credit grant.

", "operationId": "PostBillingCreditGrants", "requestBody": { "content": { @@ -84401,6 +85056,7 @@ "properties": { "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.", + "format": "currency", "type": "string" }, "value": { @@ -84444,7 +85100,7 @@ "description": "Specify the scope of this applicability config.", "properties": { "price_type": { - "description": "The price type for which credit grants can apply. We currently only support the `metered` price type.", + "description": "The price type that credit grants can apply to. We currently only support the `metered` price type.", "enum": [ "metered" ], @@ -84484,7 +85140,7 @@ "type": "string" }, "effective_at": { - "description": "The time when the billing credits become effective—when they're eligible for use. Defaults to the current timestamp if not specified.", + "description": "The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.", "format": "unix-time", "type": "integer" }, @@ -84497,7 +85153,7 @@ "type": "array" }, "expires_at": { - "description": "The time when the billing credits will expire. If not specified, the billing credits don't expire.", + "description": "The time when the billing credits expire. If not specified, the billing credits don't expire.", "format": "unix-time", "type": "integer" }, @@ -84505,7 +85161,7 @@ "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 (for example, cost basis) in a structured format.", + "description": "Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.", "type": "object" }, "name": { @@ -84563,7 +85219,7 @@ }, "/v1/billing/credit_grants/{id}": { "get": { - "description": "

Retrieves a credit grant

", + "description": "

Retrieves a credit grant.

", "operationId": "GetBillingCreditGrantsId", "parameters": [ { @@ -84631,7 +85287,7 @@ "summary": "Retrieve a credit grant" }, "post": { - "description": "

Updates a credit grant

", + "description": "

Updates a credit grant.

", "operationId": "PostBillingCreditGrantsId", "parameters": [ { @@ -84693,7 +85349,7 @@ "additionalProperties": { "type": "string" }, - "description": "Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.", + "description": "Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.", "type": "object" } }, @@ -84872,7 +85528,7 @@ }, "/v1/billing/meter_event_adjustments": { "post": { - "description": "

Creates a billing meter event adjustment

", + "description": "

Creates a billing meter event adjustment.

", "operationId": "PostBillingMeterEventAdjustments", "requestBody": { "content": { @@ -84968,7 +85624,7 @@ }, "/v1/billing/meter_events": { "post": { - "description": "

Creates a billing meter event

", + "description": "

Creates a billing meter event.

", "operationId": "PostBillingMeterEvents", "requestBody": { "content": { @@ -85000,7 +85656,7 @@ "type": "array" }, "identifier": { - "description": "A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.", + "description": "A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.", "maxLength": 100, "type": "string" }, @@ -85205,7 +85861,7 @@ "summary": "List billing meters" }, "post": { - "description": "

Creates a billing meter

", + "description": "

Creates a billing meter.

", "operationId": "PostBillingMeters", "requestBody": { "content": { @@ -85235,7 +85891,7 @@ "description": "Fields that specify how to map a meter event to a customer.", "properties": { "event_payload_key": { - "description": "The key in the usage event payload to use for mapping the event to a customer.", + "description": "The key in the meter event payload to use for mapping the event to a customer.", "maxLength": 100, "type": "string" }, @@ -85280,7 +85936,7 @@ ] }, "display_name": { - "description": "The meter's name.", + "description": "The meter’s name. Not visible to the customer.", "maxLength": 250, "type": "string" }, @@ -85370,7 +86026,7 @@ }, "/v1/billing/meters/{id}": { "get": { - "description": "

Retrieves a billing meter given an ID

", + "description": "

Retrieves a billing meter given an ID.

", "operationId": "GetBillingMetersId", "parameters": [ { @@ -85438,7 +86094,7 @@ "summary": "Retrieve a billing meter" }, "post": { - "description": "

Updates a billing meter

", + "description": "

Updates a billing meter.

", "operationId": "PostBillingMetersId", "parameters": [ { @@ -85466,7 +86122,7 @@ "additionalProperties": false, "properties": { "display_name": { - "description": "The meter's name.", + "description": "The meter’s name. Not visible to the customer.", "maxLength": 250, "type": "string" }, @@ -85515,7 +86171,7 @@ }, "/v1/billing/meters/{id}/deactivate": { "post": { - "description": "

Deactivates a billing meter

", + "description": "

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

", "operationId": "PostBillingMetersIdDeactivate", "parameters": [ { @@ -85775,7 +86431,7 @@ }, "/v1/billing/meters/{id}/reactivate": { "post": { - "description": "

Reactivates a billing meter

", + "description": "

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

", "operationId": "PostBillingMetersIdReactivate", "parameters": [ { @@ -87665,6 +88321,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -89111,7 +89768,7 @@ "description": "Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.", "properties": { "enabled": { - "description": "Set to true to enable automatic taxes.", + "description": "Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.", "type": "boolean" }, "liability": { @@ -89220,6 +89877,7 @@ }, "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.", + "format": "currency", "type": "string" }, "custom_fields": { @@ -89818,6 +90476,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -90436,7 +91095,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -91162,7 +91837,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -91772,7 +92463,8 @@ "ZW", "ZZ" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "type": "array" } @@ -91883,6 +92575,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -94023,6 +94716,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -96076,6 +96770,7 @@ "payment_method_redisplay", "payment_method_redisplay_limit", "payment_method_remove", + "payment_method_remove_last", "payment_method_save", "payment_method_save_usage", "payment_method_set_as_default", @@ -96818,18 +97513,23 @@ "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`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -96837,6 +97537,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -96852,6 +97553,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -96863,12 +97565,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -96876,6 +97582,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -96888,19 +97595,25 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "maxLength": 5000, "type": "string", @@ -97669,7 +98382,7 @@ "description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes." }, "validate_location": { - "description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.", + "description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.", "enum": [ "auto", "deferred", @@ -97919,6 +98632,7 @@ }, "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). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.", + "format": "currency", "type": "string" }, "description": { @@ -98706,6 +99420,7 @@ }, "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).", + "format": "currency", "type": "string" }, "expand": { @@ -99984,18 +100699,23 @@ "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`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -100003,6 +100723,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -100018,6 +100739,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -100029,12 +100751,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -100042,6 +100768,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -100054,19 +100781,25 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "maxLength": 5000, "type": "string", @@ -101077,6 +101810,20 @@ "disputed_transaction", "prior_undisputed_transactions" ] + }, + "visa_compliance": { + "description": "Evidence provided for Visa Compliance evidence submission.", + "properties": { + "fee_acknowledged": { + "description": "A field acknowledging the fee incurred when countering a Visa Compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute, and you may incur a $500 fee if the case is lost.", + "type": "boolean" + } + }, + "title": "visa_compliance", + "type": "object", + "x-stripeMostCommon": [ + "fee_acknowledged" + ] } }, "title": "enhanced_evidence", @@ -104962,7 +105709,8 @@ "card_cvc", "card_expiry", "card_number", - "cardholder_name" + "cardholder_name", + "request_signature" ], "type": "string" }, @@ -106823,6 +107571,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -106942,6 +107691,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -107355,6 +108105,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -107909,6 +108660,7 @@ }, "currency": { "description": "The currency to create this invoice in. Defaults to that of `customer` if not specified.", + "format": "currency", "type": "string" }, "custom_fields": { @@ -108565,13 +109317,14 @@ "type": "string" } ], - "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." + "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration" } }, "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ "default_mandate", + "payment_method_configuration", "payment_method_options", "payment_method_types" ] @@ -108744,6 +109497,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -108956,6 +109710,7 @@ "type": "object", "x-stripeMostCommon": [ "auto_advance", + "automatic_tax", "collection_method", "customer", "description", @@ -109091,6 +109846,7 @@ }, "currency": { "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.", + "format": "currency", "type": "string" }, "customer": { @@ -109276,18 +110032,23 @@ "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`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -109295,6 +110056,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -109310,6 +110072,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -109321,12 +110084,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -109334,6 +110101,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -109346,19 +110114,25 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "maxLength": 5000, "type": "string", @@ -109449,6 +110223,7 @@ }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.", + "format": "currency", "type": "string" }, "description": { @@ -109555,6 +110330,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -109780,6 +110556,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -109953,6 +110730,7 @@ }, "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).", + "format": "currency", "type": "string" }, "default_payment_method": { @@ -110203,6 +110981,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -110547,7 +111326,7 @@ "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "clear_usage": { - "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { @@ -110629,6 +111408,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -110800,6 +111580,7 @@ }, "type": "object", "x-stripeMostCommon": [ + "automatic_tax", "customer", "subscription" ] @@ -111048,6 +111829,7 @@ "name": "currency", "required": false, "schema": { + "format": "currency", "type": "string" }, "style": "form" @@ -111246,18 +112028,23 @@ "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`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -111265,6 +112052,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -111280,6 +112068,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -111291,12 +112080,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -111304,6 +112097,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -111316,19 +112110,25 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "maxLength": 5000, "type": "string", @@ -111440,6 +112240,7 @@ }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.", + "format": "currency", "type": "string" }, "description": { @@ -111546,6 +112347,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -111804,6 +112606,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -111977,6 +112780,7 @@ }, "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).", + "format": "currency", "type": "string" }, "default_payment_method": { @@ -112227,6 +113031,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -112675,7 +113480,7 @@ "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "clear_usage": { - "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { @@ -112757,6 +113562,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -112964,7 +113770,7 @@ "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "clear_usage": { - "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { @@ -113046,6 +113852,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -113351,6 +114158,7 @@ "name": "currency", "required": false, "schema": { + "format": "currency", "type": "string" }, "style": "form" @@ -113549,18 +114357,23 @@ "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`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -113568,6 +114381,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -113583,6 +114397,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -113594,12 +114409,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -113607,6 +114426,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -113619,19 +114439,25 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "maxLength": 5000, "type": "string", @@ -113754,6 +114580,7 @@ }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.", + "format": "currency", "type": "string" }, "description": { @@ -113860,6 +114687,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -114128,6 +114956,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -114301,6 +115130,7 @@ }, "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).", + "format": "currency", "type": "string" }, "default_payment_method": { @@ -114551,6 +115381,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -115010,7 +115841,7 @@ "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "clear_usage": { - "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { @@ -115092,6 +115923,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -115299,7 +116131,7 @@ "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "clear_usage": { - "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { @@ -115381,6 +116213,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -116620,13 +117453,14 @@ "type": "string" } ], - "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." + "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration" } }, "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ "default_mandate", + "payment_method_configuration", "payment_method_options", "payment_method_types" ] @@ -116791,6 +117625,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -117027,6 +117862,7 @@ "type": "object", "x-stripeMostCommon": [ "auto_advance", + "automatic_tax", "collection_method", "description", "metadata" @@ -117234,6 +118070,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -117902,6 +118739,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -118712,6 +119550,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -129630,6 +130469,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -130674,6 +131514,7 @@ "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", + "target_date", "verification_method" ] }, @@ -130906,7 +131747,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -131963,6 +132820,7 @@ "payment_details", "payment_method_category", "preferred_locale", + "request_multicapture", "setup_future_usage" ] }, @@ -132583,7 +133441,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -132681,7 +133555,7 @@ "type": "string" } ], - "description": "The order ID displayed in the Swish app after the payment is authorized." + "description": "A reference for this payment to be displayed in the Swish app." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -132887,6 +133761,7 @@ "networks", "preferred_settlement_speed", "setup_future_usage", + "target_date", "verification_method" ] }, @@ -133571,6 +134446,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -134513,6 +135389,7 @@ "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", + "target_date", "verification_method" ] }, @@ -134745,7 +135622,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -135802,6 +136695,7 @@ "payment_details", "payment_method_category", "preferred_locale", + "request_multicapture", "setup_future_usage" ] }, @@ -136422,7 +137316,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -136520,7 +137430,7 @@ "type": "string" } ], - "description": "The order ID displayed in the Swish app after the payment is authorized." + "description": "A reference for this payment to be displayed in the Swish app." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -136726,6 +137636,7 @@ "networks", "preferred_settlement_speed", "setup_future_usage", + "target_date", "verification_method" ] }, @@ -137117,6 +138028,7 @@ }, "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).", + "format": "currency", "type": "string" }, "expand": { @@ -138527,6 +139439,7 @@ "x-stripeMostCommon": [ "mandate_options", "setup_future_usage", + "target_date", "verification_method" ] }, @@ -138759,7 +139672,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -139816,6 +140745,7 @@ "payment_details", "payment_method_category", "preferred_locale", + "request_multicapture", "setup_future_usage" ] }, @@ -140436,7 +141366,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -140534,7 +141480,7 @@ "type": "string" } ], - "description": "The order ID displayed in the Swish app after the payment is authorized." + "description": "A reference for this payment to be displayed in the Swish app." }, "setup_future_usage": { "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.", @@ -140740,6 +141686,7 @@ "networks", "preferred_settlement_speed", "setup_future_usage", + "target_date", "verification_method" ] }, @@ -141595,7 +142542,7 @@ "description": "Configuration for automatic tax collection.", "properties": { "enabled": { - "description": "If `true`, tax will be calculated automatically using the customer's location.", + "description": "Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.", "type": "boolean" }, "liability": { @@ -141694,6 +142641,7 @@ }, "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) and supported by each line item's price.", + "format": "currency", "type": "string" }, "custom_fields": { @@ -142636,7 +143584,8 @@ "ZW", "ZZ" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "type": "array" } @@ -143086,7 +144035,7 @@ "description": "Configuration for automatic tax collection.", "properties": { "enabled": { - "description": "If `true`, tax will be calculated automatically using the customer's location.", + "description": "Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes the payment link to collect any billing address information necessary for tax calculation.", "type": "boolean" }, "liability": { @@ -144126,7 +145075,8 @@ "ZW", "ZZ" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "type": "array" } @@ -144216,6 +145166,20 @@ ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values." }, + "trial_period_days": { + "anyOf": [ + { + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1." + }, "trial_settings": { "anyOf": [ { @@ -150199,6 +151163,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -150865,6 +151830,7 @@ }, "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).", + "format": "currency", "type": "string" }, "expand": { @@ -151427,6 +152393,7 @@ "name": "currency", "required": false, "schema": { + "format": "currency", "type": "string" }, "style": "form" @@ -151698,6 +152665,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -152883,6 +153851,7 @@ "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -154491,6 +155460,7 @@ }, "minimum_amount_currency": { "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount", + "format": "currency", "type": "string" } }, @@ -155301,6 +156271,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -156016,6 +156987,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -158248,6 +159220,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -158800,6 +159773,7 @@ }, "currency": { "description": "Currency of objects to be included in the report run.", + "format": "currency", "type": "string" }, "interval_end": { @@ -159526,6 +160500,7 @@ "filter_value", "filter_values", "filters", + "financial_account", "first_day_of_week_offset", "gateway_conversation_avs_outcome", "gateway_conversation_cvc_outcome", @@ -161754,7 +162729,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -161788,6 +162779,7 @@ }, "currency": { "description": "Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "description": { @@ -162065,7 +163057,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -162257,6 +163265,7 @@ }, "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).", + "format": "currency", "type": "string" } }, @@ -163431,7 +164440,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -163465,6 +164490,7 @@ }, "currency": { "description": "Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "description": { @@ -163742,7 +164768,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -165160,7 +166202,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -165194,6 +166252,7 @@ }, "currency": { "description": "Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "description": { @@ -165471,7 +166530,23 @@ "properties": { "mandate_options": { "description": "Additional fields for Mandate creation", - "properties": {}, + "properties": { + "reference_prefix": { + "anyOf": [ + { + "maxLength": 12, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'." + } + }, "title": "payment_method_options_mandate_options_param", "type": "object", "x-stripeMostCommon": [ @@ -165837,6 +166912,7 @@ "name": "currency", "required": false, "schema": { + "format": "currency", "type": "string" }, "style": "form" @@ -166088,6 +167164,7 @@ }, "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).", + "format": "currency", "type": "string" }, "currency_options": { @@ -166667,6 +167744,7 @@ }, "currency": { "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.", + "format": "currency", "type": "string" }, "customer": { @@ -166808,6 +167886,7 @@ }, "currency": { "description": "The currency specified by the mandate. (Must match `currency` of the source)", + "format": "currency", "type": "string" }, "interval": { @@ -166974,6 +168053,7 @@ "type": "integer" }, "currency": { + "format": "currency", "type": "string" }, "description": { @@ -167421,6 +168501,7 @@ }, "currency": { "description": "The currency specified by the mandate. (Must match `currency` of the source)", + "format": "currency", "type": "string" }, "interval": { @@ -167556,6 +168637,7 @@ "type": "integer" }, "currency": { + "format": "currency", "type": "string" }, "description": { @@ -168232,6 +169314,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -168691,6 +169774,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -169772,6 +170856,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -169945,6 +171030,7 @@ }, "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).", + "format": "currency", "type": "string" }, "default_payment_method": { @@ -170184,6 +171270,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -170868,6 +171955,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -171041,6 +172129,7 @@ }, "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).", + "format": "currency", "type": "string" }, "default_payment_method": { @@ -171291,6 +172380,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -172199,6 +173289,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -172431,6 +173522,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -172673,6 +173765,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -173244,7 +174337,7 @@ "type": "string" } ], - "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." + "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration" }, "save_default_payment_method": { "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", @@ -173258,6 +174351,7 @@ "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ + "payment_method_configuration", "payment_method_options", "payment_method_types", "save_default_payment_method" @@ -173402,6 +174496,7 @@ ], "type": "object", "x-stripeMostCommon": [ + "automatic_tax", "cancel_at_period_end", "currency", "customer", @@ -173920,6 +175015,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -174360,7 +175456,7 @@ "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, "clear_usage": { - "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "description": "Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.", "type": "boolean" }, "deleted": { @@ -174442,6 +175538,7 @@ "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).", + "format": "currency", "type": "string" }, "product": { @@ -175053,7 +176150,7 @@ "type": "string" } ], - "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." + "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration" }, "save_default_payment_method": { "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", @@ -175067,6 +176164,7 @@ "title": "payment_settings", "type": "object", "x-stripeMostCommon": [ + "payment_method_configuration", "payment_method_options", "payment_method_types", "save_default_payment_method" @@ -175219,6 +176317,7 @@ }, "type": "object", "x-stripeMostCommon": [ + "automatic_tax", "cancel_at_period_end", "default_payment_method", "description", @@ -175439,6 +176538,7 @@ "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).", + "format": "currency", "type": "string" }, "customer": { @@ -175564,18 +176664,23 @@ "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`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -175583,6 +176688,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -175598,6 +176704,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -175609,12 +176716,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -175622,6 +176733,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -175634,19 +176746,25 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "maxLength": 5000, "type": "string", @@ -178444,13 +179562,20 @@ "type": "object", "x-stripeMostCommon": [ "ae", + "al", + "am", + "ao", "at", "au", + "ba", + "bb", "be", "bg", "bh", + "bs", "by", "ca", + "cd", "ch", "cl", "co", @@ -178467,6 +179592,7 @@ "fr", "gb", "ge", + "gn", "gr", "hr", "hu", @@ -178477,6 +179603,7 @@ "it", "jp", "ke", + "kh", "kr", "kz", "lt", @@ -178484,14 +179611,19 @@ "lv", "ma", "md", + "me", + "mk", + "mr", "mt", "mx", "my", "ng", "nl", "no", + "np", "nz", "om", + "pe", "pl", "pt", "ro", @@ -178502,15 +179634,22 @@ "sg", "si", "sk", + "sn", + "sr", "th", + "tj", "tr", "tw", "tz", "ua", + "ug", "us", + "uy", "uz", "vn", - "za" + "za", + "zm", + "zw" ] }, "expand": { @@ -179885,18 +181024,23 @@ ] }, "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`, `by_tin`, `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`, `li_vat`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `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`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`", "enum": [ "ad_nrt", "ae_trn", + "am_tin", + "ao_tin", "ar_cuit", "au_abn", "au_arn", + "ba_tin", + "bb_tin", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", + "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", @@ -179904,6 +181048,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "cd_nif", "ch_uid", "ch_vat", "cl_tin", @@ -179919,6 +181064,7 @@ "eu_vat", "gb_vat", "ge_vat", + "gn_nif", "hk_br", "hr_oib", "hu_tin", @@ -179930,12 +181076,16 @@ "jp_rn", "jp_trn", "ke_pin", + "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "ma_vat", "md_vat", + "me_pib", + "mk_vat", + "mr_nif", "mx_rfc", "my_frp", "my_itn", @@ -179943,6 +181093,7 @@ "ng_tin", "no_vat", "no_voec", + "np_pan", "nz_gst", "om_vat", "pe_ruc", @@ -179955,19 +181106,25 @@ "sg_gst", "sg_uen", "si_tin", + "sn_ninea", + "sr_fin", "sv_nit", "th_vat", + "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", + "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", - "za_vat" + "za_vat", + "zm_tin", + "zw_tin" ], "maxLength": 5000, "type": "string", @@ -182920,7 +184077,7 @@ "additionalProperties": false, "properties": { "address": { - "description": "The full address of the location. If you're updating the `address` field, avoid changing the `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.", + "description": "The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.", "properties": { "city": { "description": "City, district, suburb, town, or village.", @@ -184057,6 +185214,7 @@ "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).", + "format": "currency", "type": "string" }, "line_items": { @@ -185185,6 +186343,7 @@ }, "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).", + "format": "currency", "type": "string" }, "expand": { @@ -185321,6 +186480,7 @@ }, "currency": { "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "expand": { @@ -185532,6 +186692,7 @@ }, "merchant_currency": { "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "merchant_data": { @@ -187703,6 +188864,7 @@ }, "currency": { "description": "The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "expand": { @@ -188488,6 +189650,7 @@ }, "currency": { "description": "The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "format": "currency", "type": "string" }, "expand": { @@ -190940,6 +192103,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -191087,6 +192251,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -192134,6 +193299,7 @@ }, "currency": { "description": "The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)", + "format": "currency", "type": "string" }, "payment_method": { @@ -193865,6 +195031,7 @@ }, "currency": { "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).", + "format": "currency", "type": "string" }, "description": { @@ -196676,6 +197843,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -197147,6 +198315,7 @@ }, "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).", + "format": "currency", "type": "string" }, "customer": { @@ -197296,7 +198465,8 @@ "financial_account", "us_bank_account" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "us_bank_account": { "description": "Required hash if type is set to `us_bank_account`.", @@ -197815,6 +198985,7 @@ }, "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).", + "format": "currency", "type": "string" }, "description": { @@ -199486,7 +200657,8 @@ "2024-06-20", "2024-09-30.acacia", "2024-10-28.acacia", - "2024-11-20.acacia" + "2024-11-20.acacia", + "2024-12-18.acacia" ], "maxLength": 5000, "type": "string", diff --git a/pkg/cmd/resources_cmds.go b/pkg/cmd/resources_cmds.go index b338b832..eab16291 100644 --- a/pkg/cmd/resources_cmds.go +++ b/pkg/cmd/resources_cmds.go @@ -1782,6 +1782,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "submit_type": "string", "subscription_data.invoice_settings.issuer.account": "string", "subscription_data.invoice_settings.issuer.type": "string", + "subscription_data.trial_period_days": "integer", "tax_id_collection.enabled": "boolean", "tax_id_collection.required": "string", }, &Config) @@ -2464,6 +2465,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "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.bacs_debit.mandate_options.reference_prefix": "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", @@ -2488,6 +2490,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "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.sepa_debit.mandate_options.reference_prefix": "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", @@ -2547,6 +2550,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "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.bacs_debit.mandate_options.reference_prefix": "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", @@ -2571,6 +2575,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "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.sepa_debit.mandate_options.reference_prefix": "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", @@ -2641,6 +2646,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "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.bacs_debit.mandate_options.reference_prefix": "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", @@ -2665,6 +2671,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "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.sepa_debit.mandate_options.reference_prefix": "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", @@ -3535,6 +3542,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "payment_method_options.alipay.setup_future_usage": "string", "payment_method_options.amazon_pay.setup_future_usage": "string", "payment_method_options.au_becs_debit.setup_future_usage": "string", + "payment_method_options.bacs_debit.mandate_options.reference_prefix": "string", "payment_method_options.bacs_debit.setup_future_usage": "string", "payment_method_options.bancontact.setup_future_usage": "string", "payment_method_options.boleto.expires_after_days": "integer", @@ -3585,6 +3593,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "payment_method_options.pix.expires_after_seconds": "integer", "payment_method_options.revolut_pay.setup_future_usage": "string", "payment_method_options.samsung_pay.capture_method": "string", + "payment_method_options.sepa_debit.mandate_options.reference_prefix": "string", "payment_method_options.sepa_debit.setup_future_usage": "string", "payment_method_options.sofort.setup_future_usage": "string", "payment_method_options.swish.reference": "string",