diff --git a/api/openapi-spec/spec3.sdk.json b/api/openapi-spec/spec3.sdk.json index 463a44bbe..b080725e5 100644 --- a/api/openapi-spec/spec3.sdk.json +++ b/api/openapi-spec/spec3.sdk.json @@ -382,7 +382,7 @@ "description": "", "properties": { "amount": { - "description": "A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "nullable": true, "type": "integer" }, @@ -518,7 +518,7 @@ "type": "integer" }, "mcc": { - "description": "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", + "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 5000, "nullable": true, "type": "string" @@ -1048,8 +1048,19 @@ "type": "array" }, "disabled_reason": { - "description": "This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account.", - "maxLength": 5000, + "description": "This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.", + "enum": [ + "other", + "paused.inactivity", + "pending.onboarding", + "pending.review", + "platform_disabled", + "platform_paused", + "rejected.inactivity", + "rejected.other", + "rejected.unsupported_business", + "requirements.fields_needed" + ], "nullable": true, "type": "string" }, @@ -1128,8 +1139,19 @@ "type": "array" }, "disabled_reason": { - "description": "If the capability is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `requirements.fields_needed`, `pending.onboarding`, `pending.review`, `rejected.other`, `platform_paused`, `rejected.inactivty`, or `rejected.unsupported_business`.\n\n`rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service, such as in [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses).\n\n`rejected.inactivity` means that the capability has been paused for inactivity. This disabled reason currently only applies to the Issuing capability. See [Issuing: Managing Inactive Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) for more details.", - "maxLength": 5000, + "description": "Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).", + "enum": [ + "other", + "paused.inactivity", + "pending.onboarding", + "pending.review", + "platform_disabled", + "platform_paused", + "rejected.inactivity", + "rejected.other", + "rejected.unsupported_business", + "requirements.fields_needed" + ], "nullable": true, "type": "string" }, @@ -1450,7 +1472,7 @@ "description": "", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -2167,10 +2189,6 @@ "bank_account_unverified", "bank_account_verification_failed", "billing_invalid_mandate", - "billing_policy_remote_function_response_invalid", - "billing_policy_remote_function_timeout", - "billing_policy_remote_function_unexpected_status_code", - "billing_policy_remote_function_unreachable", "bitcoin_upgrade_required", "capture_charge_authorization_expired", "capture_unauthorized_payment", @@ -3692,7 +3710,7 @@ "additionalProperties": { "type": "integer" }, - "description": "The balances owed to (or by) the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", + "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "type": "object" }, "type": { @@ -3723,7 +3741,7 @@ "additionalProperties": { "type": "integer" }, - "description": "The funds available to the account holder. Typically this is the current balance less any holds.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", + "description": "The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "nullable": true, "type": "object" } @@ -3790,6 +3808,21 @@ "bank_connections_resource_link_account_session_filters": { "description": "", "properties": { + "account_subcategories": { + "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", + "items": { + "enum": [ + "checking", + "credit_card", + "line_of_credit", + "mortgage", + "savings" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, "countries": { "description": "List of countries from which to filter accounts.", "items": { @@ -3801,6 +3834,7 @@ } }, "required": [ + "account_subcategories", "countries" ], "title": "BankConnectionsResourceLinkAccountSessionFilters", @@ -4196,7 +4230,7 @@ "type": "number" }, "end_time": { - "description": "End timestamp for this event summary (inclusive).", + "description": "End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.", "format": "unix-time", "type": "integer" }, @@ -4222,7 +4256,7 @@ "type": "string" }, "start_time": { - "description": "Start timestamp for this event summary (inclusive).", + "description": "Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.", "format": "unix-time", "type": "integer" } @@ -4572,7 +4606,7 @@ } }, "billing_portal.session": { - "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nLearn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).", + "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nRelated guide: [Customer management](/customer-management)", "properties": { "configuration": { "anyOf": [ @@ -5453,7 +5487,7 @@ "$ref": "#/components/schemas/billing_details" }, "calculated_statement_descriptor": { - "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.", + "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This only works for card payments.", "maxLength": 5000, "nullable": true, "type": "string" @@ -6966,6 +7000,13 @@ "operation": "post", "path": "/v1/checkout/sessions" }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/checkout/sessions/{session}" + }, { "method_name": "expire", "method_on": "service", @@ -8607,6 +8648,15 @@ "nullable": true, "type": "string" }, + "payment_method_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options" + } + ], + "description": "Payment-method-specific configuration for this ConfirmationToken.", + "nullable": true + }, "payment_method_preview": { "anyOf": [ { @@ -8658,6 +8708,7 @@ "livemode", "object", "payment_intent", + "payment_method_options", "payment_method_preview", "return_url", "setup_future_usage", @@ -8669,6 +8720,7 @@ "type": "object", "x-expandableFields": [ "mandate_data", + "payment_method_options", "payment_method_preview", "shipping" ], @@ -8762,6 +8814,45 @@ "type": "object", "x-expandableFields": [] }, + "confirmation_tokens_resource_payment_method_options": { + "description": "Payment-method-specific configuration", + "properties": { + "card": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card" + } + ], + "description": "This hash contains the card payment method options.", + "nullable": true + } + }, + "required": [ + "card" + ], + "title": "ConfirmationTokensResourcePaymentMethodOptions", + "type": "object", + "x-expandableFields": [ + "card" + ] + }, + "confirmation_tokens_resource_payment_method_options_resource_card": { + "description": "This hash contains the card payment method options.", + "properties": { + "cvc_token": { + "description": "The `cvc_update` Token collected from the Payment Element.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "cvc_token" + ], + "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard", + "type": "object", + "x-expandableFields": [] + }, "confirmation_tokens_resource_payment_method_preview": { "description": "Details of the PaymentMethod collected by Payment Element", "properties": { @@ -8816,6 +8907,26 @@ "cashapp": { "$ref": "#/components/schemas/payment_method_cashapp" }, + "customer": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/customer" + } + ], + "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/customer" + } + ] + } + }, "customer_balance": { "$ref": "#/components/schemas/payment_method_customer_balance" }, @@ -8943,6 +9054,7 @@ }, "required": [ "billing_details", + "customer", "type" ], "title": "ConfirmationTokensResourcePaymentMethodPreview", @@ -8962,6 +9074,7 @@ "card", "card_present", "cashapp", + "customer", "customer_balance", "eps", "fpx", @@ -9200,6 +9313,12 @@ }, "payouts_list": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" + }, + "tax_registrations": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" + }, + "tax_settings": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" } }, "required": [ @@ -9211,7 +9330,9 @@ "payment_details", "payments", "payouts", - "payouts_list" + "payouts_list", + "tax_registrations", + "tax_settings" ], "title": "ConnectEmbeddedAccountSessionCreateComponents", "type": "object", @@ -9224,7 +9345,9 @@ "payment_details", "payments", "payouts", - "payouts_list" + "payouts_list", + "tax_registrations", + "tax_settings" ], "x-stripeResource": { "class_name": "Components", @@ -10622,7 +10745,7 @@ "type": "string" }, "next_invoice_sequence": { - "description": "The suffix of the customer's next invoice number (for example, 0001).", + "description": "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.", "type": "integer" }, "object": { @@ -11059,7 +11182,7 @@ } }, "customer.source.expiring": { - "description": "Occurs whenever a card or source will expire at the end of the month.", + "description": "Occurs whenever a card or source will expire at the end of the month. This event only works with legacy integrations using Card or Source objects. If you use the PaymentMethod API, this event won't occur.", "properties": { "object": { "anyOf": [ @@ -12115,10 +12238,10 @@ } }, "customer_session": { - "description": "A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs)\ncontrol over a customer.", + "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.", "properties": { "client_secret": { - "description": "The client secret of this customer session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.", + "description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.", "maxLength": 5000, "type": "string" }, @@ -12140,7 +12263,7 @@ "$ref": "#/components/schemas/customer" } ], - "description": "The customer the customer session was created for.", + "description": "The Customer the Customer Session was created for.", "x-expansionResources": { "oneOf": [ { @@ -12150,7 +12273,7 @@ } }, "expires_at": { - "description": "The timestamp at which this customer session will expire.", + "description": "The timestamp at which this Customer Session will expire.", "format": "unix-time", "type": "integer" }, @@ -12196,23 +12319,28 @@ } }, "customer_session_resource_components": { - "description": "Configuration for the components supported by this customer session.", + "description": "Configuration for the components supported by this Customer Session.", "properties": { "buy_button": { "$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button" }, + "payment_element": { + "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element" + }, "pricing_table": { "$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table" } }, "required": [ "buy_button", + "payment_element", "pricing_table" ], "title": "CustomerSessionResourceComponents", "type": "object", "x-expandableFields": [ "buy_button", + "payment_element", "pricing_table" ] }, @@ -12231,6 +12359,102 @@ "type": "object", "x-expandableFields": [] }, + "customer_session_resource_components_resource_payment_element": { + "description": "This hash contains whether the Payment Element is enabled and the features it supports.", + "properties": { + "enabled": { + "description": "Whether the Payment Element is enabled.", + "type": "boolean" + }, + "features": { + "anyOf": [ + { + "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features" + } + ], + "description": "This hash defines whether the Payment Element supports certain features.", + "nullable": true + } + }, + "required": [ + "enabled", + "features" + ], + "title": "CustomerSessionResourceComponentsResourcePaymentElement", + "type": "object", + "x-expandableFields": [ + "features" + ] + }, + "customer_session_resource_components_resource_payment_element_resource_features": { + "description": "This hash contains the features the Payment Element supports.", + "properties": { + "payment_method_allow_redisplay_filters": { + "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].", + "items": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_redisplay": { + "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_redisplay_limit": { + "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `10`.", + "nullable": true, + "type": "integer" + }, + "payment_method_remove": { + "description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save": { + "description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save_usage": { + "description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.", + "enum": [ + "off_session", + "on_session" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "payment_method_allow_redisplay_filters", + "payment_method_redisplay", + "payment_method_redisplay_limit", + "payment_method_remove", + "payment_method_save", + "payment_method_save_usage" + ], + "title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures", + "type": "object", + "x-expandableFields": [] + }, "customer_session_resource_components_resource_pricing_table": { "description": "This hash contains whether the pricing table is enabled.", "properties": { @@ -14210,6 +14434,15 @@ "maxLength": 5000, "type": "string" }, + "case_type": { + "description": "The type of dispute opened. Different case types may have varying fees and financial impact.", + "enum": [ + "chargeback", + "inquiry" + ], + "type": "string", + "x-stripeBypassValidation": true + }, "network_reason_code": { "description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.", "maxLength": 5000, @@ -14219,6 +14452,7 @@ }, "required": [ "brand", + "case_type", "network_reason_code" ], "title": "DisputePaymentMethodDetailsCard", @@ -14772,6 +15006,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -14780,6 +15015,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -14792,6 +15028,7 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_personalization_design.activated", @@ -17953,7 +18190,7 @@ ] }, "identity.verification_report": { - "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", + "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", "properties": { "client_reference_id": { "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", @@ -19461,6 +19698,13 @@ "operation": "post", "path": "/v1/invoices/{invoice}" }, + { + "method_name": "add_lines", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/{invoice}/add_lines" + }, { "method_name": "finalize_invoice", "method_on": "service", @@ -19482,6 +19726,13 @@ "operation": "post", "path": "/v1/invoices/{invoice}/pay" }, + { + "method_name": "remove_lines", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/{invoice}/remove_lines" + }, { "method_name": "send_invoice", "method_on": "service", @@ -19489,6 +19740,13 @@ "operation": "post", "path": "/v1/invoices/{invoice}/send" }, + { + "method_name": "update_lines", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/{invoice}/update_lines" + }, { "method_name": "void_invoice", "method_on": "service", @@ -19591,6 +19849,22 @@ "type": "invoice.marked_uncollectible" } }, + "invoice.overdue": { + "description": "Occurs X number of days after an invoice becomes due—where X is determined by Automations", + "properties": { + "object": { + "$ref": "#/components/schemas/invoice" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "invoice.overdue" + } + }, "invoice.paid": { "description": "Occurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.", "properties": { @@ -19719,6 +19993,22 @@ "type": "invoice.voided" } }, + "invoice.will_be_due": { + "description": "Occurs X number of days before an invoice becomes due—where X is determined by Automations", + "properties": { + "object": { + "$ref": "#/components/schemas/invoice" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "invoice.will_be_due" + } + }, "invoice_installments_card": { "description": "", "properties": { @@ -20012,6 +20302,9 @@ "invoice_payment_method_options_us_bank_account_linked_account_options": { "description": "", "properties": { + "filters": { + "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters" + }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { @@ -20045,6 +20338,27 @@ ], "title": "invoice_payment_method_options_us_bank_account_linked_account_options", "type": "object", + "x-expandableFields": [ + "filters" + ] + }, + "invoice_payment_method_options_us_bank_account_linked_account_options_filters": { + "description": "", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters", + "type": "object", "x-expandableFields": [] }, "invoice_rendering_pdf": { @@ -20909,6 +21223,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -21010,7 +21325,7 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -21028,6 +21343,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -21314,6 +21630,24 @@ "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "type": "string" }, + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_data" + } + ], + "description": "Fleet-specific information for authorizations using Fleet cards.", + "nullable": true + }, + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fuel_data" + } + ], + "description": "Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -21439,6 +21773,8 @@ "cardholder", "created", "currency", + "fleet", + "fuel", "id", "livemode", "merchant_amount", @@ -21461,6 +21797,8 @@ "balance_transactions", "card", "cardholder", + "fleet", + "fuel", "merchant_data", "network_data", "pending_request", @@ -21528,6 +21866,13 @@ "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/expire" }, + { + "method_name": "finalize_amount", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount" + }, { "method_name": "increment", "method_on": "service", @@ -23037,6 +23382,274 @@ "type": "object", "x-expandableFields": [] }, + "issuing_authorization_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "alphanumeric_id": { + "description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "alphanumeric_id", + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ], + "title": "IssuingAuthorizationFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data" + } + ], + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown" + } + ], + "description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ], + "title": "IssuingAuthorizationFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_authorization_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingAuthorizationFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingAuthorizationFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "required": [ + "fuel", + "non_fuel", + "tax" + ], + "title": "IssuingAuthorizationFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_authorization_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "description": "Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.", + "format": "decimal", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "description": "Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "local_amount_decimal", + "national_amount_decimal" + ], + "title": "IssuingAuthorizationFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fuel_data": { + "description": "", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "nullable": true, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "nullable": true, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ], + "title": "IssuingAuthorizationFuelData", + "type": "object", + "x-expandableFields": [] + }, "issuing_authorization_merchant_data": { "description": "", "properties": { @@ -23253,11 +23866,16 @@ "enum": [ "account_disabled", "card_active", + "card_canceled", + "card_expired", "card_inactive", + "cardholder_blocked", "cardholder_inactive", "cardholder_verification_required", + "insecure_authorization_method", "insufficient_funds", "not_allowed", + "pin_blocked", "spending_controls", "suspected_fraud", "verification_failed", @@ -24188,6 +24806,15 @@ "address": { "$ref": "#/components/schemas/address" }, + "address_validation": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_card_shipping_address_validation" + } + ], + "description": "Address validation details for the shipment.", + "nullable": true + }, "carrier": { "description": "The delivery company that shipped a card.", "enum": [ @@ -24292,9 +24919,53 @@ "type": "object", "x-expandableFields": [ "address", + "address_validation", "customs" ] }, + "issuing_card_shipping_address_validation": { + "description": "", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + }, + "normalized_address": { + "anyOf": [ + { + "$ref": "#/components/schemas/address" + } + ], + "description": "The normalized shipping address.", + "nullable": true + }, + "result": { + "description": "The validation result for the shipping address.", + "enum": [ + "indeterminate", + "likely_deliverable", + "likely_undeliverable" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "mode", + "normalized_address", + "result" + ], + "title": "IssuingCardShippingAddressValidation", + "type": "object", + "x-expandableFields": [ + "normalized_address" + ] + }, "issuing_card_shipping_customs": { "description": "", "properties": { @@ -26036,6 +26707,22 @@ "type": "issuing_dispute.funds_reinstated" } }, + "issuing_dispute.funds_rescinded": { + "description": "Occurs whenever funds are deducted from your account for an Issuing dispute.", + "properties": { + "object": { + "$ref": "#/components/schemas/issuing.dispute" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "issuing_dispute.funds_rescinded" + } + }, "issuing_dispute.submitted": { "description": "Occurs whenever a dispute is submitted.", "properties": { @@ -27255,6 +27942,199 @@ "type": "object", "x-expandableFields": [] }, + "issuing_transaction_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ], + "title": "IssuingTransactionFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data" + } + ], + "description": "Answers to prompts presented to cardholder at point of sale.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown" + } + ], + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ], + "title": "IssuingTransactionFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_transaction_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingTransactionFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingTransactionFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "required": [ + "fuel", + "non_fuel", + "tax" + ], + "title": "IssuingTransactionFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_transaction_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "local_amount_decimal", + "national_amount_decimal" + ], + "title": "IssuingTransactionFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, "issuing_transaction_flight_data": { "description": "", "properties": { @@ -27356,6 +28236,12 @@ "issuing_transaction_fuel_data": { "description": "", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -27379,6 +28265,7 @@ } }, "required": [ + "industry_product_code", "quantity_decimal", "type", "unit", @@ -27444,6 +28331,15 @@ "issuing_transaction_purchase_details": { "description": "", "properties": { + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_data" + } + ], + "description": "Fleet-specific information for transactions using Fleet cards.", + "nullable": true + }, "flight": { "anyOf": [ { @@ -27487,6 +28383,7 @@ } }, "required": [ + "fleet", "flight", "fuel", "lodging", @@ -27496,6 +28393,7 @@ "title": "IssuingTransactionPurchaseDetails", "type": "object", "x-expandableFields": [ + "fleet", "flight", "fuel", "lodging", @@ -28547,6 +29445,9 @@ "linked_account_options_us_bank_account": { "description": "", "properties": { + "filters": { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters" + }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { @@ -28585,7 +29486,9 @@ ], "title": "linked_account_options_us_bank_account", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "filters" + ] }, "login_link": { "description": "Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard.", @@ -29717,6 +30620,25 @@ "type": "object", "x-expandableFields": [] }, + "payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters": { + "description": "", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters", + "type": "object", + "x-expandableFields": [] + }, "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)", "properties": { @@ -29897,7 +30819,7 @@ "$ref": "#/components/schemas/charge" } ], - "description": "The latest charge created by this PaymentIntent.", + "description": "ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -32000,6 +32922,10 @@ "installments": { "$ref": "#/components/schemas/payment_flows_installment_options" }, + "request_incremental_authorization_support": { + "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", + "type": "boolean" + }, "require_cvc_recollection": { "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", "type": "boolean" @@ -32264,6 +33190,7 @@ "konbini", "link", "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -32273,8 +33200,10 @@ "sepa_debit", "sofort", "swish", + "twint", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -34302,6 +35231,12 @@ "nullable": true, "type": "string" }, + "brand_product": { + "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, @@ -34391,6 +35326,7 @@ }, "required": [ "brand", + "brand_product", "cardholder_name", "country", "exp_month", @@ -34878,6 +35814,9 @@ "swish": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, + "twint": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, @@ -34937,6 +35876,7 @@ "sepa_debit", "sofort", "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -35323,7 +36263,17 @@ }, "payment_method_details_affirm": { "description": "", - "properties": {}, + "properties": { + "transaction_id": { + "description": "The Affirm transaction ID associated with this payment.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "transaction_id" + ], "title": "payment_method_details_affirm", "type": "object", "x-expandableFields": [] @@ -35537,7 +36487,17 @@ }, "payment_method_details_blik": { "description": "", - "properties": {}, + "properties": { + "buyer_id": { + "description": "A unique and immutable identifier assigned by BLIK to every buyer.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "buyer_id" + ], "title": "payment_method_details_blik", "type": "object", "x-expandableFields": [] @@ -35846,6 +36806,12 @@ "nullable": true, "type": "string" }, + "brand_product": { + "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "capture_before": { "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.", "format": "unix-time", @@ -35929,6 +36895,12 @@ "nullable": true, "type": "string" }, + "network_transaction_id": { + "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "offline": { "anyOf": [ { @@ -35976,6 +36948,7 @@ "required": [ "amount_authorized", "brand", + "brand_product", "cardholder_name", "country", "emv_auth_data", @@ -35987,6 +36960,7 @@ "incremental_authorization_supported", "last4", "network", + "network_transaction_id", "offline", "overcapture_supported", "preferred_locales", @@ -36683,6 +37657,12 @@ "nullable": true, "type": "string" }, + "network_transaction_id": { + "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "preferred_locales": { "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", "items": { @@ -36726,6 +37706,7 @@ "generated_card", "last4", "network", + "network_transaction_id", "preferred_locales", "read_method", "receipt" @@ -37492,7 +38473,7 @@ "x-expandableFields": [] }, "payment_method_domain": { - "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", + "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", "properties": { "apple_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" @@ -40335,7 +41316,7 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -40353,6 +41334,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -41774,6 +42756,7 @@ "interval_count", "livemode", "metadata", + "meter", "nickname", "object", "product", @@ -45020,6 +46003,7 @@ "aggregate_usage", "interval", "interval_count", + "meter", "trial_period_days", "usage_type" ], @@ -52504,6 +53488,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -52523,7 +53508,7 @@ "type": "array" }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.", "enum": [ "off", "on_subscription" @@ -52677,7 +53662,7 @@ "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.", + "description": "Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -53218,6 +54203,11 @@ ], "type": "string" }, + "posted_at": { + "description": "The Unix timestamp representing when the tax liability is assumed or reduced.", + "format": "unix-time", + "type": "integer" + }, "reference": { "description": "A custom unique identifier, such as 'myOrder_123'.", "maxLength": 5000, @@ -53273,6 +54263,7 @@ "livemode", "metadata", "object", + "posted_at", "reference", "reversal", "ship_from_details", @@ -53683,7 +54674,7 @@ "nullable": true }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -53701,6 +54692,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -54404,7 +55396,7 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -54422,6 +55414,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -55276,6 +56269,9 @@ "offline": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config" }, + "reboot_window": { + "$ref": "#/components/schemas/terminal_configuration_configuration_resource_reboot_window" + }, "stripe_s700": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" }, @@ -55298,6 +56294,7 @@ "x-expandableFields": [ "bbpos_wisepos_e", "offline", + "reboot_window", "stripe_s700", "tipping", "verifone_p400" @@ -55506,7 +56503,7 @@ "type": "string" }, "device_type": { - "description": "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.", + "description": "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.", "enum": [ "bbpos_chipper2x", "bbpos_wisepad3", @@ -55514,6 +56511,7 @@ "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", + "stripe_s700", "verifone_P400" ], "type": "string" @@ -55799,6 +56797,26 @@ "type": "object", "x-expandableFields": [] }, + "terminal_configuration_configuration_resource_reboot_window": { + "description": "", + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "TerminalConfigurationConfigurationResourceRebootWindow", + "type": "object", + "x-expandableFields": [] + }, "terminal_configuration_configuration_resource_tipping": { "description": "", "properties": { @@ -60480,7 +61498,8 @@ "inbound_flows", "outbound_flows" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -61725,7 +62744,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2024-04-10", + "version": "2024-06-20", "x-stripeSpecFilename": "spec3.sdk" }, "openapi": "3.0.0", @@ -62196,6 +63215,46 @@ ], "title": "base_config_param", "type": "object" + }, + "tax_registrations": { + "description": "Configuration for the tax registrations embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": {}, + "title": "base_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "base_config_param", + "type": "object" + }, + "tax_settings": { + "description": "Configuration for the tax settings embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": {}, + "title": "base_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "base_config_param", + "type": "object" } }, "title": "account_session_create_components_param", @@ -62467,7 +63526,7 @@ "description": "The applicant's gross annual revenue for its preceding fiscal year.", "properties": { "amount": { - "description": "A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -62493,7 +63552,7 @@ "type": "integer" }, "mcc": { - "description": "[The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", + "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 4, "type": "string" }, @@ -62501,7 +63560,7 @@ "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -63254,11 +64313,11 @@ "type": "object" }, "directors_provided": { - "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", + "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", "type": "boolean" }, "executives_provided": { - "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.", + "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.", "type": "boolean" }, "export_license_id": { @@ -63287,7 +64346,7 @@ "type": "string" }, "owners_provided": { - "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.", + "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.", "type": "boolean" }, "ownership_declaration": { @@ -63322,7 +64381,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", + "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", "enum": [ "", "free_zone_establishment", @@ -63795,12 +64854,12 @@ "type": "string" }, "id_number": { - "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -64040,7 +65099,7 @@ "description": "Settings specific to the account's use of the Card Issuing product.", "properties": { "tos_acceptance": { - "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://docs.stripe.com/issuing/connect/tos_acceptance).", + "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", @@ -64157,11 +65216,11 @@ "description": "Settings specific to the account's payouts.", "properties": { "debit_negative_balances": { - "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances).", + "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).", "type": "boolean" }, "schedule": { - "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.", + "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.", "properties": { "delay_days": { "anyOf": [ @@ -64176,7 +65235,7 @@ "type": "integer" } ], - "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule)." + "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)." }, "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", @@ -64518,7 +65577,7 @@ "description": "The applicant's gross annual revenue for its preceding fiscal year.", "properties": { "amount": { - "description": "A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -64544,7 +65603,7 @@ "type": "integer" }, "mcc": { - "description": "[The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", + "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 4, "type": "string" }, @@ -64552,7 +65611,7 @@ "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -65305,11 +66364,11 @@ "type": "object" }, "directors_provided": { - "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", + "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", "type": "boolean" }, "executives_provided": { - "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.", + "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.", "type": "boolean" }, "export_license_id": { @@ -65338,7 +66397,7 @@ "type": "string" }, "owners_provided": { - "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.", + "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.", "type": "boolean" }, "ownership_declaration": { @@ -65373,7 +66432,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", + "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", "enum": [ "", "free_zone_establishment", @@ -65780,12 +66839,12 @@ "type": "string" }, "id_number": { - "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -66025,7 +67084,7 @@ "description": "Settings specific to the account's use of the Card Issuing product.", "properties": { "tos_acceptance": { - "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://docs.stripe.com/issuing/connect/tos_acceptance).", + "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", @@ -66167,11 +67226,11 @@ "description": "Settings specific to the account's payouts.", "properties": { "debit_negative_balances": { - "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances).", + "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances).", "type": "boolean" }, "schedule": { - "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.", + "description": "Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.", "properties": { "delay_days": { "anyOf": [ @@ -66186,7 +67245,7 @@ "type": "integer" } ], - "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule)." + "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)." }, "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", @@ -71266,7 +72325,7 @@ "style": "form" }, { - "description": "The timestamp from when to stop aggregating meter events (exclusive).", + "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.", "in": "query", "name": "end_time", "required": true, @@ -71324,7 +72383,7 @@ "style": "form" }, { - "description": "The timestamp from when to start aggregating meter events (inclusive).", + "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.", "in": "query", "name": "start_time", "required": true, @@ -71346,12 +72405,13 @@ "style": "form" }, { - "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range.", + "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).", "in": "query", "name": "value_grouping_window", "required": false, "schema": { "enum": [ + "day", "hour" ], "type": "string" @@ -76909,6 +77969,92 @@ "description": "Error response." } } + }, + "post": { + "description": "

Updates a Session object.

", + "operationId": "PostCheckoutSessionsSession", + "parameters": [ + { + "in": "path", + "name": "session", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout.session" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } } }, "/v1/checkout/sessions/{session}/expire": { @@ -79024,6 +80170,14 @@ "format": "unix-time", "type": "integer" }, + "email_type": { + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", + "enum": [ + "credit_note", + "none" + ], + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -79258,317 +80412,345 @@ "style": "form" }, { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "ID of the invoice.", - "in": "query", - "name": "invoice", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Line items that make up the credit note.", - "explode": true, - "in": "query", - "name": "lines", - "required": false, - "schema": { - "items": { - "properties": { - "amount": { - "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.", - "type": "integer" - }, - "description": { - "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", - "maxLength": 5000, - "type": "string" - }, - "invoice_line_item": { - "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", - "maxLength": 5000, - "type": "string" - }, - "quantity": { - "description": "The line item quantity to credit.", - "type": "integer" - }, - "tax_amounts": { - "anyOf": [ - { - "items": { - "properties": { - "amount": { - "description": "The amount, in cents (or local equivalent), of the tax.", - "type": "integer" - }, - "tax_rate": { - "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.", - "maxLength": 5000, - "type": "string" - }, - "taxable_amount": { - "description": "The amount on which tax is calculated, in cents (or local equivalent).", - "type": "integer" - } - }, - "required": [ - "amount", - "tax_rate", - "taxable_amount" - ], - "title": "tax_amount_with_tax_rate_param", - "type": "object" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`." - }, - "tax_rates": { - "anyOf": [ - { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`." - }, - "type": { - "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", - "enum": [ - "custom_line_item", - "invoice_line_item" - ], - "type": "string" - }, - "unit_amount": { - "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", - "type": "integer" - }, - "unit_amount_decimal": { - "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", - "format": "decimal", - "type": "string" - } - }, - "required": [ - "type" - ], - "title": "credit_note_line_item_params", - "type": "object" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "The credit note's memo appears on the credit note PDF.", - "in": "query", - "name": "memo", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", - "explode": true, - "in": "query", - "name": "metadata", - "required": false, - "schema": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "style": "deepObject" - }, - { - "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", - "in": "query", - "name": "out_of_band_amount", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", - "in": "query", - "name": "reason", + "name": "email_type", "required": false, "schema": { "enum": [ - "duplicate", - "fraudulent", - "order_change", - "product_unsatisfactory" + "credit_note", + "none" ], "type": "string" }, "style": "form" }, - { - "description": "ID of an existing refund to link this credit note to.", - "in": "query", - "name": "refund", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", - "in": "query", - "name": "refund_amount", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.", - "explode": true, - "in": "query", - "name": "shipping_cost", - "required": false, - "schema": { - "properties": { - "shipping_rate": { - "description": "The ID of the shipping rate to use for this order.", - "maxLength": 5000, - "type": "string" - } - }, - "title": "credit_note_shipping_cost", - "type": "object" - }, - "style": "deepObject" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/credit_note" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/credit_notes/preview/lines": { - "get": { - "description": "

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

", - "operationId": "GetCreditNotesPreviewLines", - "parameters": [ - { - "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note.", - "in": "query", - "name": "amount", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", - "in": "query", - "name": "credit_amount", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", - "in": "query", - "name": "effective_at", - "required": false, - "schema": { - "format": "unix-time", - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "in": "query", - "name": "ending_before", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "ID of the invoice.", + "in": "query", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Line items that make up the credit note.", + "explode": true, + "in": "query", + "name": "lines", + "required": false, + "schema": { + "items": { + "properties": { + "amount": { + "description": "The line item amount to credit. Only valid when `type` is `invoice_line_item`.", + "type": "integer" + }, + "description": { + "description": "The description of the credit note line item. Only valid when the `type` is `custom_line_item`.", + "maxLength": 5000, + "type": "string" + }, + "invoice_line_item": { + "description": "The invoice line item to credit. Only valid when the `type` is `invoice_line_item`.", + "maxLength": 5000, + "type": "string" + }, + "quantity": { + "description": "The line item quantity to credit.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate": { + "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.", + "maxLength": 5000, + "type": "string" + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate", + "taxable_amount" + ], + "title": "tax_amount_with_tax_rate_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`." + }, + "type": { + "description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`", + "enum": [ + "custom_line_item", + "invoice_line_item" + ], + "type": "string" + }, + "unit_amount": { + "description": "The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "credit_note_line_item_params", + "type": "object" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "The credit note's memo appears on the credit note PDF.", + "in": "query", + "name": "memo", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "explode": true, + "in": "query", + "name": "metadata", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.", + "in": "query", + "name": "out_of_band_amount", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`", + "in": "query", + "name": "reason", + "required": false, + "schema": { + "enum": [ + "duplicate", + "fraudulent", + "order_change", + "product_unsatisfactory" + ], + "type": "string" + }, + "style": "form" + }, + { + "description": "ID of an existing refund to link this credit note to.", + "in": "query", + "name": "refund", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.", + "in": "query", + "name": "refund_amount", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.", + "explode": true, + "in": "query", + "name": "shipping_cost", + "required": false, + "schema": { + "properties": { + "shipping_rate": { + "description": "The ID of the shipping rate to use for this order.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "credit_note_shipping_cost", + "type": "object" + }, + "style": "deepObject" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/credit_note" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/credit_notes/preview/lines": { + "get": { + "description": "

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

", + "operationId": "GetCreditNotesPreviewLines", + "parameters": [ + { + "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note.", + "in": "query", + "name": "amount", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.", + "in": "query", + "name": "credit_amount", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.", + "in": "query", + "name": "effective_at", + "required": false, + "schema": { + "format": "unix-time", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", + "in": "query", + "name": "email_type", + "required": false, + "schema": { + "enum": [ + "credit_note", + "none" + ], + "type": "string" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, @@ -80245,7 +81427,7 @@ }, "/v1/customer_sessions": { "post": { - "description": "

Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

", + "description": "

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

", "operationId": "PostCustomerSessions", "requestBody": { "content": { @@ -80280,6 +81462,78 @@ "title": "buy_button_param", "type": "object" }, + "payment_element": { + "description": "Configuration for the Payment Element.", + "properties": { + "enabled": { + "description": "Whether the Payment Element is enabled.", + "type": "boolean" + }, + "features": { + "description": "This hash defines whether the Payment Element supports certain features.", + "properties": { + "payment_method_allow_redisplay_filters": { + "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].", + "items": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_redisplay": { + "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_redisplay_limit": { + "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `10`.", + "type": "integer" + }, + "payment_method_remove": { + "description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save": { + "description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save_usage": { + "description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.", + "enum": [ + "off_session", + "on_session" + ], + "type": "string" + } + }, + "title": "features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "payment_element_param", + "type": "object" + }, "pricing_table": { "description": "Configuration for the pricing table.", "properties": { @@ -80299,7 +81553,7 @@ "type": "object" }, "customer": { - "description": "The ID of an existing customer for which to create the customer session.", + "description": "The ID of an existing customer for which to create the Customer Session.", "maxLength": 5000, "type": "string" }, @@ -80920,7 +82174,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -80938,6 +82192,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -83865,7 +85120,7 @@ "type": "array" }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -83883,6 +85138,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -84137,6 +85393,7 @@ "style": "form" }, { + "description": "Only return disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -85603,7 +86860,7 @@ }, "/v1/events/{id}": { "get": { - "description": "

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

", + "description": "

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

", "operationId": "GetEventsId", "parameters": [ { @@ -87467,6 +88724,20 @@ "filters": { "description": "Filters to restrict the kinds of accounts to collect.", "properties": { + "account_subcategories": { + "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", + "items": { + "enum": [ + "checking", + "credit_card", + "line_of_credit", + "mortgage", + "savings" + ], + "type": "string" + }, + "type": "array" + }, "countries": { "description": "List of countries from which to collect accounts.", "items": { @@ -90902,6 +92173,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -90984,6 +92273,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -91592,7 +92882,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -91610,6 +92900,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -93312,7 +94603,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -93330,6 +94621,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -95351,7 +96643,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -95369,6 +96661,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -97968,6 +99261,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -98050,6 +99361,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -98422,10 +99734,10 @@ } } }, - "/v1/invoices/{invoice}/finalize": { + "/v1/invoices/{invoice}/add_lines": { "post": { - "description": "

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

", - "operationId": "PostInvoicesInvoiceFinalize", + "description": "

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

", + "operationId": "PostInvoicesInvoiceAddLines", "parameters": [ { "in": "path", @@ -98445,15 +99757,19 @@ "expand": { "explode": true, "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { - "auto_advance": { - "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", - "type": "boolean" - }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -98461,13 +99777,405 @@ "type": "string" }, "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to add.", + "items": { + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", + "type": "integer" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "invoice_item": { + "description": "ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "properties": { + "description": { + "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", + "maxLength": 40000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency" + ], + "title": "one_time_price_data_with_product_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", + "properties": { + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "description": { + "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", + "maxLength": 5000, + "type": "string" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 200, + "type": "string" + }, + "percentage": { + "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object" + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "title": "lines_data_param", + "type": "object" + }, + "type": "array" } }, + "required": [ + "lines" + ], "type": "object" } } }, - "required": false + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoices/{invoice}/finalize": { + "post": { + "description": "

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

", + "operationId": "PostInvoicesInvoiceFinalize", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "auto_advance": { + "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false }, "responses": { "200": { @@ -98764,7 +100472,7 @@ "type": "string" } ], - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data." + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", @@ -98905,7 +100613,7 @@ }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", - "maxLength": 50, + "maxLength": 200, "type": "string" }, "percentage": { @@ -99193,6 +100901,128 @@ } } }, + "/v1/invoices/{invoice}/remove_lines": { + "post": { + "description": "

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

", + "operationId": "PostInvoicesInvoiceRemoveLines", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to remove.", + "items": { + "properties": { + "behavior": { + "description": "Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.", + "enum": [ + "delete", + "unassign" + ], + "type": "string" + }, + "id": { + "description": "ID of an existing line item to remove from this invoice.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "behavior", + "id" + ], + "title": "lines_data_param", + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "lines" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/invoices/{invoice}/send": { "post": { "description": "

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

\n\n

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

", @@ -99260,6 +101090,405 @@ } } }, + "/v1/invoices/{invoice}/update_lines": { + "post": { + "description": "

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

", + "operationId": "PostInvoicesInvoiceUpdateLines", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." + }, + "lines": { + "description": "The line items to update.", + "items": { + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", + "type": "integer" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "id": { + "description": "ID of an existing line item on the invoice.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "properties": { + "description": { + "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.", + "maxLength": 40000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency" + ], + "title": "one_time_price_data_with_product_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.", + "properties": { + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "description": { + "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", + "maxLength": 5000, + "type": "string" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 200, + "type": "string" + }, + "percentage": { + "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object" + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "required": [ + "id" + ], + "title": "lines_data_param", + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "lines" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/invoices/{invoice}/void": { "post": { "description": "

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

\n\n

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

", @@ -103077,6 +105306,25 @@ "title": "required_address", "type": "object" }, + "address_validation": { + "description": "Address validation settings.", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + } + }, + "required": [ + "mode" + ], + "title": "address_validation_param", + "type": "object" + }, "customs": { "description": "Customs information for the shipment.", "properties": { @@ -104245,6 +106493,10 @@ "explode": true, "style": "deepObject" }, + "shipping": { + "explode": true, + "style": "deepObject" + }, "spending_controls": { "explode": true, "style": "deepObject" @@ -104303,6 +106555,122 @@ "title": "encrypted_pin_param", "type": "object" }, + "shipping": { + "description": "Updated shipping information for the card.", + "properties": { + "address": { + "description": "The address that the card is shipped to.", + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "city", + "country", + "line1", + "postal_code" + ], + "title": "required_address", + "type": "object" + }, + "address_validation": { + "description": "Address validation settings.", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + } + }, + "required": [ + "mode" + ], + "title": "address_validation_param", + "type": "object" + }, + "customs": { + "description": "Customs information for the shipment.", + "properties": { + "eori_number": { + "description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "customs_param", + "type": "object" + }, + "name": { + "description": "The name printed on the shipping label when shipping the card.", + "maxLength": 5000, + "type": "string" + }, + "phone_number": { + "description": "Phone number of the recipient of the shipment.", + "type": "string" + }, + "require_signature": { + "description": "Whether a signature is required for card delivery.", + "type": "boolean" + }, + "service": { + "description": "Shipment service.", + "enum": [ + "express", + "priority", + "standard" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "type": { + "description": "Packaging options.", + "enum": [ + "bulk", + "individual" + ], + "type": "string" + } + }, + "required": [ + "address", + "name" + ], + "title": "shipping_specs", + "type": "object" + }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { @@ -105586,7 +107954,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105616,7 +107984,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105631,7 +107999,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105752,7 +108120,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105803,7 +108171,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105849,7 +108217,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105879,7 +108247,7 @@ "return_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -105949,7 +108317,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106010,7 +108378,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106025,7 +108393,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106080,7 +108448,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106095,7 +108463,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106180,7 +108548,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106195,7 +108563,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106464,7 +108832,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106494,7 +108862,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106509,7 +108877,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106630,7 +108998,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106681,7 +109049,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106727,7 +109095,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106757,7 +109125,7 @@ "return_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106827,7 +109195,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106888,7 +109256,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106903,7 +109271,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106958,7 +109326,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -106973,7 +109341,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -107058,7 +109426,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -107073,7 +109441,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -111689,6 +114057,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -114756,6 +117143,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -117975,6 +120381,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -119413,6 +121838,7 @@ "konbini", "link", "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -119422,8 +121848,10 @@ "sepa_debit", "sofort", "swish", + "twint", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -120726,6 +123154,7 @@ "konbini", "link", "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -120735,8 +123164,10 @@ "sepa_debit", "sofort", "swish", + "twint", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -121631,6 +124062,10 @@ "explode": true, "style": "deepObject" }, + "twint": { + "explode": true, + "style": "deepObject" + }, "us_bank_account": { "explode": true, "style": "deepObject" @@ -122516,6 +124951,29 @@ "title": "payment_method_param", "type": "object" }, + "twint": { + "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.", "properties": { @@ -122854,6 +125312,10 @@ "explode": true, "style": "deepObject" }, + "twint": { + "explode": true, + "style": "deepObject" + }, "us_bank_account": { "explode": true, "style": "deepObject" @@ -123646,8 +126108,31 @@ "title": "payment_method_param", "type": "object" }, - "revolut_pay": { - "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", + "revolut_pay": { + "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "sepa_debit": { + "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -123669,8 +126154,8 @@ "title": "payment_method_param", "type": "object" }, - "sepa_debit": { - "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.", + "sofort": { + "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -123692,8 +126177,8 @@ "title": "payment_method_param", "type": "object" }, - "sofort": { - "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.", + "swish": { + "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -123715,8 +126200,8 @@ "title": "payment_method_param", "type": "object" }, - "swish": { - "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", + "twint": { + "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -126830,6 +129315,7 @@ "type": "boolean" }, "id": { + "deprecated": true, "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", "maxLength": 5000, "type": "string" @@ -127705,6 +130191,7 @@ "type": "boolean" }, "id": { + "deprecated": true, "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", "maxLength": 5000, "type": "string" @@ -133401,7 +135888,7 @@ }, "/v1/refunds": { "get": { - "description": "

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

", + "description": "

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

", "operationId": "GetRefunds", "parameters": [ { @@ -136957,6 +139444,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -138329,6 +140835,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -139733,6 +142258,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -146485,6 +149029,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -146567,6 +149129,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -146594,7 +149157,7 @@ "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" @@ -147073,7 +149636,7 @@ } }, "post": { - "description": "

Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.

\n\n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n\n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n\n\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

\n\n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

\n\n

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

\n\n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

", + "description": "

Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the create preview endpoint.

\n\n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n\n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n\n\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

\n\n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

\n\n

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

\n\n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

", "operationId": "PostSubscriptionsSubscriptionExposedId", "parameters": [ { @@ -148086,6 +150649,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "description": "The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.", "items": { @@ -148168,6 +150749,7 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", @@ -148195,7 +150777,7 @@ "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)." }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" @@ -148512,7 +151094,7 @@ }, "/v1/tax/calculations": { "post": { - "description": "

Calculates tax based on input and returns a Tax Calculation object.

", + "description": "

Calculates tax based on the input and returns a Tax Calculation object.

", "operationId": "PostTaxCalculations", "requestBody": { "content": { @@ -148661,7 +151243,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -148679,6 +151261,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -148780,7 +151363,7 @@ "items": { "properties": { "amount": { - "description": "A positive integer representing the line item's total price 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).\nThe minimum amount is $0.0 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).\nThe amount value supports up to twelve digits (e.g., a value of 999999999999 for a USD charge of $9,999,999,999.99).\nIf `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", + "description": "A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\nIf `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", "type": "integer" }, "product": { @@ -151344,6 +153927,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "posted_at": { + "description": "The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.", + "format": "unix-time", + "type": "integer" + }, "reference": { "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.", "maxLength": 500, @@ -152163,7 +154751,7 @@ "type": "object" }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -152181,6 +154769,7 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", @@ -153064,6 +155653,10 @@ "explode": true, "style": "deepObject" }, + "reboot_window": { + "explode": true, + "style": "deepObject" + }, "stripe_s700": { "explode": true, "style": "deepObject" @@ -153138,6 +155731,25 @@ ], "description": "Configurations for collecting transactions offline." }, + "reboot_window": { + "description": "Reboot time settings for readers that support customized reboot time configuration.", + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "reboot_window", + "type": "object" + }, "stripe_s700": { "description": "An object containing device type specific settings for Stripe S700 readers", "properties": { @@ -153734,6 +156346,10 @@ "explode": true, "style": "deepObject" }, + "reboot_window": { + "explode": true, + "style": "deepObject" + }, "stripe_s700": { "explode": true, "style": "deepObject" @@ -153818,6 +156434,35 @@ ], "description": "Configurations for collecting transactions offline." }, + "reboot_window": { + "anyOf": [ + { + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "reboot_window", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Reboot time settings for readers that support customized reboot time configuration." + }, "stripe_s700": { "anyOf": [ { @@ -154905,6 +157550,7 @@ "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", + "stripe_s700", "verifone_P400" ], "type": "string", @@ -156838,6 +159484,14 @@ "explode": true, "style": "deepObject" }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + }, "merchant_data": { "explode": true, "style": "deepObject" @@ -156901,6 +159555,161 @@ }, "type": "array" }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_testmode_authorization_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" @@ -157453,6 +160262,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -157521,6 +160436,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -157709,6 +160629,243 @@ } } }, + "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { + "post": { + "description": "

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", + "parameters": [ + { + "in": "path", + "name": "authorization", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "final_amount": { + "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" + }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + } + }, + "required": [ + "final_amount" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.authorization" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { "post": { "description": "

Increment a test-mode Authorization.

", @@ -158770,6 +161927,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -158838,6 +162101,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -159359,6 +162627,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -159427,6 +162801,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -161558,11 +164937,11 @@ "type": "object" }, "directors_provided": { - "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", + "description": "Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.", "type": "boolean" }, "executives_provided": { - "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.", + "description": "Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement.", "type": "boolean" }, "export_license_id": { @@ -161591,7 +164970,7 @@ "type": "string" }, "owners_provided": { - "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.", + "description": "Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement.", "type": "boolean" }, "ownership_declaration": { @@ -161630,7 +165009,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", + "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.", "enum": [ "", "free_zone_establishment", @@ -161903,12 +165282,12 @@ "type": "string" }, "id_number": { - "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", + "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -162087,7 +165466,7 @@ "type": "object" }, "tos_shown_and_accepted": { - "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://docs.stripe.com/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", + "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", "type": "boolean" } }, @@ -168823,7 +172202,8 @@ "2022-11-15", "2023-08-16", "2023-10-16", - "2024-04-10" + "2024-04-10", + "2024-06-20" ], "maxLength": 5000, "type": "string", @@ -168940,6 +172320,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -168948,6 +172329,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -168960,6 +172342,7 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_personalization_design.activated", @@ -169424,6 +172807,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -169432,6 +172816,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -169444,6 +172829,7 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", "issuing_personalization_design.activated", diff --git a/pkg/cmd/resources_cmds.go b/pkg/cmd/resources_cmds.go index de16fa4c4..c3c1c0647 100644 --- a/pkg/cmd/resources_cmds.go +++ b/pkg/cmd/resources_cmds.go @@ -220,6 +220,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "components.payouts.features.instant_payouts": "boolean", "components.payouts.features.standard_payouts": "boolean", "components.payouts_list.enabled": "boolean", + "components.tax_registrations.enabled": "boolean", + "components.tax_settings.enabled": "boolean", }, &Config) resource.NewOperationCmd(rAccountsCmd.Cmd, "capabilities", "/v1/accounts/{account}/capabilities", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rAccountsCmd.Cmd, "create", "/v1/accounts", http.MethodPost, map[string]string{ @@ -871,6 +873,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "amount": "integer", "credit_amount": "integer", "effective_at": "integer", + "email_type": "string", "invoice": "string", "memo": "string", "out_of_band_amount": "integer", @@ -891,6 +894,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "amount": "integer", "credit_amount": "integer", "effective_at": "integer", + "email_type": "string", "invoice": "string", "memo": "string", "out_of_band_amount": "integer", @@ -902,6 +906,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "amount": "integer", "credit_amount": "integer", "effective_at": "integer", + "email_type": "string", "ending_before": "string", "invoice": "string", "limit": "integer", @@ -938,9 +943,16 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { }, &Config) resource.NewOperationCmd(rCustomerCashBalanceTransactionsCmd.Cmd, "retrieve", "/v1/customers/{customer}/cash_balance_transactions/{transaction}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rCustomerSessionsCmd.Cmd, "create", "/v1/customer_sessions", http.MethodPost, map[string]string{ - "components.buy_button.enabled": "boolean", - "components.pricing_table.enabled": "boolean", - "customer": "string", + "components.buy_button.enabled": "boolean", + "components.payment_element.enabled": "boolean", + "components.payment_element.features.payment_method_allow_redisplay_filters": "array", + "components.payment_element.features.payment_method_redisplay": "string", + "components.payment_element.features.payment_method_redisplay_limit": "integer", + "components.payment_element.features.payment_method_remove": "string", + "components.payment_element.features.payment_method_save": "string", + "components.payment_element.features.payment_method_save_usage": "string", + "components.pricing_table.enabled": "boolean", + "customer": "string", }, &Config) resource.NewOperationCmd(rCustomersCmd.Cmd, "balance_transactions", "/v1/customers/{customer}/balance_transactions", http.MethodGet, map[string]string{ "ending_before": "string", @@ -1205,6 +1217,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "unit_amount": "integer", "unit_amount_decimal": "string", }, &Config) + resource.NewOperationCmd(rInvoicesCmd.Cmd, "add_lines", "/v1/invoices/{invoice}/add_lines", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "create", "/v1/invoices", http.MethodPost, map[string]string{ "account_tax_ids": "array", "application_fee_amount": "integer", @@ -1310,6 +1323,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "payment_method": "string", "source": "string", }, &Config) + resource.NewOperationCmd(rInvoicesCmd.Cmd, "remove_lines", "/v1/invoices/{invoice}/remove_lines", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "retrieve", "/v1/invoices/{invoice}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "search", "/v1/invoices/search", http.MethodGet, map[string]string{ "limit": "integer", @@ -1386,6 +1400,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "rendering.pdf.page_size": "string", "statement_descriptor": "string", }, &Config) + resource.NewOperationCmd(rInvoicesCmd.Cmd, "update_lines", "/v1/invoices/{invoice}/update_lines", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rInvoicesCmd.Cmd, "void_invoice", "/v1/invoices/{invoice}/void", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rLineItemsCmd.Cmd, "list", "/v1/invoices/{invoice}/lines", http.MethodGet, map[string]string{ "ending_before": "string", @@ -1737,6 +1752,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "sepa_debit.display_preference.preference": "string", "sofort.display_preference.preference": "string", "swish.display_preference.preference": "string", + "twint.display_preference.preference": "string", "us_bank_account.display_preference.preference": "string", "wechat_pay.display_preference.preference": "string", "zip.display_preference.preference": "string", @@ -1788,6 +1804,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "sepa_debit.display_preference.preference": "string", "sofort.display_preference.preference": "string", "swish.display_preference.preference": "string", + "twint.display_preference.preference": "string", "us_bank_account.display_preference.preference": "string", "wechat_pay.display_preference.preference": "string", "zip.display_preference.preference": "string", @@ -2327,72 +2344,73 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "confirm", "/v1/setup_intents/{intent}/confirm", http.MethodPost, map[string]string{ "confirmation_token": "string", "payment_method": "string", - "payment_method_data.acss_debit.account_number": "string", - "payment_method_data.acss_debit.institution_number": "string", - "payment_method_data.acss_debit.transit_number": "string", - "payment_method_data.allow_redisplay": "string", - "payment_method_data.au_becs_debit.account_number": "string", - "payment_method_data.au_becs_debit.bsb_number": "string", - "payment_method_data.bacs_debit.account_number": "string", - "payment_method_data.bacs_debit.sort_code": "string", - "payment_method_data.billing_details.email": "string", - "payment_method_data.billing_details.name": "string", - "payment_method_data.billing_details.phone": "string", - "payment_method_data.boleto.tax_id": "string", - "payment_method_data.eps.bank": "string", - "payment_method_data.fpx.account_holder_type": "string", - "payment_method_data.fpx.bank": "string", - "payment_method_data.ideal.bank": "string", - "payment_method_data.klarna.dob.day": "integer", - "payment_method_data.klarna.dob.month": "integer", - "payment_method_data.klarna.dob.year": "integer", - "payment_method_data.p24.bank": "string", - "payment_method_data.radar_options.session": "string", - "payment_method_data.sepa_debit.iban": "string", - "payment_method_data.sofort.country": "string", - "payment_method_data.type": "string", - "payment_method_data.us_bank_account.account_holder_type": "string", - "payment_method_data.us_bank_account.account_number": "string", - "payment_method_data.us_bank_account.account_type": "string", - "payment_method_data.us_bank_account.financial_connections_account": "string", - "payment_method_data.us_bank_account.routing_number": "string", - "payment_method_options.acss_debit.currency": "string", - "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", - "payment_method_options.acss_debit.mandate_options.default_for": "array", - "payment_method_options.acss_debit.mandate_options.interval_description": "string", - "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", - "payment_method_options.acss_debit.mandate_options.transaction_type": "string", - "payment_method_options.acss_debit.verification_method": "string", - "payment_method_options.card.mandate_options.amount": "integer", - "payment_method_options.card.mandate_options.amount_type": "string", - "payment_method_options.card.mandate_options.currency": "string", - "payment_method_options.card.mandate_options.description": "string", - "payment_method_options.card.mandate_options.end_date": "integer", - "payment_method_options.card.mandate_options.interval": "string", - "payment_method_options.card.mandate_options.interval_count": "integer", - "payment_method_options.card.mandate_options.reference": "string", - "payment_method_options.card.mandate_options.start_date": "integer", - "payment_method_options.card.mandate_options.supported_types": "array", - "payment_method_options.card.moto": "boolean", - "payment_method_options.card.network": "string", - "payment_method_options.card.request_three_d_secure": "string", - "payment_method_options.card.three_d_secure.ares_trans_status": "string", - "payment_method_options.card.three_d_secure.cryptogram": "string", - "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", - "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", - "payment_method_options.card.three_d_secure.transaction_id": "string", - "payment_method_options.card.three_d_secure.version": "string", - "payment_method_options.link.persistent_token": "string", - "payment_method_options.paypal.billing_agreement_id": "string", - "payment_method_options.us_bank_account.financial_connections.permissions": "array", - "payment_method_options.us_bank_account.financial_connections.prefetch": "array", - "payment_method_options.us_bank_account.financial_connections.return_url": "string", - "payment_method_options.us_bank_account.mandate_options.collection_method": "string", - "payment_method_options.us_bank_account.networks.requested": "array", - "payment_method_options.us_bank_account.verification_method": "string", + "payment_method_data.acss_debit.account_number": "string", + "payment_method_data.acss_debit.institution_number": "string", + "payment_method_data.acss_debit.transit_number": "string", + "payment_method_data.allow_redisplay": "string", + "payment_method_data.au_becs_debit.account_number": "string", + "payment_method_data.au_becs_debit.bsb_number": "string", + "payment_method_data.bacs_debit.account_number": "string", + "payment_method_data.bacs_debit.sort_code": "string", + "payment_method_data.billing_details.email": "string", + "payment_method_data.billing_details.name": "string", + "payment_method_data.billing_details.phone": "string", + "payment_method_data.boleto.tax_id": "string", + "payment_method_data.eps.bank": "string", + "payment_method_data.fpx.account_holder_type": "string", + "payment_method_data.fpx.bank": "string", + "payment_method_data.ideal.bank": "string", + "payment_method_data.klarna.dob.day": "integer", + "payment_method_data.klarna.dob.month": "integer", + "payment_method_data.klarna.dob.year": "integer", + "payment_method_data.p24.bank": "string", + "payment_method_data.radar_options.session": "string", + "payment_method_data.sepa_debit.iban": "string", + "payment_method_data.sofort.country": "string", + "payment_method_data.type": "string", + "payment_method_data.us_bank_account.account_holder_type": "string", + "payment_method_data.us_bank_account.account_number": "string", + "payment_method_data.us_bank_account.account_type": "string", + "payment_method_data.us_bank_account.financial_connections_account": "string", + "payment_method_data.us_bank_account.routing_number": "string", + "payment_method_options.acss_debit.currency": "string", + "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", + "payment_method_options.acss_debit.mandate_options.default_for": "array", + "payment_method_options.acss_debit.mandate_options.interval_description": "string", + "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", + "payment_method_options.acss_debit.mandate_options.transaction_type": "string", + "payment_method_options.acss_debit.verification_method": "string", + "payment_method_options.card.mandate_options.amount": "integer", + "payment_method_options.card.mandate_options.amount_type": "string", + "payment_method_options.card.mandate_options.currency": "string", + "payment_method_options.card.mandate_options.description": "string", + "payment_method_options.card.mandate_options.end_date": "integer", + "payment_method_options.card.mandate_options.interval": "string", + "payment_method_options.card.mandate_options.interval_count": "integer", + "payment_method_options.card.mandate_options.reference": "string", + "payment_method_options.card.mandate_options.start_date": "integer", + "payment_method_options.card.mandate_options.supported_types": "array", + "payment_method_options.card.moto": "boolean", + "payment_method_options.card.network": "string", + "payment_method_options.card.request_three_d_secure": "string", + "payment_method_options.card.three_d_secure.ares_trans_status": "string", + "payment_method_options.card.three_d_secure.cryptogram": "string", + "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", + "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", + "payment_method_options.card.three_d_secure.transaction_id": "string", + "payment_method_options.card.three_d_secure.version": "string", + "payment_method_options.link.persistent_token": "string", + "payment_method_options.paypal.billing_agreement_id": "string", + "payment_method_options.us_bank_account.financial_connections.filters.account_subcategories": "array", + "payment_method_options.us_bank_account.financial_connections.permissions": "array", + "payment_method_options.us_bank_account.financial_connections.prefetch": "array", + "payment_method_options.us_bank_account.financial_connections.return_url": "string", + "payment_method_options.us_bank_account.mandate_options.collection_method": "string", + "payment_method_options.us_bank_account.networks.requested": "array", + "payment_method_options.us_bank_account.verification_method": "string", "return_url": "string", "use_stripe_sdk": "boolean", }, &Config) @@ -2408,78 +2426,79 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "on_behalf_of": "string", "payment_method": "string", "payment_method_configuration": "string", - "payment_method_data.acss_debit.account_number": "string", - "payment_method_data.acss_debit.institution_number": "string", - "payment_method_data.acss_debit.transit_number": "string", - "payment_method_data.allow_redisplay": "string", - "payment_method_data.au_becs_debit.account_number": "string", - "payment_method_data.au_becs_debit.bsb_number": "string", - "payment_method_data.bacs_debit.account_number": "string", - "payment_method_data.bacs_debit.sort_code": "string", - "payment_method_data.billing_details.email": "string", - "payment_method_data.billing_details.name": "string", - "payment_method_data.billing_details.phone": "string", - "payment_method_data.boleto.tax_id": "string", - "payment_method_data.eps.bank": "string", - "payment_method_data.fpx.account_holder_type": "string", - "payment_method_data.fpx.bank": "string", - "payment_method_data.ideal.bank": "string", - "payment_method_data.klarna.dob.day": "integer", - "payment_method_data.klarna.dob.month": "integer", - "payment_method_data.klarna.dob.year": "integer", - "payment_method_data.p24.bank": "string", - "payment_method_data.radar_options.session": "string", - "payment_method_data.sepa_debit.iban": "string", - "payment_method_data.sofort.country": "string", - "payment_method_data.type": "string", - "payment_method_data.us_bank_account.account_holder_type": "string", - "payment_method_data.us_bank_account.account_number": "string", - "payment_method_data.us_bank_account.account_type": "string", - "payment_method_data.us_bank_account.financial_connections_account": "string", - "payment_method_data.us_bank_account.routing_number": "string", - "payment_method_options.acss_debit.currency": "string", - "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", - "payment_method_options.acss_debit.mandate_options.default_for": "array", - "payment_method_options.acss_debit.mandate_options.interval_description": "string", - "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", - "payment_method_options.acss_debit.mandate_options.transaction_type": "string", - "payment_method_options.acss_debit.verification_method": "string", - "payment_method_options.card.mandate_options.amount": "integer", - "payment_method_options.card.mandate_options.amount_type": "string", - "payment_method_options.card.mandate_options.currency": "string", - "payment_method_options.card.mandate_options.description": "string", - "payment_method_options.card.mandate_options.end_date": "integer", - "payment_method_options.card.mandate_options.interval": "string", - "payment_method_options.card.mandate_options.interval_count": "integer", - "payment_method_options.card.mandate_options.reference": "string", - "payment_method_options.card.mandate_options.start_date": "integer", - "payment_method_options.card.mandate_options.supported_types": "array", - "payment_method_options.card.moto": "boolean", - "payment_method_options.card.network": "string", - "payment_method_options.card.request_three_d_secure": "string", - "payment_method_options.card.three_d_secure.ares_trans_status": "string", - "payment_method_options.card.three_d_secure.cryptogram": "string", - "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", - "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", - "payment_method_options.card.three_d_secure.transaction_id": "string", - "payment_method_options.card.three_d_secure.version": "string", - "payment_method_options.link.persistent_token": "string", - "payment_method_options.paypal.billing_agreement_id": "string", - "payment_method_options.us_bank_account.financial_connections.permissions": "array", - "payment_method_options.us_bank_account.financial_connections.prefetch": "array", - "payment_method_options.us_bank_account.financial_connections.return_url": "string", - "payment_method_options.us_bank_account.mandate_options.collection_method": "string", - "payment_method_options.us_bank_account.networks.requested": "array", - "payment_method_options.us_bank_account.verification_method": "string", - "payment_method_types": "array", - "return_url": "string", - "single_use.amount": "integer", - "single_use.currency": "string", - "usage": "string", - "use_stripe_sdk": "boolean", + "payment_method_data.acss_debit.account_number": "string", + "payment_method_data.acss_debit.institution_number": "string", + "payment_method_data.acss_debit.transit_number": "string", + "payment_method_data.allow_redisplay": "string", + "payment_method_data.au_becs_debit.account_number": "string", + "payment_method_data.au_becs_debit.bsb_number": "string", + "payment_method_data.bacs_debit.account_number": "string", + "payment_method_data.bacs_debit.sort_code": "string", + "payment_method_data.billing_details.email": "string", + "payment_method_data.billing_details.name": "string", + "payment_method_data.billing_details.phone": "string", + "payment_method_data.boleto.tax_id": "string", + "payment_method_data.eps.bank": "string", + "payment_method_data.fpx.account_holder_type": "string", + "payment_method_data.fpx.bank": "string", + "payment_method_data.ideal.bank": "string", + "payment_method_data.klarna.dob.day": "integer", + "payment_method_data.klarna.dob.month": "integer", + "payment_method_data.klarna.dob.year": "integer", + "payment_method_data.p24.bank": "string", + "payment_method_data.radar_options.session": "string", + "payment_method_data.sepa_debit.iban": "string", + "payment_method_data.sofort.country": "string", + "payment_method_data.type": "string", + "payment_method_data.us_bank_account.account_holder_type": "string", + "payment_method_data.us_bank_account.account_number": "string", + "payment_method_data.us_bank_account.account_type": "string", + "payment_method_data.us_bank_account.financial_connections_account": "string", + "payment_method_data.us_bank_account.routing_number": "string", + "payment_method_options.acss_debit.currency": "string", + "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", + "payment_method_options.acss_debit.mandate_options.default_for": "array", + "payment_method_options.acss_debit.mandate_options.interval_description": "string", + "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", + "payment_method_options.acss_debit.mandate_options.transaction_type": "string", + "payment_method_options.acss_debit.verification_method": "string", + "payment_method_options.card.mandate_options.amount": "integer", + "payment_method_options.card.mandate_options.amount_type": "string", + "payment_method_options.card.mandate_options.currency": "string", + "payment_method_options.card.mandate_options.description": "string", + "payment_method_options.card.mandate_options.end_date": "integer", + "payment_method_options.card.mandate_options.interval": "string", + "payment_method_options.card.mandate_options.interval_count": "integer", + "payment_method_options.card.mandate_options.reference": "string", + "payment_method_options.card.mandate_options.start_date": "integer", + "payment_method_options.card.mandate_options.supported_types": "array", + "payment_method_options.card.moto": "boolean", + "payment_method_options.card.network": "string", + "payment_method_options.card.request_three_d_secure": "string", + "payment_method_options.card.three_d_secure.ares_trans_status": "string", + "payment_method_options.card.three_d_secure.cryptogram": "string", + "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", + "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", + "payment_method_options.card.three_d_secure.transaction_id": "string", + "payment_method_options.card.three_d_secure.version": "string", + "payment_method_options.link.persistent_token": "string", + "payment_method_options.paypal.billing_agreement_id": "string", + "payment_method_options.us_bank_account.financial_connections.filters.account_subcategories": "array", + "payment_method_options.us_bank_account.financial_connections.permissions": "array", + "payment_method_options.us_bank_account.financial_connections.prefetch": "array", + "payment_method_options.us_bank_account.financial_connections.return_url": "string", + "payment_method_options.us_bank_account.mandate_options.collection_method": "string", + "payment_method_options.us_bank_account.networks.requested": "array", + "payment_method_options.us_bank_account.verification_method": "string", + "payment_method_types": "array", + "return_url": "string", + "single_use.amount": "integer", + "single_use.currency": "string", + "usage": "string", + "use_stripe_sdk": "boolean", }, &Config) resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "list", "/v1/setup_intents", http.MethodGet, map[string]string{ "attach_to_self": "boolean", @@ -2500,73 +2519,74 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "flow_directions": "array", "payment_method": "string", "payment_method_configuration": "string", - "payment_method_data.acss_debit.account_number": "string", - "payment_method_data.acss_debit.institution_number": "string", - "payment_method_data.acss_debit.transit_number": "string", - "payment_method_data.allow_redisplay": "string", - "payment_method_data.au_becs_debit.account_number": "string", - "payment_method_data.au_becs_debit.bsb_number": "string", - "payment_method_data.bacs_debit.account_number": "string", - "payment_method_data.bacs_debit.sort_code": "string", - "payment_method_data.billing_details.email": "string", - "payment_method_data.billing_details.name": "string", - "payment_method_data.billing_details.phone": "string", - "payment_method_data.boleto.tax_id": "string", - "payment_method_data.eps.bank": "string", - "payment_method_data.fpx.account_holder_type": "string", - "payment_method_data.fpx.bank": "string", - "payment_method_data.ideal.bank": "string", - "payment_method_data.klarna.dob.day": "integer", - "payment_method_data.klarna.dob.month": "integer", - "payment_method_data.klarna.dob.year": "integer", - "payment_method_data.p24.bank": "string", - "payment_method_data.radar_options.session": "string", - "payment_method_data.sepa_debit.iban": "string", - "payment_method_data.sofort.country": "string", - "payment_method_data.type": "string", - "payment_method_data.us_bank_account.account_holder_type": "string", - "payment_method_data.us_bank_account.account_number": "string", - "payment_method_data.us_bank_account.account_type": "string", - "payment_method_data.us_bank_account.financial_connections_account": "string", - "payment_method_data.us_bank_account.routing_number": "string", - "payment_method_options.acss_debit.currency": "string", - "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", - "payment_method_options.acss_debit.mandate_options.default_for": "array", - "payment_method_options.acss_debit.mandate_options.interval_description": "string", - "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", - "payment_method_options.acss_debit.mandate_options.transaction_type": "string", - "payment_method_options.acss_debit.verification_method": "string", - "payment_method_options.card.mandate_options.amount": "integer", - "payment_method_options.card.mandate_options.amount_type": "string", - "payment_method_options.card.mandate_options.currency": "string", - "payment_method_options.card.mandate_options.description": "string", - "payment_method_options.card.mandate_options.end_date": "integer", - "payment_method_options.card.mandate_options.interval": "string", - "payment_method_options.card.mandate_options.interval_count": "integer", - "payment_method_options.card.mandate_options.reference": "string", - "payment_method_options.card.mandate_options.start_date": "integer", - "payment_method_options.card.mandate_options.supported_types": "array", - "payment_method_options.card.moto": "boolean", - "payment_method_options.card.network": "string", - "payment_method_options.card.request_three_d_secure": "string", - "payment_method_options.card.three_d_secure.ares_trans_status": "string", - "payment_method_options.card.three_d_secure.cryptogram": "string", - "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", - "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", - "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", - "payment_method_options.card.three_d_secure.transaction_id": "string", - "payment_method_options.card.three_d_secure.version": "string", - "payment_method_options.link.persistent_token": "string", - "payment_method_options.paypal.billing_agreement_id": "string", - "payment_method_options.us_bank_account.financial_connections.permissions": "array", - "payment_method_options.us_bank_account.financial_connections.prefetch": "array", - "payment_method_options.us_bank_account.financial_connections.return_url": "string", - "payment_method_options.us_bank_account.mandate_options.collection_method": "string", - "payment_method_options.us_bank_account.networks.requested": "array", - "payment_method_options.us_bank_account.verification_method": "string", - "payment_method_types": "array", + "payment_method_data.acss_debit.account_number": "string", + "payment_method_data.acss_debit.institution_number": "string", + "payment_method_data.acss_debit.transit_number": "string", + "payment_method_data.allow_redisplay": "string", + "payment_method_data.au_becs_debit.account_number": "string", + "payment_method_data.au_becs_debit.bsb_number": "string", + "payment_method_data.bacs_debit.account_number": "string", + "payment_method_data.bacs_debit.sort_code": "string", + "payment_method_data.billing_details.email": "string", + "payment_method_data.billing_details.name": "string", + "payment_method_data.billing_details.phone": "string", + "payment_method_data.boleto.tax_id": "string", + "payment_method_data.eps.bank": "string", + "payment_method_data.fpx.account_holder_type": "string", + "payment_method_data.fpx.bank": "string", + "payment_method_data.ideal.bank": "string", + "payment_method_data.klarna.dob.day": "integer", + "payment_method_data.klarna.dob.month": "integer", + "payment_method_data.klarna.dob.year": "integer", + "payment_method_data.p24.bank": "string", + "payment_method_data.radar_options.session": "string", + "payment_method_data.sepa_debit.iban": "string", + "payment_method_data.sofort.country": "string", + "payment_method_data.type": "string", + "payment_method_data.us_bank_account.account_holder_type": "string", + "payment_method_data.us_bank_account.account_number": "string", + "payment_method_data.us_bank_account.account_type": "string", + "payment_method_data.us_bank_account.financial_connections_account": "string", + "payment_method_data.us_bank_account.routing_number": "string", + "payment_method_options.acss_debit.currency": "string", + "payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string", + "payment_method_options.acss_debit.mandate_options.default_for": "array", + "payment_method_options.acss_debit.mandate_options.interval_description": "string", + "payment_method_options.acss_debit.mandate_options.payment_schedule": "string", + "payment_method_options.acss_debit.mandate_options.transaction_type": "string", + "payment_method_options.acss_debit.verification_method": "string", + "payment_method_options.card.mandate_options.amount": "integer", + "payment_method_options.card.mandate_options.amount_type": "string", + "payment_method_options.card.mandate_options.currency": "string", + "payment_method_options.card.mandate_options.description": "string", + "payment_method_options.card.mandate_options.end_date": "integer", + "payment_method_options.card.mandate_options.interval": "string", + "payment_method_options.card.mandate_options.interval_count": "integer", + "payment_method_options.card.mandate_options.reference": "string", + "payment_method_options.card.mandate_options.start_date": "integer", + "payment_method_options.card.mandate_options.supported_types": "array", + "payment_method_options.card.moto": "boolean", + "payment_method_options.card.network": "string", + "payment_method_options.card.request_three_d_secure": "string", + "payment_method_options.card.three_d_secure.ares_trans_status": "string", + "payment_method_options.card.three_d_secure.cryptogram": "string", + "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string", + "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer", + "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string", + "payment_method_options.card.three_d_secure.transaction_id": "string", + "payment_method_options.card.three_d_secure.version": "string", + "payment_method_options.link.persistent_token": "string", + "payment_method_options.paypal.billing_agreement_id": "string", + "payment_method_options.us_bank_account.financial_connections.filters.account_subcategories": "array", + "payment_method_options.us_bank_account.financial_connections.permissions": "array", + "payment_method_options.us_bank_account.financial_connections.prefetch": "array", + "payment_method_options.us_bank_account.financial_connections.return_url": "string", + "payment_method_options.us_bank_account.mandate_options.collection_method": "string", + "payment_method_options.us_bank_account.networks.requested": "array", + "payment_method_options.us_bank_account.verification_method": "string", + "payment_method_types": "array", }, &Config) resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "verify_microdeposits", "/v1/setup_intents/{intent}/verify_microdeposits", http.MethodPost, map[string]string{ "amounts": "array", @@ -3468,6 +3488,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "starting_after": "string", }, &Config) resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "retrieve", "/v1/checkout/sessions/{session}", http.MethodGet, map[string]string{}, &Config) + resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "update", "/v1/checkout/sessions/{session}", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "cancel", "/v1/climate/orders/{order}/cancel", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "create", "/v1/climate/orders", http.MethodPost, map[string]string{ "amount": "integer", @@ -3542,13 +3563,14 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "features": "array", }, &Config) resource.NewOperationCmd(rFinancialConnectionsSessionsCmd.Cmd, "create", "/v1/financial_connections/sessions", http.MethodPost, map[string]string{ - "account_holder.account": "string", - "account_holder.customer": "string", - "account_holder.type": "string", - "filters.countries": "array", - "permissions": "array", - "prefetch": "array", - "return_url": "string", + "account_holder.account": "string", + "account_holder.customer": "string", + "account_holder.type": "string", + "filters.account_subcategories": "array", + "filters.countries": "array", + "permissions": "array", + "prefetch": "array", + "return_url": "string", }, &Config) resource.NewOperationCmd(rFinancialConnectionsSessionsCmd.Cmd, "retrieve", "/v1/financial_connections/sessions/{session}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rFinancialConnectionsTransactionsCmd.Cmd, "list", "/v1/financial_connections/transactions", http.MethodGet, map[string]string{ @@ -3617,48 +3639,95 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rIssuingAuthorizationsCmd.Cmd, "retrieve", "/v1/issuing/authorizations/{authorization}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingAuthorizationsCmd.Cmd, "update", "/v1/issuing/authorizations/{authorization}", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "capture", "/v1/test_helpers/issuing/authorizations/{authorization}/capture", http.MethodPost, map[string]string{ - "capture_amount": "integer", - "close_authorization": "boolean", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "capture_amount": "integer", + "close_authorization": "boolean", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "create", "/v1/test_helpers/issuing/authorizations", http.MethodPost, map[string]string{ - "amount": "integer", - "amount_details.atm_fee": "integer", - "amount_details.cashback_amount": "integer", - "authorization_method": "string", - "card": "string", - "currency": "string", - "is_amount_controllable": "boolean", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "network_data.acquiring_institution_id": "string", - "verification_data.address_line1_check": "string", - "verification_data.address_postal_code_check": "string", - "verification_data.authentication_exemption.claimed_by": "string", - "verification_data.authentication_exemption.type": "string", - "verification_data.cvc_check": "string", - "verification_data.expiry_check": "string", - "verification_data.three_d_secure.result": "string", + "amount": "integer", + "amount_details.atm_fee": "integer", + "amount_details.cashback_amount": "integer", + "authorization_method": "string", + "card": "string", + "currency": "string", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + "is_amount_controllable": "boolean", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "network_data.acquiring_institution_id": "string", + "verification_data.address_line1_check": "string", + "verification_data.address_postal_code_check": "string", + "verification_data.authentication_exemption.claimed_by": "string", + "verification_data.authentication_exemption.type": "string", + "verification_data.cvc_check": "string", + "verification_data.expiry_check": "string", + "verification_data.three_d_secure.result": "string", "wallet": "string", }, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "expire", "/v1/test_helpers/issuing/authorizations/{authorization}/expire", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "finalize_amount", "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount", http.MethodPost, map[string]string{ + "final_amount": "integer", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + }, &Config) resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "increment", "/v1/test_helpers/issuing/authorizations/{authorization}/increment", http.MethodPost, map[string]string{ "increment_amount": "integer", "is_amount_controllable": "boolean", @@ -3750,6 +3819,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "shipping.address.line2": "string", "shipping.address.postal_code": "string", "shipping.address.state": "string", + "shipping.address_validation.mode": "string", "shipping.customs.eori_number": "string", "shipping.name": "string", "shipping.phone_number": "string", @@ -3781,6 +3851,19 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "cancellation_reason": "string", "personalization_design": "string", "pin.encrypted_number": "string", + "shipping.address.city": "string", + "shipping.address.country": "string", + "shipping.address.line1": "string", + "shipping.address.line2": "string", + "shipping.address.postal_code": "string", + "shipping.address.state": "string", + "shipping.address_validation.mode": "string", + "shipping.customs.eori_number": "string", + "shipping.name": "string", + "shipping.phone_number": "string", + "shipping.require_signature": "boolean", + "shipping.service": "string", + "shipping.type": "string", "spending_controls.allowed_categories": "array", "spending_controls.allowed_merchant_countries": "array", "spending_controls.blocked_categories": "array", @@ -3877,54 +3960,78 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rIssuingTransactionsCmd.Cmd, "retrieve", "/v1/issuing/transactions/{transaction}", http.MethodGet, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingTransactionsCmd.Cmd, "update", "/v1/issuing/transactions/{transaction}", http.MethodPost, map[string]string{}, &Config) resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "create_force_capture", "/v1/test_helpers/issuing/transactions/create_force_capture", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "create_unlinked_refund", "/v1/test_helpers/issuing/transactions/create_unlinked_refund", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "refund", "/v1/test_helpers/issuing/transactions/{transaction}/refund", http.MethodPost, map[string]string{ "refund_amount": "integer", @@ -4136,6 +4243,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { }, &Config) resource.NewOperationCmd(rTaxTransactionsCmd.Cmd, "create_from_calculation", "/v1/tax/transactions/create_from_calculation", http.MethodPost, map[string]string{ "calculation": "string", + "posted_at": "integer", "reference": "string", }, &Config) resource.NewOperationCmd(rTaxTransactionsCmd.Cmd, "create_reversal", "/v1/tax/transactions/create_reversal", http.MethodPost, map[string]string{ @@ -4155,6 +4263,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { resource.NewOperationCmd(rTerminalConfigurationsCmd.Cmd, "create", "/v1/terminal/configurations", http.MethodPost, map[string]string{ "bbpos_wisepos_e.splashscreen": "string", "name": "string", + "reboot_window.end_hour": "integer", + "reboot_window.start_hour": "integer", "stripe_s700.splashscreen": "string", "verifone_p400.splashscreen": "string", }, &Config) @@ -4298,48 +4408,95 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "capture", "/v1/test_helpers/issuing/authorizations/{authorization}/capture", http.MethodPost, map[string]string{ - "capture_amount": "integer", - "close_authorization": "boolean", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "capture_amount": "integer", + "close_authorization": "boolean", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "create", "/v1/test_helpers/issuing/authorizations", http.MethodPost, map[string]string{ - "amount": "integer", - "amount_details.atm_fee": "integer", - "amount_details.cashback_amount": "integer", - "authorization_method": "string", - "card": "string", - "currency": "string", - "is_amount_controllable": "boolean", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "network_data.acquiring_institution_id": "string", - "verification_data.address_line1_check": "string", - "verification_data.address_postal_code_check": "string", - "verification_data.authentication_exemption.claimed_by": "string", - "verification_data.authentication_exemption.type": "string", - "verification_data.cvc_check": "string", - "verification_data.expiry_check": "string", - "verification_data.three_d_secure.result": "string", + "amount": "integer", + "amount_details.atm_fee": "integer", + "amount_details.cashback_amount": "integer", + "authorization_method": "string", + "card": "string", + "currency": "string", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + "is_amount_controllable": "boolean", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "network_data.acquiring_institution_id": "string", + "verification_data.address_line1_check": "string", + "verification_data.address_postal_code_check": "string", + "verification_data.authentication_exemption.claimed_by": "string", + "verification_data.authentication_exemption.type": "string", + "verification_data.cvc_check": "string", + "verification_data.expiry_check": "string", + "verification_data.three_d_secure.result": "string", "wallet": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "expire", "/v1/test_helpers/issuing/authorizations/{authorization}/expire", http.MethodPost, map[string]string{}, &Config) + resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "finalize_amount", "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount", http.MethodPost, map[string]string{ + "final_amount": "integer", + "fleet.cardholder_prompt_data.driver_id": "string", + "fleet.cardholder_prompt_data.odometer": "integer", + "fleet.cardholder_prompt_data.unspecified_id": "string", + "fleet.cardholder_prompt_data.user_id": "string", + "fleet.cardholder_prompt_data.vehicle_number": "string", + "fleet.purchase_type": "string", + "fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "fleet.reported_breakdown.tax.local_amount_decimal": "string", + "fleet.reported_breakdown.tax.national_amount_decimal": "string", + "fleet.service_type": "string", + "fuel.industry_product_code": "string", + "fuel.quantity_decimal": "string", + "fuel.type": "string", + "fuel.unit": "string", + "fuel.unit_cost_decimal": "string", + }, &Config) resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "increment", "/v1/test_helpers/issuing/authorizations/{authorization}/increment", http.MethodPost, map[string]string{ "increment_amount": "integer", "is_amount_controllable": "boolean", @@ -4358,54 +4515,78 @@ func addAllResourcesCmds(rootCmd *cobra.Command) { "rejection_reasons.carrier_text": "array", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "create_force_capture", "/v1/test_helpers/issuing/transactions/create_force_capture", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "create_unlinked_refund", "/v1/test_helpers/issuing/transactions/create_unlinked_refund", http.MethodPost, map[string]string{ - "amount": "integer", - "card": "string", - "currency": "string", - "merchant_data.category": "string", - "merchant_data.city": "string", - "merchant_data.country": "string", - "merchant_data.name": "string", - "merchant_data.network_id": "string", - "merchant_data.postal_code": "string", - "merchant_data.state": "string", - "merchant_data.terminal_id": "string", - "merchant_data.url": "string", - "purchase_details.flight.departure_at": "integer", - "purchase_details.flight.passenger_name": "string", - "purchase_details.flight.refundable": "boolean", - "purchase_details.flight.travel_agency": "string", - "purchase_details.fuel.quantity_decimal": "string", - "purchase_details.fuel.type": "string", - "purchase_details.fuel.unit": "string", - "purchase_details.fuel.unit_cost_decimal": "string", - "purchase_details.lodging.check_in_at": "integer", - "purchase_details.lodging.nights": "integer", - "purchase_details.reference": "string", + "amount": "integer", + "card": "string", + "currency": "string", + "merchant_data.category": "string", + "merchant_data.city": "string", + "merchant_data.country": "string", + "merchant_data.name": "string", + "merchant_data.network_id": "string", + "merchant_data.postal_code": "string", + "merchant_data.state": "string", + "merchant_data.terminal_id": "string", + "merchant_data.url": "string", + "purchase_details.fleet.cardholder_prompt_data.driver_id": "string", + "purchase_details.fleet.cardholder_prompt_data.odometer": "integer", + "purchase_details.fleet.cardholder_prompt_data.unspecified_id": "string", + "purchase_details.fleet.cardholder_prompt_data.user_id": "string", + "purchase_details.fleet.cardholder_prompt_data.vehicle_number": "string", + "purchase_details.fleet.purchase_type": "string", + "purchase_details.fleet.reported_breakdown.fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.non_fuel.gross_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.local_amount_decimal": "string", + "purchase_details.fleet.reported_breakdown.tax.national_amount_decimal": "string", + "purchase_details.fleet.service_type": "string", + "purchase_details.flight.departure_at": "integer", + "purchase_details.flight.passenger_name": "string", + "purchase_details.flight.refundable": "boolean", + "purchase_details.flight.travel_agency": "string", + "purchase_details.fuel.industry_product_code": "string", + "purchase_details.fuel.quantity_decimal": "string", + "purchase_details.fuel.type": "string", + "purchase_details.fuel.unit": "string", + "purchase_details.fuel.unit_cost_decimal": "string", + "purchase_details.lodging.check_in_at": "integer", + "purchase_details.lodging.nights": "integer", + "purchase_details.reference": "string", }, &Config) resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "refund", "/v1/test_helpers/issuing/transactions/{transaction}/refund", http.MethodPost, map[string]string{ "refund_amount": "integer", diff --git a/pkg/proxy/events_list.go b/pkg/proxy/events_list.go index 7c28a915f..7a24afbe4 100644 --- a/pkg/proxy/events_list.go +++ b/pkg/proxy/events_list.go @@ -91,6 +91,7 @@ var validEvents = map[string]bool{ "invoice.finalization_failed": true, "invoice.finalized": true, "invoice.marked_uncollectible": true, + "invoice.overdue": true, "invoice.paid": true, "invoice.payment_action_required": true, "invoice.payment_failed": true, @@ -99,6 +100,7 @@ var validEvents = map[string]bool{ "invoice.upcoming": true, "invoice.updated": true, "invoice.voided": true, + "invoice.will_be_due": true, "invoiceitem.created": true, "invoiceitem.deleted": true, "issuing_authorization.created": true, @@ -111,6 +113,7 @@ var validEvents = map[string]bool{ "issuing_dispute.closed": true, "issuing_dispute.created": true, "issuing_dispute.funds_reinstated": true, + "issuing_dispute.funds_rescinded": true, "issuing_dispute.submitted": true, "issuing_dispute.updated": true, "issuing_personalization_design.activated": true,