From 2f0d53130f5f1e16af4f8276c38983ddac38494f Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Fri, 9 Jun 2023 14:47:58 -0700 Subject: [PATCH] Update OpenAPI for 8139d73a68a0f1eae73f6fa11a94acbf72e8207c (#1074) Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- api/openapi-spec/spec3.sdk.json | 1288 ++++++++++++++++++++++++++----- pkg/cmd/resources_cmds.go | 6 + 2 files changed, 1105 insertions(+), 189 deletions(-) diff --git a/api/openapi-spec/spec3.sdk.json b/api/openapi-spec/spec3.sdk.json index cc81e53e5..f0877bf6c 100644 --- a/api/openapi-spec/spec3.sdk.json +++ b/api/openapi-spec/spec3.sdk.json @@ -58,7 +58,7 @@ "type": "boolean" }, "email": { - "description": "An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.", + "description": "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.", "maxLength": 5000, "nullable": true, "type": "string" @@ -749,6 +749,15 @@ "pending" ], "type": "string" + }, + "zip_payments": { + "description": "The status of the Zip capability of the account, or whether the account can directly process Zip charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" } }, "title": "AccountCapabilities", @@ -1129,7 +1138,7 @@ } }, "account_link": { - "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding).", + "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -1747,6 +1756,162 @@ }, "code": { "description": "For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.", + "enum": [ + "account_closed", + "account_country_invalid_address", + "account_error_country_change_requires_additional_steps", + "account_information_mismatch", + "account_invalid", + "account_number_invalid", + "acss_debit_session_incomplete", + "alipay_upgrade_required", + "amount_too_large", + "amount_too_small", + "api_key_expired", + "authentication_required", + "balance_insufficient", + "bank_account_bad_routing_numbers", + "bank_account_declined", + "bank_account_exists", + "bank_account_restricted", + "bank_account_unusable", + "bank_account_unverified", + "bank_account_verification_failed", + "billing_invalid_mandate", + "bitcoin_upgrade_required", + "capture_charge_authorization_expired", + "capture_unauthorized_payment", + "card_decline_rate_limit_exceeded", + "card_declined", + "cardholder_phone_number_required", + "charge_already_captured", + "charge_already_refunded", + "charge_disputed", + "charge_exceeds_source_limit", + "charge_expired_for_capture", + "charge_invalid_parameter", + "charge_not_refundable", + "clearing_code_unsupported", + "country_code_invalid", + "country_unsupported", + "coupon_expired", + "customer_max_payment_methods", + "customer_max_subscriptions", + "debit_not_authorized", + "email_invalid", + "expired_card", + "idempotency_key_in_use", + "incorrect_address", + "incorrect_cvc", + "incorrect_number", + "incorrect_zip", + "instant_payouts_config_disabled", + "instant_payouts_currency_disabled", + "instant_payouts_limit_exceeded", + "instant_payouts_unsupported", + "insufficient_funds", + "intent_invalid_state", + "intent_verification_method_missing", + "invalid_card_type", + "invalid_characters", + "invalid_charge_amount", + "invalid_cvc", + "invalid_expiry_month", + "invalid_expiry_year", + "invalid_number", + "invalid_source_usage", + "invoice_no_customer_line_items", + "invoice_no_payment_method_types", + "invoice_no_subscription_line_items", + "invoice_not_editable", + "invoice_on_behalf_of_not_editable", + "invoice_payment_intent_requires_action", + "invoice_upcoming_none", + "livemode_mismatch", + "lock_timeout", + "missing", + "no_account", + "not_allowed_on_standard_account", + "out_of_inventory", + "ownership_declaration_not_allowed", + "parameter_invalid_empty", + "parameter_invalid_integer", + "parameter_invalid_string_blank", + "parameter_invalid_string_empty", + "parameter_missing", + "parameter_unknown", + "parameters_exclusive", + "payment_intent_action_required", + "payment_intent_authentication_failure", + "payment_intent_incompatible_payment_method", + "payment_intent_invalid_parameter", + "payment_intent_konbini_rejected_confirmation_number", + "payment_intent_mandate_invalid", + "payment_intent_payment_attempt_expired", + "payment_intent_payment_attempt_failed", + "payment_intent_unexpected_state", + "payment_method_bank_account_already_verified", + "payment_method_bank_account_blocked", + "payment_method_billing_details_address_missing", + "payment_method_configuration_failures", + "payment_method_currency_mismatch", + "payment_method_customer_decline", + "payment_method_invalid_parameter", + "payment_method_invalid_parameter_testmode", + "payment_method_microdeposit_failed", + "payment_method_microdeposit_verification_amounts_invalid", + "payment_method_microdeposit_verification_amounts_mismatch", + "payment_method_microdeposit_verification_attempts_exceeded", + "payment_method_microdeposit_verification_descriptor_code_mismatch", + "payment_method_microdeposit_verification_timeout", + "payment_method_not_available", + "payment_method_provider_decline", + "payment_method_provider_timeout", + "payment_method_unactivated", + "payment_method_unexpected_state", + "payment_method_unsupported_type", + "payout_reconciliation_not_ready", + "payouts_limit_exceeded", + "payouts_not_allowed", + "platform_account_required", + "platform_api_key_expired", + "postal_code_invalid", + "processing_error", + "product_inactive", + "progressive_onboarding_limit_exceeded", + "rate_limit", + "refer_to_customer", + "refund_disputed_payment", + "resource_already_exists", + "resource_missing", + "return_intent_already_processed", + "routing_number_invalid", + "secret_key_required", + "sepa_unsupported_account", + "setup_attempt_failed", + "setup_intent_authentication_failure", + "setup_intent_invalid_parameter", + "setup_intent_mandate_invalid", + "setup_intent_setup_attempt_expired", + "setup_intent_unexpected_state", + "shipping_calculation_failed", + "sku_inactive", + "state_unsupported", + "status_transition_invalid", + "tax_id_invalid", + "taxes_calculation_failed", + "terminal_location_country_unsupported", + "terminal_reader_busy", + "terminal_reader_offline", + "terminal_reader_timeout", + "testmode_charges_only", + "tls_version_unsupported", + "token_already_used", + "token_in_use", + "transfer_source_balance_parameters_mismatch", + "transfers_not_allowed", + "url_invalid" + ], "maxLength": 5000, "type": "string" }, @@ -2160,7 +2325,7 @@ } }, "apps.secret": { - "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects).", + "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -2294,7 +2459,7 @@ } }, "balance": { - "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).", + "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)", "properties": { "available": { "description": "Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property.", @@ -2454,7 +2619,7 @@ } }, "balance_transaction": { - "description": "Balance transactions represent funds moving through your Stripe account.\nThey're created for every type of transaction that comes into or flows out of your Stripe account balance.\n\nRelated guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).", + "description": "Balance transactions represent funds moving through your Stripe account.\nThey're created for every type of transaction that comes into or flows out of your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)", "properties": { "amount": { "description": "Gross amount of the transaction, in %s.", @@ -2688,7 +2853,7 @@ } }, "bank_account": { - "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer\ndestinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank Debits and Transfers](https://stripe.com/docs/payments/bank-debits-transfers).", + "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer\ndestinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)", "properties": { "account": { "anyOf": [ @@ -3578,7 +3743,7 @@ } }, "capability": { - "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities).", + "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)", "properties": { "account": { "anyOf": [ @@ -3703,7 +3868,7 @@ } }, "card": { - "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards).", + "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)", "properties": { "account": { "anyOf": [ @@ -4106,7 +4271,7 @@ } }, "charge": { - "description": "To charge a credit or a debit card, you create a `Charge` object. You can\nretrieve and refund individual charges as well as list all charges. Charges\nare identified by a unique, random ID.\n\nRelated guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).", + "description": "The `Charge` object represents a single attempt to move money into your Stripe account.\nPaymentIntent confirmation is the most common way to create Charges, but transferring\nmoney to a different Stripe account through Connect also creates Charges.\nSome legacy payment flows create Charges directly, which is not recommended for new integrations.", "properties": { "alternate_statement_descriptors": { "$ref": "#/components/schemas/alternate_statement_descriptors" @@ -4902,7 +5067,7 @@ } }, "checkout.session": { - "description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout Quickstart](https://stripe.com/docs/checkout/quickstart).", + "description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)", "properties": { "after_expiration": { "anyOf": [ @@ -5387,6 +5552,7 @@ "success_url": { "description": "The URL the customer will be directed to after the payment or\nsubscription creation is successful.", "maxLength": 5000, + "nullable": true, "type": "string" }, "tax_id_collection": { @@ -5879,10 +6045,12 @@ "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ + "aba", "iban", "sepa", "sort_code", "spei", + "swift", "zengin" ], "type": "string", @@ -5891,12 +6059,13 @@ "type": "array" }, "type": { - "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "nullable": true, "type": "string", @@ -6860,7 +7029,7 @@ } }, "credit_note": { - "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes).", + "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)", "properties": { "amount": { "description": "The integer amount in %s representing the total amount of the credit note, including tax.", @@ -7540,7 +7709,7 @@ } }, "customer": { - "description": "This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).", + "description": "This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)", "properties": { "address": { "anyOf": [ @@ -8118,15 +8287,19 @@ "type": "string" }, "type": { - "description": "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true + }, + "us_bank_transfer": { + "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer" } }, "required": [ @@ -8138,7 +8311,8 @@ "x-expandableFields": [ "eu_bank_transfer", "gb_bank_transfer", - "jp_bank_transfer" + "jp_bank_transfer", + "us_bank_transfer" ], "x-stripeResource": { "class_name": "BankTransfer", @@ -8146,7 +8320,8 @@ "inner_classes": [ "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer", "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer", - "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer" + "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer", + "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer" ] } }, @@ -8255,6 +8430,36 @@ "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer" } }, + "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": { + "description": "", + "properties": { + "network": { + "description": "The banking network used for this funding.", + "enum": [ + "ach", + "domestic_wire_us", + "swift" + ], + "type": "string" + }, + "sender_name": { + "description": "The full name of the sender, as supplied by the sending bank.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "sender_name" + ], + "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "UsBankTransfer", + "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer" + } + }, "customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": { "description": "", "properties": { @@ -8328,7 +8533,7 @@ } }, "customer_balance_transaction": { - "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer Balance](https://stripe.com/docs/billing/customer/balance) to learn more.", + "description": "Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)", "properties": { "amount": { "description": "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.", @@ -9753,7 +9958,7 @@ } }, "discount": { - "description": "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).", + "description": "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)", "properties": { "checkout_session": { "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.", @@ -9925,7 +10130,7 @@ } }, "dispute": { - "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you're given the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate. You can find more\ninformation about the dispute process in our [Disputes and\nFraud](/docs/disputes) documentation.\n\nRelated guide: [Disputes and Fraud](https://stripe.com/docs/disputes).", + "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you're given the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate. You can find more\ninformation about the dispute process in our [Disputes and\nFraud](/docs/disputes) documentation.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)", "properties": { "amount": { "description": "Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).", @@ -10926,7 +11131,7 @@ } }, "fee_refund": { - "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding Application Fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee).", + "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)", "properties": { "amount": { "description": "Amount, in %s.", @@ -11080,7 +11285,7 @@ } }, "file": { - "description": "This is an object representing a file hosted on Stripe's servers. The\nfile may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file)\nrequest (for example, when uploading dispute evidence) or it may have\nbeen created by Stripe (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File Upload Guide](https://stripe.com/docs/file-upload).", + "description": "This is an object representing a file hosted on Stripe's servers. The\nfile may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file)\nrequest (for example, when uploading dispute evidence) or it may have\nbeen created by Stripe (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -11935,7 +12140,7 @@ } }, "funding_instructions": { - "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer Balance - Funding Instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) to learn more", + "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)", "properties": { "bank_transfer": { "$ref": "#/components/schemas/funding_instructions_bank_transfer" @@ -13453,7 +13658,7 @@ } }, "invoice": { - "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/billing/invoices/workflow/#auto_advance), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send Invoices to Customers](https://stripe.com/docs/billing/invoices/sending).", + "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)", "properties": { "account_country": { "description": "The country of the business associated with this invoice, most often the business creating the invoice.", @@ -13552,7 +13757,7 @@ "type": "boolean" }, "auto_advance": { - "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.", + "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", "type": "boolean" }, "automatic_tax": { @@ -14301,13 +14506,6 @@ "operation": "get", "path": "/v1/invoices/search" }, - { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/invoices" - }, { "method_name": "upcoming", "method_on": "service", @@ -14315,27 +14513,6 @@ "operation": "get", "path": "/v1/invoices/upcoming" }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/invoices" - }, - { - "method_name": "retrieve", - "method_on": "service", - "method_type": "retrieve", - "operation": "get", - "path": "/v1/invoices/{invoice}" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/invoices/{invoice}" - }, { "method_name": "update", "method_on": "service", @@ -14364,6 +14541,34 @@ "operation": "get", "path": "/v1/invoices/upcoming/lines" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/invoices" + }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/invoices" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/invoices/{invoice}" + }, + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/invoices/{invoice}" + }, { "method_name": "send_invoice", "method_on": "service", @@ -14668,7 +14873,7 @@ "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer" }, "type": { - "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "nullable": true, "type": "string" } @@ -15438,61 +15643,6 @@ "in_class": "invoice" } }, - "invoices_line_items_credited_items": { - "description": "", - "properties": { - "invoice": { - "description": "Invoice containing the credited invoice line items", - "maxLength": 5000, - "type": "string" - }, - "invoice_line_items": { - "description": "Credited invoice line items", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "invoice", - "invoice_line_items" - ], - "title": "InvoicesLineItemsCreditedItems", - "type": "object", - "x-expandableFields": [], - "x-stripeResource": { - "class_name": "CreditedItems", - "in_package": "" - } - }, - "invoices_line_items_proration_details": { - "description": "", - "properties": { - "credited_items": { - "anyOf": [ - { - "$ref": "#/components/schemas/invoices_line_items_credited_items" - } - ], - "description": "For a credit proration `line_item`, the original debit line_items to which the credit proration applies.", - "nullable": true - } - }, - "required": [ - "credited_items" - ], - "title": "InvoicesLineItemsProrationDetails", - "type": "object", - "x-expandableFields": [ - "credited_items" - ], - "x-stripeResource": { - "class_name": "ProrationDetails", - "in_package": "" - } - }, "invoices_payment_method_options": { "description": "", "properties": { @@ -15731,6 +15881,61 @@ "in_class": "invoice" } }, + "invoices_resource_line_items_credited_items": { + "description": "", + "properties": { + "invoice": { + "description": "Invoice containing the credited invoice line items", + "maxLength": 5000, + "type": "string" + }, + "invoice_line_items": { + "description": "Credited invoice line items", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "invoice", + "invoice_line_items" + ], + "title": "InvoicesResourceLineItemsCreditedItems", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "CreditedItems", + "in_package": "" + } + }, + "invoices_resource_line_items_proration_details": { + "description": "", + "properties": { + "credited_items": { + "anyOf": [ + { + "$ref": "#/components/schemas/invoices_resource_line_items_credited_items" + } + ], + "description": "For a credit proration `line_item`, the original debit line_items to which the credit proration applies.", + "nullable": true + } + }, + "required": [ + "credited_items" + ], + "title": "InvoicesResourceLineItemsProrationDetails", + "type": "object", + "x-expandableFields": [ + "credited_items" + ], + "x-stripeResource": { + "class_name": "ProrationDetails", + "in_package": "" + } + }, "invoices_shipping_cost": { "description": "", "properties": { @@ -15834,7 +16039,7 @@ } }, "issuing.authorization": { - "description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations).", + "description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)", "properties": { "amount": { "description": "The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", @@ -16373,7 +16578,7 @@ } }, "issuing.cardholder": { - "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.\n\nRelated guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)", + "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.\n\nRelated guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)", "properties": { "billing": { "$ref": "#/components/schemas/issuing_cardholder_address" @@ -16442,6 +16647,21 @@ "nullable": true, "type": "string" }, + "preferred_locales": { + "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", + "items": { + "enum": [ + "de", + "en", + "es", + "fr", + "it" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, "requirements": { "$ref": "#/components/schemas/issuing_cardholder_requirements" }, @@ -16485,6 +16705,7 @@ "name", "object", "phone_number", + "preferred_locales", "requirements", "spending_controls", "status", @@ -16544,7 +16765,7 @@ } }, "issuing.dispute": { - "description": "As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes)", + "description": "As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)", "properties": { "amount": { "description": "Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).", @@ -16707,7 +16928,7 @@ } }, "issuing.transaction": { - "description": "Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions).", + "description": "Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)", "properties": { "amount": { "description": "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", @@ -18152,7 +18373,7 @@ "description": "", "properties": { "eori_number": { - "description": "A registration number used for customs in Europe. See https://www.gov.uk/eori and https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en.", + "description": "A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.", "maxLength": 5000, "nullable": true, "type": "string" @@ -21635,7 +21856,7 @@ "proration_details": { "anyOf": [ { - "$ref": "#/components/schemas/invoices_line_items_proration_details" + "$ref": "#/components/schemas/invoices_resource_line_items_proration_details" } ], "description": "Additional details for proration line items", @@ -21887,7 +22108,7 @@ } }, "login_link": { - "description": "", + "description": "Login Links are single-use login link for an Express account to access their Stripe dashboard.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -22459,7 +22680,7 @@ "type": "object" }, "previous_attributes": { - "description": "Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events).", + "description": "Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.", "type": "object" } }, @@ -22997,7 +23218,7 @@ } }, "payment_intent": { - "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).", + "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)", "properties": { "amount": { "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", @@ -23879,7 +24100,8 @@ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true @@ -24533,6 +24755,9 @@ }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_options_wechat_pay" + }, + "zip": { + "$ref": "#/components/schemas/payment_method_options_zip" } }, "title": "PaymentIntentPaymentMethodOptions", @@ -24569,7 +24794,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "x-stripeResource": { "class_name": "PaymentMethodOptions", @@ -24609,7 +24835,8 @@ "payment_method_options_pix", "payment_method_options_promptpay", "payment_method_options_sofort", - "payment_method_options_wechat_pay" + "payment_method_options_wechat_pay", + "payment_method_options_zip" ] } }, @@ -26520,7 +26747,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -26530,6 +26758,9 @@ }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_wechat_pay" + }, + "zip": { + "$ref": "#/components/schemas/payment_method_zip" } }, "required": [ @@ -26579,7 +26810,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "x-resourceId": "payment_method", "x-stripeOperations": [ @@ -26663,7 +26895,8 @@ "payment_method_sepa_debit", "payment_method_sofort", "payment_method_us_bank_account", - "payment_method_wechat_pay" + "payment_method_wechat_pay", + "payment_method_zip" ] } }, @@ -27030,6 +27263,12 @@ "nullable": true, "type": "string" }, + "description": { + "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" @@ -27050,6 +27289,18 @@ "nullable": true, "type": "string" }, + "iin": { + "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "issuer": { + "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, @@ -27379,6 +27630,10 @@ "type": "string" } }, + "required": [ + "buyer_id", + "cashtag" + ], "title": "payment_method_cashapp", "type": "object", "x-expandableFields": [], @@ -27519,6 +27774,9 @@ }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_details_wechat_pay" + }, + "zip": { + "$ref": "#/components/schemas/payment_method_details_zip" } }, "required": [ @@ -27564,7 +27822,8 @@ "stripe_account", "us_bank_account", "wechat", - "wechat_pay" + "wechat_pay", + "zip" ], "x-stripeResource": { "class_name": "PaymentMethodDetails", @@ -27608,7 +27867,8 @@ "payment_method_details_stripe_account", "payment_method_details_us_bank_account", "payment_method_details_wechat", - "payment_method_details_wechat_pay" + "payment_method_details_wechat_pay", + "payment_method_details_zip" ] } }, @@ -28773,6 +29033,10 @@ "type": "string" } }, + "required": [ + "buyer_id", + "cashtag" + ], "title": "payment_method_details_cashapp", "type": "object", "x-expandableFields": [], @@ -29950,6 +30214,17 @@ "in_class": "payment_method_details" } }, + "payment_method_details_zip": { + "description": "", + "properties": {}, + "title": "payment_method_details_zip", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Zip", + "in_class": "payment_method_details" + } + }, "payment_method_eps": { "description": "", "properties": { @@ -30155,6 +30430,12 @@ "nullable": true, "type": "string" }, + "description": { + "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" @@ -30175,6 +30456,18 @@ "nullable": true, "type": "string" }, + "iin": { + "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "issuer": { + "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "last4": { "description": "The last four digits of the card.", "maxLength": 5000, @@ -30702,10 +30995,12 @@ "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ + "aba", "iban", "sepa", "sort_code", "spei", + "swift", "zengin" ], "type": "string", @@ -30714,12 +31009,13 @@ "type": "array" }, "type": { - "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "nullable": true, "type": "string", @@ -31175,6 +31471,25 @@ "in_class": "payment_intent_payment_method_options" } }, + "payment_method_options_zip": { + "description": "", + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_zip", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Zip", + "in_class": "payment_intent_payment_method_options" + } + }, "payment_method_oxxo": { "description": "", "properties": {}, @@ -31248,6 +31563,12 @@ "payment_method_paypal": { "description": "", "properties": { + "payer_email": { + "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "payer_id": { "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.", "maxLength": 5000, @@ -31543,6 +31864,17 @@ "in_class": "payment_method" } }, + "payment_method_zip": { + "description": "", + "properties": {}, + "title": "payment_method_zip", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Zip", + "in_class": "payment_method" + } + }, "payment_pages_checkout_session_after_expiration": { "description": "", "properties": { @@ -31890,6 +32222,16 @@ "payment_pages_checkout_session_custom_fields_numeric": { "description": "", "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "nullable": true, + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "nullable": true, + "type": "integer" + }, "value": { "description": "The value entered by the customer, containing only digits.", "maxLength": 5000, @@ -31898,6 +32240,8 @@ } }, "required": [ + "maximum_length", + "minimum_length", "value" ], "title": "PaymentPagesCheckoutSessionCustomFieldsNumeric", @@ -31937,6 +32281,16 @@ "payment_pages_checkout_session_custom_fields_text": { "description": "", "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "nullable": true, + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "nullable": true, + "type": "integer" + }, "value": { "description": "The value entered by the customer.", "maxLength": 5000, @@ -31945,6 +32299,8 @@ } }, "required": [ + "maximum_length", + "minimum_length", "value" ], "title": "PaymentPagesCheckoutSessionCustomFieldsText", @@ -32824,7 +33180,7 @@ } }, "payout": { - "description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nas well as list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving Payouts](https://stripe.com/docs/payouts).", + "description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nas well as list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving payouts](https://stripe.com/docs/payouts)", "properties": { "amount": { "description": "Amount (in %s) to be transferred to your bank account or debit card.", @@ -33192,7 +33548,7 @@ } }, "person": { - "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.\n\nRelated guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).", + "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.\n\nRelated guide: [Handling identity verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information)", "properties": { "account": { "description": "The account the person is associated with.", @@ -34158,33 +34514,60 @@ "description": "Configuration when `flow.type=subscription_cancel`.", "nullable": true }, + "subscription_update": { + "anyOf": [ + { + "$ref": "#/components/schemas/portal_flows_flow_subscription_update" + } + ], + "description": "Configuration when `flow.type=subscription_update`.", + "nullable": true + }, + "subscription_update_confirm": { + "anyOf": [ + { + "$ref": "#/components/schemas/portal_flows_flow_subscription_update_confirm" + } + ], + "description": "Configuration when `flow.type=subscription_update_confirm`.", + "nullable": true + }, "type": { "description": "Type of flow that the customer will go through.", "enum": [ "payment_method_update", - "subscription_cancel" + "subscription_cancel", + "subscription_update", + "subscription_update_confirm" ], - "type": "string", - "x-stripeBypassValidation": true + "type": "string" } }, "required": [ "after_completion", "subscription_cancel", + "subscription_update", + "subscription_update_confirm", "type" ], "title": "PortalFlowsFlow", "type": "object", "x-expandableFields": [ "after_completion", - "subscription_cancel" + "subscription_cancel", + "subscription_update", + "subscription_update_confirm" ], "x-stripeResource": { "class_name": "Flow", "in_class": "billing_portal.session", "inner_classes": [ "portal_flows_flow_after_completion", - "portal_flows_flow_subscription_cancel" + "portal_flows_flow_subscription_cancel", + "portal_flows_flow_subscription_update", + "portal_flows_flow_subscription_update_confirm", + "portal_flows_subscription_update_confirm_discount", + "portal_flows_subscription_update_confirm_item" ] } }, @@ -34259,6 +34642,126 @@ "in_class": "portal_flows_flow" } }, + "portal_flows_flow_subscription_update": { + "description": "", + "properties": { + "subscription": { + "description": "The ID of the subscription to be updated.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "subscription" + ], + "title": "PortalFlowsFlowSubscriptionUpdate", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "SubscriptionUpdate", + "in_class": "portal_flows_flow" + } + }, + "portal_flows_flow_subscription_update_confirm": { + "description": "", + "properties": { + "discounts": { + "description": "The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.", + "items": { + "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_discount" + }, + "nullable": true, + "type": "array" + }, + "items": { + "description": "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.", + "items": { + "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_item" + }, + "type": "array" + }, + "subscription": { + "description": "The ID of the subscription to be updated.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "discounts", + "items", + "subscription" + ], + "title": "PortalFlowsFlowSubscriptionUpdateConfirm", + "type": "object", + "x-expandableFields": [ + "discounts", + "items" + ], + "x-stripeResource": { + "class_name": "SubscriptionUpdateConfirm", + "in_class": "portal_flows_flow" + } + }, + "portal_flows_subscription_update_confirm_discount": { + "description": "", + "properties": { + "coupon": { + "description": "The ID of the coupon to apply to this subscription update.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "promotion_code": { + "description": "The ID of a promotion code to apply to this subscription update.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "coupon", + "promotion_code" + ], + "title": "PortalFlowsSubscriptionUpdateConfirmDiscount", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Discount", + "in_class": "portal_flows_flow" + } + }, + "portal_flows_subscription_update_confirm_item": { + "description": "", + "properties": { + "id": { + "description": "The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "price": { + "description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "quantity": { + "description": "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.", + "type": "integer" + } + }, + "required": [ + "id", + "price" + ], + "title": "PortalFlowsSubscriptionUpdateConfirmItem", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Item", + "in_class": "portal_flows_flow" + } + }, "portal_invoice_list": { "description": "", "properties": { @@ -36202,7 +36705,7 @@ } }, "radar.early_fraud_warning": { - "description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings).", + "description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)", "properties": { "actionable": { "description": "An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.", @@ -36312,7 +36815,7 @@ } }, "radar.value_list": { - "description": "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items).", + "description": "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)", "properties": { "alias": { "description": "The name of the value list for use in rules.", @@ -36474,7 +36977,7 @@ } }, "radar.value_list_item": { - "description": "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items).", + "description": "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -36754,7 +37257,7 @@ } }, "refund": { - "description": "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds).", + "description": "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)", "properties": { "amount": { "description": "Amount, in %s.", @@ -38743,7 +39246,7 @@ } }, "setup_intent": { - "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent as soon as you're ready to collect your customer's payment credentials.\nDo not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.\nThe SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,\nit will automatically attach the resulting payment method to that Customer.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you ensure that your customers experience the minimum set of required friction,\neven as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).", + "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent as soon as you're ready to collect your customer's payment credentials.\nDo not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.\nThe SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,\nit will automatically attach the resulting payment method to that Customer.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you ensure that your customers experience the minimum set of required friction,\neven as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)", "properties": { "application": { "anyOf": [ @@ -41864,7 +42367,7 @@ } }, "subscription": { - "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating Subscriptions](https://stripe.com/docs/billing/subscriptions/creating).", + "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)", "properties": { "application": { "anyOf": [ @@ -42747,7 +43250,7 @@ } }, "subscription_schedule": { - "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription Schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules).", + "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)", "properties": { "application": { "anyOf": [ @@ -43921,7 +44424,7 @@ } }, "tax.calculation": { - "description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom).", + "description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)", "properties": { "amount_total": { "description": "Total after taxes.", @@ -44179,7 +44682,7 @@ } }, "tax.transaction": { - "description": "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction).", + "description": "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -44579,7 +45082,7 @@ } }, "tax_id": { - "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers).\nA customer's tax IDs are displayed on invoices and credit notes issued for the customer.\n\nRelated guide: [Customer Tax Identification Numbers](https://stripe.com/docs/billing/taxes/tax-ids).", + "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers).\nA customer's tax IDs are displayed on invoices and credit notes issued for the customer.\n\nRelated guide: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids)", "properties": { "country": { "description": "Two-letter ISO code representing the country of the tax ID.", @@ -45196,6 +45699,27 @@ "tax_rate_details": { "$ref": "#/components/schemas/tax_product_resource_tax_rate_details" }, + "taxability_reason": { + "description": "The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.", + "enum": [ + "customer_exempt", + "not_collecting", + "not_subject_to_tax", + "not_supported", + "portion_product_exempt", + "portion_reduced_rated", + "portion_standard_rated", + "product_exempt", + "product_exempt_holiday", + "proportionally_rated", + "reduced_rated", + "reverse_charge", + "standard_rated", + "taxable_basis_reduced", + "zero_rated" + ], + "type": "string" + }, "taxable_amount": { "description": "The amount on which tax is calculated, in integer cents.", "type": "integer" @@ -45205,6 +45729,7 @@ "amount", "inclusive", "tax_rate_details", + "taxability_reason", "taxable_amount" ], "title": "TaxProductResourceTaxBreakdown", @@ -45420,7 +45945,7 @@ } }, "tax_rate": { - "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).", + "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)", "properties": { "active": { "description": "Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", @@ -45501,6 +46026,8 @@ "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ + "amusement_tax", + "communications_tax", "gst", "hst", "igst", @@ -45670,7 +46197,7 @@ } }, "terminal.connection_token": { - "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations).", + "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)", "properties": { "location": { "description": "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens).", @@ -45713,7 +46240,7 @@ } }, "terminal.location": { - "description": "A Location represents a grouping of readers.\n\nRelated guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations).", + "description": "A Location represents a grouping of readers.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)", "properties": { "address": { "$ref": "#/components/schemas/address" @@ -45811,7 +46338,7 @@ } }, "terminal.reader": { - "description": "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader).", + "description": "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)", "properties": { "action": { "anyOf": [ @@ -46749,7 +47276,7 @@ } }, "token": { - "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. You should use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\nclient-side. This ensures that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you cannot use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. Keep in mind that if\nyour integration uses this method, you are responsible for any PCI compliance\nthat may be required, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information is not sent directly to\nStripe, so we cannot determine how it is handled or stored.\n\nTokens cannot be stored or used more than once. To store card or bank account\ninformation for later use, you can create [Customer](https://stripe.com/docs/api#customers)\nobjects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.\n\nRelated guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token)", + "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. You should use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\nclient-side. This ensures that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you cannot use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. Keep in mind that if\nyour integration uses this method, you are responsible for any PCI compliance\nthat may be required, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information is not sent directly to\nStripe, so we cannot determine how it is handled or stored.\n\nTokens cannot be stored or used more than once. To store card or bank account\ninformation for later use, you can create [Customer](https://stripe.com/docs/api#customers)\nobjects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.", "properties": { "bank_account": { "$ref": "#/components/schemas/bank_account" @@ -46832,7 +47359,7 @@ } }, "topup": { - "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups).", + "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)", "properties": { "amount": { "description": "Amount transferred.", @@ -47020,7 +47547,7 @@ } }, "transfer": { - "description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://stripe.com/docs/transfer-payout-split).\n\nRelated guide: [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers).", + "description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://stripe.com/docs/transfer-payout-split).\n\nRelated guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/charges-transfers)", "properties": { "amount": { "description": "Amount in %s to be transferred.", @@ -47310,7 +47837,7 @@ } }, "transfer_reversal": { - "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/charges-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers).", + "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/charges-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers)", "properties": { "amount": { "description": "Amount, in %s.", @@ -50852,7 +51379,7 @@ } }, "usage_record": { - "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered Billing](https://stripe.com/docs/billing/subscriptions/metered-billing).", + "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)", "properties": { "id": { "description": "Unique identifier for the object.", @@ -51006,7 +51533,7 @@ } }, "webhook_endpoint": { - "description": "You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up Webhooks](https://stripe.com/docs/webhooks/configure).", + "description": "You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure)", "properties": { "api_version": { "description": "The API version events are rendered as for this webhook endpoint.", @@ -52013,6 +52540,17 @@ }, "title": "capability_param", "type": "object" + }, + "zip_payments": { + "description": "The zip_payments capability.", + "properties": { + "requested": { + "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" } }, "title": "capabilities_param", @@ -53752,6 +54290,17 @@ }, "title": "capability_param", "type": "object" + }, + "zip_payments": { + "description": "The zip_payments capability.", + "properties": { + "requested": { + "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" } }, "title": "capabilities_param", @@ -60018,14 +60567,93 @@ "title": "flow_data_subscription_cancel_param", "type": "object" }, + "subscription_update": { + "description": "Configuration when `flow_data.type=subscription_update`.", + "properties": { + "subscription": { + "description": "The ID of the subscription to be updated.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "subscription" + ], + "title": "flow_data_subscription_update_param", + "type": "object" + }, + "subscription_update_confirm": { + "description": "Configuration when `flow_data.type=subscription_update_confirm`.", + "properties": { + "discounts": { + "description": "The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.", + "items": { + "properties": { + "coupon": { + "description": "The ID of the coupon to apply to this subscription update.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "The ID of a promotion code to apply to this subscription update.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "subscription_update_confirm_discount_params", + "type": "object" + }, + "type": "array" + }, + "items": { + "description": "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.", + "items": { + "properties": { + "id": { + "description": "The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.", + "maxLength": 5000, + "type": "string" + }, + "price": { + "description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).", + "maxLength": 5000, + "type": "string" + }, + "quantity": { + "description": "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.", + "type": "integer" + } + }, + "required": [ + "id" + ], + "title": "subscription_update_confirm_item_params", + "type": "object" + }, + "type": "array" + }, + "subscription": { + "description": "The ID of the subscription to be updated.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "items", + "subscription" + ], + "title": "flow_data_subscription_update_confirm_param", + "type": "object" + }, "type": { "description": "Type of flow that the customer will go through.", "enum": [ "payment_method_update", - "subscription_cancel" + "subscription_cancel", + "subscription_update", + "subscription_update_confirm" ], - "type": "string", - "x-stripeBypassValidation": true + "type": "string" } }, "required": [ @@ -60322,7 +60950,7 @@ } }, "post": { - "description": "

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

", + "description": "

Use the Payment Intents API to initiate a new payment instead\nof using this method. Confirmation of the PaymentIntent creates the Charge\nobject used to request payment, so this method is limited to legacy integrations.

", "operationId": "PostCharges", "requestBody": { "content": { @@ -60991,7 +61619,7 @@ }, "/v1/charges/{charge}/capture": { "post": { - "description": "

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

\n\n

Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

", + "description": "

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

\n\n

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

\n\n

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

", "operationId": "PostChargesChargeCapture", "parameters": [ { @@ -61748,10 +62376,40 @@ "title": "custom_field_label_param", "type": "object" }, + "numeric": { + "description": "Configuration for `type=numeric` fields.", + "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "type": "integer" + } + }, + "title": "custom_field_numeric_param", + "type": "object" + }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, + "text": { + "description": "Configuration for `type=text` fields.", + "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "type": "integer" + } + }, + "title": "custom_field_text_param", + "type": "object" + }, "type": { "description": "The type of the field.", "enum": [ @@ -62683,10 +63341,12 @@ "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ + "aba", "iban", "sepa", "sort_code", "spei", + "swift", "zengin" ], "type": "string", @@ -62700,7 +63360,8 @@ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true @@ -63116,7 +63777,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -68302,7 +68964,8 @@ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true @@ -68466,7 +69129,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -71544,6 +72208,7 @@ }, "file": { "description": "A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol).", + "format": "binary", "type": "string" }, "file_link_data": { @@ -72876,7 +73541,7 @@ } }, "post": { - "description": "

Creates a VerificationSession object.

\n\n

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

\n\n

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

\n\n

Related guide: Verify your users’ identity documents.

", + "description": "

Creates a VerificationSession object.

\n\n

After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

\n\n

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

\n\n

Related guide: Verify your users’ identity documents

", "operationId": "PostIdentityVerificationSessions", "requestBody": { "content": { @@ -74531,7 +75196,7 @@ "type": "integer" }, "auto_advance": { - "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.", + "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", "type": "boolean" }, "automatic_tax": { @@ -74898,7 +75563,7 @@ "type": "object" }, "type": { - "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, @@ -77670,7 +78335,7 @@ "type": "integer" }, "auto_advance": { - "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice.", + "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.", "type": "boolean" }, "automatic_tax": { @@ -78024,7 +78689,7 @@ "type": "object" }, "type": { - "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, @@ -78520,7 +79185,7 @@ "additionalProperties": false, "properties": { "auto_advance": { - "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action.", + "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", "type": "boolean" }, "expand": { @@ -79766,6 +80431,10 @@ "explode": true, "style": "deepObject" }, + "preferred_locales": { + "explode": true, + "style": "deepObject" + }, "spending_controls": { "explode": true, "style": "deepObject" @@ -79957,6 +80626,20 @@ "description": "The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.", "type": "string" }, + "preferred_locales": { + "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", + "items": { + "enum": [ + "de", + "en", + "es", + "fr", + "it" + ], + "type": "string" + }, + "type": "array" + }, "spending_controls": { "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { @@ -81071,6 +81754,10 @@ "explode": true, "style": "deepObject" }, + "preferred_locales": { + "explode": true, + "style": "deepObject" + }, "spending_controls": { "explode": true, "style": "deepObject" @@ -81258,6 +81945,20 @@ "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.", "type": "string" }, + "preferred_locales": { + "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.", + "items": { + "enum": [ + "de", + "en", + "es", + "fr", + "it" + ], + "type": "string" + }, + "type": "array" + }, "spending_controls": { "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { @@ -87749,7 +88450,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -87797,6 +88499,12 @@ "properties": {}, "title": "param", "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" } }, "required": [ @@ -88443,10 +89151,12 @@ "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ + "aba", "iban", "sepa", "sort_code", "spei", + "swift", "zengin" ], "type": "string", @@ -88455,12 +89165,13 @@ "type": "array" }, "type": { - "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true @@ -89227,6 +89938,30 @@ } ], "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options." + }, + "zip": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options." } }, "title": "payment_method_options_param", @@ -90287,7 +91022,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -90335,6 +91071,12 @@ "properties": {}, "title": "param", "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" } }, "required": [ @@ -90981,10 +91723,12 @@ "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ + "aba", "iban", "sepa", "sort_code", "spei", + "swift", "zengin" ], "type": "string", @@ -90993,12 +91737,13 @@ "type": "array" }, "type": { - "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true @@ -91765,6 +92510,30 @@ } ], "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options." + }, + "zip": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options." } }, "title": "payment_method_options_param", @@ -92212,7 +92981,7 @@ }, "/v1/payment_intents/{intent}/confirm": { "post": { - "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent will transition to the requires_payment_method status. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt. Read the expanded documentation\nto learn more about manual confirmation.

", + "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).\nIf the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt. Read the expanded documentation\nto learn more about manual confirmation.

", "operationId": "PostPaymentIntentsIntentConfirm", "parameters": [ { @@ -92963,7 +93732,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -93011,6 +93781,12 @@ "properties": {}, "title": "param", "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" } }, "required": [ @@ -93657,10 +94433,12 @@ "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.", "items": { "enum": [ + "aba", "iban", "sepa", "sort_code", "spei", + "swift", "zengin" ], "type": "string", @@ -93669,12 +94447,13 @@ "type": "array" }, "type": { - "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "enum": [ "eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", - "mx_bank_transfer" + "mx_bank_transfer", + "us_bank_transfer" ], "type": "string", "x-stripeBypassValidation": true @@ -94441,6 +95220,30 @@ } ], "description": "If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options." + }, + "zip": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options." } }, "title": "payment_method_options_param", @@ -95181,10 +95984,40 @@ "title": "custom_field_label_param", "type": "object" }, + "numeric": { + "description": "Configuration for `type=numeric` fields.", + "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "type": "integer" + } + }, + "title": "custom_field_numeric_param", + "type": "object" + }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, + "text": { + "description": "Configuration for `type=text` fields.", + "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "type": "integer" + } + }, + "title": "custom_field_text_param", + "type": "object" + }, "type": { "description": "The type of the field.", "enum": [ @@ -96179,10 +97012,40 @@ "title": "custom_field_label_param", "type": "object" }, + "numeric": { + "description": "Configuration for `type=numeric` fields.", + "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "type": "integer" + } + }, + "title": "custom_field_numeric_param", + "type": "object" + }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, + "text": { + "description": "Configuration for `type=text` fields.", + "properties": { + "maximum_length": { + "description": "The maximum character length constraint for the customer's input.", + "type": "integer" + }, + "minimum_length": { + "description": "The minimum character length requirement for the customer's input.", + "type": "integer" + } + }, + "title": "custom_field_text_param", + "type": "object" + }, "type": { "description": "The type of the field.", "enum": [ @@ -97049,7 +97912,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -97275,6 +98139,10 @@ "wechat_pay": { "explode": true, "style": "deepObject" + }, + "zip": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -97889,7 +98757,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -97937,6 +98806,12 @@ "properties": {}, "title": "param", "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" } }, "type": "object" @@ -98106,6 +98981,10 @@ "us_bank_account": { "explode": true, "style": "deepObject" + }, + "zip": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -98291,6 +99170,12 @@ }, "title": "update_param", "type": "object" + }, + "zip": { + "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.", + "properties": {}, + "title": "param", + "type": "object" } }, "type": "object" @@ -108338,7 +109223,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -108386,6 +109272,12 @@ "properties": {}, "title": "param", "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" } }, "required": [ @@ -109496,7 +110388,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -109544,6 +110437,12 @@ "properties": {}, "title": "param", "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" } }, "required": [ @@ -109983,7 +110882,7 @@ }, "/v1/setup_intents/{intent}/confirm": { "post": { - "description": "

Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.

\n\n

If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.

\n\n

Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status.

", + "description": "

Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.

\n\n

If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.

\n\n

Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status or the canceled status if the\nconfirmation limit is reached.

", "operationId": "PostSetupIntentsIntentConfirm", "parameters": [ { @@ -110684,7 +111583,8 @@ "sepa_debit", "sofort", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -110732,6 +111632,12 @@ "properties": {}, "title": "param", "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" } }, "required": [ @@ -116845,7 +117751,7 @@ "type": "object" }, "type": { - "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, @@ -118177,7 +119083,7 @@ "type": "object" }, "type": { - "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.", + "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.", "type": "string" } }, @@ -119960,6 +120866,8 @@ "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ + "amusement_tax", + "communications_tax", "gst", "hst", "igst", @@ -120164,6 +121072,8 @@ "tax_type": { "description": "The high-level tax type, such as `vat` or `sales_tax`.", "enum": [ + "amusement_tax", + "communications_tax", "gst", "hst", "igst", diff --git a/pkg/cmd/resources_cmds.go b/pkg/cmd/resources_cmds.go index 57cd65d76..5f1dd9aee 100644 --- a/pkg/cmd/resources_cmds.go +++ b/pkg/cmd/resources_cmds.go @@ -206,6 +206,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "capabilities.transfers.requested": "boolean", "capabilities.treasury.requested": "boolean", "capabilities.us_bank_account_ach_payments.requested": "boolean", + "capabilities.zip_payments.requested": "boolean", "company.address.city": "string", "company.address.country": "string", "company.address.line1": "string", @@ -398,6 +399,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "capabilities.transfers.requested": "boolean", "capabilities.treasury.requested": "boolean", "capabilities.us_bank_account_ach_payments.requested": "boolean", + "capabilities.zip_payments.requested": "boolean", "company.address.city": "string", "company.address.country": "string", "company.address.line1": "string", @@ -2791,6 +2793,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "flow_data.after_completion.redirect.return_url": "string", "flow_data.after_completion.type": "string", "flow_data.subscription_cancel.subscription": "string", + "flow_data.subscription_update.subscription": "string", + "flow_data.subscription_update_confirm.subscription": "string", "flow_data.type": "string", "locale": "string", "on_behalf_of": "string", @@ -3023,6 +3027,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "individual.verification.document.front": "string", "name": "string", "phone_number": "string", + "preferred_locales": "array", "spending_controls.allowed_categories": "array", "spending_controls.blocked_categories": "array", "spending_controls.spending_limits_currency": "string", @@ -3060,6 +3065,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "individual.verification.document.back": "string", "individual.verification.document.front": "string", "phone_number": "string", + "preferred_locales": "array", "spending_controls.allowed_categories": "array", "spending_controls.blocked_categories": "array", "spending_controls.spending_limits_currency": "string",