diff --git a/embedded/openapi/fixtures3.json b/embedded/openapi/fixtures3.json index 7b73c759..5326f65d 100644 --- a/embedded/openapi/fixtures3.json +++ b/embedded/openapi/fixtures3.json @@ -153,7 +153,8 @@ "features": { "capture_payments": true, "dispute_management": true, - "refund_management": true + "refund_management": true, + "destination_on_behalf_of_charge_management": true } }, "payments": { @@ -161,7 +162,8 @@ "features": { "capture_payments": true, "dispute_management": true, - "refund_management": true + "refund_management": true, + "destination_on_behalf_of_charge_management": true } }, "payouts": { @@ -183,6 +185,18 @@ "features": { "external_account_collection": true } + }, + "balances": { + "enabled": true, + "features": { + "edit_payout_schedule": true, + "instant_payouts": true, + "standard_payouts": true + } + }, + "payouts_list": { + "enabled": true, + "features": {} } }, "expires_at": 1234567890, @@ -643,7 +657,8 @@ "success_url": "https://example.com/success", "total_details": null, "ui_mode": "hosted", - "url": "https://checkout.stripe.com/pay/c/cs_test_a12et9VnHfV9NETJktvuOmVoyrOB40recOCQWiVNeDlBe4IqxEIRNi1Qdf" + "url": "https://checkout.stripe.com/pay/c/cs_test_a12et9VnHfV9NETJktvuOmVoyrOB40recOCQWiVNeDlBe4IqxEIRNi1Qdf", + "saved_payment_method_options": null }, "climate.order": { "amount_fees": 300, @@ -1705,7 +1720,6 @@ "updated": 1234567890 }, "forwarding.request": { - "config": "fwdcfg_123", "created": 1234567890, "id": "fwdreq_123", "livemode": false, @@ -4904,6 +4918,12 @@ "id": "obj_123", "livemode": true, "object": "product_feature" + }, + "entitlements.active_entitlement_summary": { + "customer": "customer", + "entitlements": null, + "livemode": true, + "object": "entitlements.active_entitlement_summary" } } } \ No newline at end of file diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json index 195ce6e5..2a2a1a89 100644 --- a/embedded/openapi/spec3.beta.sdk.json +++ b/embedded/openapi/spec3.beta.sdk.json @@ -4156,12 +4156,12 @@ "type": "string" }, "event_name": { - "description": "The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.", + "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 5000, "type": "string" }, "event_time_window": { - "description": "The time window to pre-aggregate usage events for, if any.", + "description": "The time window to pre-aggregate meter events for, if any.", "enum": [ "day", "hour" @@ -4313,7 +4313,7 @@ "maxLength": 100, "type": "string" }, - "description": "The payload of the event.", + "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { @@ -4425,11 +4425,11 @@ "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.", "properties": { "aggregated_value": { - "description": "Aggregated value of all the events within start_time (inclusive) and end_time (inclusive). The aggregation strategy is defined on meter via `default_aggregation``.", + "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.", "type": "number" }, "end_time": { - "description": "End timestamp for this usage summary (inclusive).", + "description": "End timestamp for this event summary (inclusive).", "format": "unix-time", "type": "integer" }, @@ -4443,7 +4443,7 @@ "type": "boolean" }, "meter": { - "description": "The meter associated with this usage summary.", + "description": "The meter associated with this event summary.", "maxLength": 5000, "type": "string" }, @@ -4455,7 +4455,7 @@ "type": "string" }, "start_time": { - "description": "Start timestamp for this usage summary (inclusive).", + "description": "Start timestamp for this event summary (inclusive).", "format": "unix-time", "type": "integer" } @@ -4588,7 +4588,7 @@ "description": "", "properties": { "event_payload_key": { - "description": "The key in the usage event payload to use as the value for this meter.", + "description": "The key in the meter event payload to use as the value for this meter.", "maxLength": 5000, "type": "string" } @@ -4604,7 +4604,7 @@ "description": "", "properties": { "event_payload_key": { - "description": "The key in the usage event payload to use for mapping the event to a customer.", + "description": "The key in the meter event payload to use for mapping the event to a customer.", "maxLength": 5000, "type": "string" }, @@ -7632,6 +7632,15 @@ "maxLength": 5000, "type": "string" }, + "saved_payment_method_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options" + } + ], + "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", + "nullable": true + }, "setup_intent": { "anyOf": [ { @@ -7800,6 +7809,7 @@ "payment_method_types", "payment_status", "recovered_from", + "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", @@ -7833,6 +7843,7 @@ "payment_method_configuration_details", "payment_method_options", "phone_number_collection", + "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", @@ -8451,6 +8462,21 @@ "type": "object", "x-expandableFields": [] }, + "checkout_mobilepay_payment_method_options": { + "description": "", + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "CheckoutMobilepayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "checkout_oxxo_payment_method_options": { "description": "", "properties": { @@ -8653,6 +8679,9 @@ "link": { "$ref": "#/components/schemas/checkout_link_payment_method_options" }, + "mobilepay": { + "$ref": "#/components/schemas/checkout_mobilepay_payment_method_options" + }, "oxxo": { "$ref": "#/components/schemas/checkout_oxxo_payment_method_options" }, @@ -8707,6 +8736,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -10030,7 +10060,7 @@ ] } }, - "connect_embedded_account_config": { + "connect_embedded_account_config_claim": { "description": "", "properties": { "enabled": { @@ -10038,14 +10068,14 @@ "type": "boolean" }, "features": { - "$ref": "#/components/schemas/connect_embedded_account_features" + "$ref": "#/components/schemas/connect_embedded_account_features_claim" } }, "required": [ "enabled", "features" ], - "title": "ConnectEmbeddedAccountConfig", + "title": "ConnectEmbeddedAccountConfigClaim", "type": "object", "x-expandableFields": [ "features" @@ -10055,7 +10085,7 @@ "in_package": "" } }, - "connect_embedded_account_features": { + "connect_embedded_account_features_claim": { "description": "", "properties": { "external_account_collection": { @@ -10066,7 +10096,7 @@ "required": [ "external_account_collection" ], - "title": "ConnectEmbeddedAccountFeatures", + "title": "ConnectEmbeddedAccountFeaturesClaim", "type": "object", "x-expandableFields": [], "x-stripeResource": { @@ -10078,10 +10108,13 @@ "description": "", "properties": { "account_management": { - "$ref": "#/components/schemas/connect_embedded_account_config" + "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "account_onboarding": { - "$ref": "#/components/schemas/connect_embedded_account_config" + "$ref": "#/components/schemas/connect_embedded_account_config_claim" + }, + "balances": { + "$ref": "#/components/schemas/connect_embedded_payouts_config_claim" }, "capital_financing_promotion": { "anyOf": [ @@ -10095,38 +10128,45 @@ "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "notification_banner": { - "$ref": "#/components/schemas/connect_embedded_account_config" + "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "payment_details": { - "$ref": "#/components/schemas/connect_embedded_payments_config" + "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payments": { - "$ref": "#/components/schemas/connect_embedded_payments_config" + "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payouts": { - "$ref": "#/components/schemas/connect_embedded_payouts_config" + "$ref": "#/components/schemas/connect_embedded_payouts_config_claim" + }, + "payouts_list": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" } }, "required": [ "account_management", "account_onboarding", + "balances", "documents", "notification_banner", "payment_details", "payments", - "payouts" + "payouts", + "payouts_list" ], "title": "ConnectEmbeddedAccountSessionCreateComponents", "type": "object", "x-expandableFields": [ "account_management", "account_onboarding", + "balances", "capital_financing_promotion", "documents", "notification_banner", "payment_details", "payments", - "payouts" + "payouts", + "payouts_list" ], "x-stripeResource": { "class_name": "Components", @@ -10194,7 +10234,7 @@ "in_package": "" } }, - "connect_embedded_payments_config": { + "connect_embedded_payments_config_claim": { "description": "", "properties": { "enabled": { @@ -10209,7 +10249,7 @@ "enabled", "features" ], - "title": "ConnectEmbeddedPaymentsConfig", + "title": "ConnectEmbeddedPaymentsConfigClaim", "type": "object", "x-expandableFields": [ "features" @@ -10241,6 +10281,7 @@ }, "required": [ "capture_payments", + "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], @@ -10252,7 +10293,7 @@ "in_package": "" } }, - "connect_embedded_payouts_config": { + "connect_embedded_payouts_config_claim": { "description": "", "properties": { "enabled": { @@ -10267,7 +10308,7 @@ "enabled", "features" ], - "title": "ConnectEmbeddedPayoutsConfig", + "title": "ConnectEmbeddedPayoutsConfigClaim", "type": "object", "x-expandableFields": [ "features" @@ -17955,13 +17996,8 @@ ] }, "forwarding.request": { - "description": "Instructs Stripe to make a request on your behalf using the destination URL and HTTP method in the config.\nA config is set up for each destination URL by Stripe at the time of onboarding. Stripe verifies requests with\nyour credentials in the config, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).", + "description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).", "properties": { - "config": { - "description": "The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.", - "maxLength": 5000, - "type": "string" - }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", @@ -18036,7 +18072,6 @@ } }, "required": [ - "config", "created", "id", "livemode", @@ -22204,6 +22239,23 @@ "type": "object", "x-expandableFields": [] }, + "invoice_setting_customer_rendering_options": { + "description": "", + "properties": { + "amount_tax_display": { + "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "amount_tax_display" + ], + "title": "InvoiceSettingCustomerRenderingOptions", + "type": "object", + "x-expandableFields": [] + }, "invoice_setting_customer_setting": { "description": "", "properties": { @@ -22244,7 +22296,7 @@ "rendering_options": { "anyOf": [ { - "$ref": "#/components/schemas/invoice_setting_rendering_options" + "$ref": "#/components/schemas/invoice_setting_customer_rendering_options" } ], "description": "Default options for invoice PDF rendering for this customer.", @@ -30216,7 +30268,7 @@ "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "description": "The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`.", "maxLength": 5000, "type": "string" }, @@ -44779,6 +44831,40 @@ "type": "object", "x-expandableFields": [] }, + "payment_pages_checkout_session_saved_payment_method_options": { + "description": "", + "properties": { + "allow_redisplay_filters": { + "description": "Controls which payment methods are eligible to be redisplayed to returning customers. Corresponds to `allow_redisplay` on the payment method.", + "items": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "payment_method_save": { + "description": "Enable customers to choose if they wish to save their payment method for future use.", + "enum": [ + "disabled", + "enabled" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "allow_redisplay_filters", + "payment_method_save" + ], + "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "payment_pages_checkout_session_shipping_address_collection": { "description": "", "properties": { @@ -71518,6 +71604,39 @@ "title": "account_config_param", "type": "object" }, + "balances": { + "description": "Configuration for the balances 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": { + "edit_payout_schedule": { + "description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", + "type": "boolean" + }, + "instant_payouts": { + "description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", + "type": "boolean" + }, + "standard_payouts": { + "description": "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", + "type": "boolean" + } + }, + "title": "payouts_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "payouts_config_param", + "type": "object" + }, "capital_financing_promotion": { "properties": { "enabled": { @@ -71537,6 +71656,26 @@ "title": "base_config_param", "type": "object" }, + "capital_overview": { + "description": "Configuration for the capital overview 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" + }, "documents": { "description": "Configuration for the documents embedded component.", "properties": { @@ -71789,6 +71928,66 @@ ], "title": "payouts_config_param", "type": "object" + }, + "payouts_list": { + "description": "Configuration for the payouts list 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_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", @@ -80715,11 +80914,11 @@ "additionalProperties": { "type": "string" }, - "description": "The payload of the event. This must contain a field with the event's numerical value and a field to map the event to a customer.", + "description": "The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { - "description": "The time of the event. Measured in seconds since the Unix epoch. Defaults to current timestamp if not specified.", + "description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.", "format": "unix-time", "type": "integer" } @@ -80951,7 +81150,7 @@ "description": "The default settings to aggregate a meter's events with.", "properties": { "formula": { - "description": "Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value, or `last` to use the last event's value.", + "description": "Specifies how events are aggregated. Allowed values are `count` to count the number of events and `sum` to sum each event's value.", "enum": [ "count", "sum" @@ -80971,12 +81170,12 @@ "type": "string" }, "event_name": { - "description": "The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.", + "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 100, "type": "string" }, "event_time_window": { - "description": "The time window to pre-aggregate usage events for, if any.", + "description": "The time window to pre-aggregate meter events for, if any.", "enum": [ "day", "hour" @@ -80992,7 +81191,7 @@ "type": "array" }, "value_settings": { - "description": "Fields that specify how to calculate a usage event's value.", + "description": "Fields that specify how to calculate a meter event's value.", "properties": { "event_payload_key": { "description": "The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytes_used` field, then set the event_payload_key to \"bytes_used\".", @@ -81267,7 +81466,7 @@ "style": "form" }, { - "description": "The timestamp from when to stop aggregating usage events (exclusive).", + "description": "The timestamp from when to stop aggregating meter events (exclusive).", "in": "query", "name": "end_time", "required": true, @@ -81325,7 +81524,7 @@ "style": "form" }, { - "description": "The timestamp from when to start aggregating usage events (inclusive).", + "description": "The timestamp from when to start aggregating meter events (inclusive).", "in": "query", "name": "start_time", "required": true, @@ -86560,6 +86759,10 @@ "explode": true, "style": "deepObject" }, + "payment_method_data": { + "explode": true, + "style": "deepObject" + }, "payment_method_options": { "explode": true, "style": "deepObject" @@ -86572,6 +86775,10 @@ "explode": true, "style": "deepObject" }, + "saved_payment_method_options": { + "explode": true, + "style": "deepObject" + }, "setup_intent_data": { "explode": true, "style": "deepObject" @@ -87558,6 +87765,22 @@ "maxLength": 100, "type": "string" }, + "payment_method_data": { + "description": "This parameter allows you to set some attributes on the payment method created during a Checkout session.", + "properties": { + "allow_redisplay": { + "description": "Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + } + }, + "title": "payment_method_data_param", + "type": "object" + }, "payment_method_options": { "description": "Payment-method-specific configuration.", "properties": { @@ -88024,6 +88247,20 @@ "title": "payment_method_options_param", "type": "object" }, + "mobilepay": { + "description": "contains details about the Mobilepay payment method options.", + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, "oxxo": { "description": "contains details about the OXXO payment method options.", "properties": { @@ -88338,6 +88575,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -88386,6 +88624,33 @@ "maxLength": 5000, "type": "string" }, + "saved_payment_method_options": { + "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", + "properties": { + "allow_redisplay_filters": { + "description": "Controls which payment methods are eligible to be redisplayed to returning customers. Corresponds to `allow_redisplay` on the payment method.", + "items": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_save": { + "description": "Enable customers to choose if they wish to save their payment method for future use.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string" + } + }, + "title": "saved_payment_method_options_param", + "type": "object" + }, "setup_intent_data": { "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.", "properties": { @@ -93062,7 +93327,7 @@ "type": "string" } }, - "title": "rendering_options_param", + "title": "customer_rendering_options_param", "type": "object" }, { @@ -93854,7 +94119,7 @@ "type": "string" } }, - "title": "rendering_options_param", + "title": "customer_rendering_options_param", "type": "object" }, { @@ -95039,6 +95304,21 @@ "description": "

Returns a list of PaymentMethods for a given Customer

", "operationId": "GetCustomersCustomerPaymentMethods", "parameters": [ + { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "in": "query", + "name": "allow_redisplay", + "required": false, + "schema": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "style": "form" + }, { "in": "path", "name": "customer", @@ -100940,11 +101220,6 @@ "schema": { "additionalProperties": false, "properties": { - "config": { - "description": "The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.", - "maxLength": 5000, - "type": "string" - }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -101014,7 +101289,6 @@ } }, "required": [ - "config", "payment_method", "replacements", "url" @@ -111702,6 +111976,16 @@ ] }, "style": "deepObject" + }, + { + "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", + "in": "query", + "name": "subscription_trial_from_plan", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "requestBody": { @@ -114993,6 +115277,16 @@ ] }, "style": "deepObject" + }, + { + "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", + "in": "query", + "name": "subscription_trial_from_plan", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" } ], "requestBody": { @@ -134899,6 +135193,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -139012,6 +139315,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -144061,6 +144373,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -153218,6 +153539,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -154092,6 +154422,15 @@ "schema": { "additionalProperties": false, "properties": { + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { @@ -168859,6 +169198,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -170345,6 +170693,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -171863,6 +172220,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -191657,6 +192023,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -193206,9 +193581,10 @@ "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "description": "The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`.", "enum": [ "liter", + "other", "us_gallon" ], "maxLength": 5000, @@ -194517,9 +194893,10 @@ "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "description": "The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`.", "enum": [ "liter", + "other", "us_gallon" ], "maxLength": 5000, @@ -195100,9 +195477,10 @@ "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "description": "The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`.", "enum": [ "liter", + "other", "us_gallon" ], "maxLength": 5000, diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index c6fdede8..736d9924 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -3106,12 +3106,12 @@ "type": "string" }, "event_name": { - "description": "The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.", + "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 5000, "type": "string" }, "event_time_window": { - "description": "The time window to pre-aggregate usage events for, if any.", + "description": "The time window to pre-aggregate meter events for, if any.", "enum": [ "day", "hour" @@ -3213,7 +3213,7 @@ "maxLength": 100, "type": "string" }, - "description": "The payload of the event.", + "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { @@ -3298,11 +3298,11 @@ "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.", "properties": { "aggregated_value": { - "description": "Aggregated value of all the events within start_time (inclusive) and end_time (inclusive). The aggregation strategy is defined on meter via `default_aggregation``.", + "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.", "type": "number" }, "end_time": { - "description": "End timestamp for this usage summary (inclusive).", + "description": "End timestamp for this event summary (inclusive).", "format": "unix-time", "type": "integer" }, @@ -3316,7 +3316,7 @@ "type": "boolean" }, "meter": { - "description": "The meter associated with this usage summary.", + "description": "The meter associated with this event summary.", "maxLength": 5000, "type": "string" }, @@ -3328,7 +3328,7 @@ "type": "string" }, "start_time": { - "description": "Start timestamp for this usage summary (inclusive).", + "description": "Start timestamp for this event summary (inclusive).", "format": "unix-time", "type": "integer" } @@ -3435,7 +3435,7 @@ "description": "", "properties": { "event_payload_key": { - "description": "The key in the usage event payload to use as the value for this meter.", + "description": "The key in the meter event payload to use as the value for this meter.", "maxLength": 5000, "type": "string" } @@ -3451,7 +3451,7 @@ "description": "", "properties": { "event_payload_key": { - "description": "The key in the usage event payload to use for mapping the event to a customer.", + "description": "The key in the meter event payload to use for mapping the event to a customer.", "maxLength": 5000, "type": "string" }, @@ -5206,6 +5206,15 @@ "maxLength": 5000, "type": "string" }, + "saved_payment_method_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options" + } + ], + "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", + "nullable": true + }, "setup_intent": { "anyOf": [ { @@ -5370,6 +5379,7 @@ "payment_method_configuration_details", "payment_method_options", "phone_number_collection", + "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", @@ -5864,6 +5874,21 @@ "type": "object", "x-expandableFields": [] }, + "checkout_mobilepay_payment_method_options": { + "description": "", + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).", + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "CheckoutMobilepayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "checkout_oxxo_payment_method_options": { "description": "", "properties": { @@ -6051,6 +6076,9 @@ "link": { "$ref": "#/components/schemas/checkout_link_payment_method_options" }, + "mobilepay": { + "$ref": "#/components/schemas/checkout_mobilepay_payment_method_options" + }, "oxxo": { "$ref": "#/components/schemas/checkout_oxxo_payment_method_options" }, @@ -6105,6 +6133,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -7111,7 +7140,7 @@ "destination" ] }, - "connect_embedded_account_config": { + "connect_embedded_account_config_claim": { "description": "", "properties": { "enabled": { @@ -7119,20 +7148,20 @@ "type": "boolean" }, "features": { - "$ref": "#/components/schemas/connect_embedded_account_features" + "$ref": "#/components/schemas/connect_embedded_account_features_claim" } }, "required": [ "enabled", "features" ], - "title": "ConnectEmbeddedAccountConfig", + "title": "ConnectEmbeddedAccountConfigClaim", "type": "object", "x-expandableFields": [ "features" ] }, - "connect_embedded_account_features": { + "connect_embedded_account_features_claim": { "description": "", "properties": { "external_account_collection": { @@ -7143,7 +7172,7 @@ "required": [ "external_account_collection" ], - "title": "ConnectEmbeddedAccountFeatures", + "title": "ConnectEmbeddedAccountFeaturesClaim", "type": "object", "x-expandableFields": [] }, @@ -7151,46 +7180,56 @@ "description": "", "properties": { "account_management": { - "$ref": "#/components/schemas/connect_embedded_account_config" + "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "account_onboarding": { - "$ref": "#/components/schemas/connect_embedded_account_config" + "$ref": "#/components/schemas/connect_embedded_account_config_claim" + }, + "balances": { + "$ref": "#/components/schemas/connect_embedded_payouts_config_claim" }, "documents": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, "notification_banner": { - "$ref": "#/components/schemas/connect_embedded_account_config" + "$ref": "#/components/schemas/connect_embedded_account_config_claim" }, "payment_details": { - "$ref": "#/components/schemas/connect_embedded_payments_config" + "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payments": { - "$ref": "#/components/schemas/connect_embedded_payments_config" + "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payouts": { - "$ref": "#/components/schemas/connect_embedded_payouts_config" + "$ref": "#/components/schemas/connect_embedded_payouts_config_claim" + }, + "payouts_list": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" } }, "required": [ "account_management", "account_onboarding", + "balances", "documents", "notification_banner", "payment_details", "payments", - "payouts" + "payouts", + "payouts_list" ], "title": "ConnectEmbeddedAccountSessionCreateComponents", "type": "object", "x-expandableFields": [ "account_management", "account_onboarding", + "balances", "documents", "notification_banner", "payment_details", "payments", - "payouts" + "payouts", + "payouts_list" ] }, "connect_embedded_base_config_claim": { @@ -7221,7 +7260,7 @@ "type": "object", "x-expandableFields": [] }, - "connect_embedded_payments_config": { + "connect_embedded_payments_config_claim": { "description": "", "properties": { "enabled": { @@ -7236,7 +7275,7 @@ "enabled", "features" ], - "title": "ConnectEmbeddedPaymentsConfig", + "title": "ConnectEmbeddedPaymentsConfigClaim", "type": "object", "x-expandableFields": [ "features" @@ -7264,6 +7303,7 @@ }, "required": [ "capture_payments", + "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], @@ -7271,7 +7311,7 @@ "type": "object", "x-expandableFields": [] }, - "connect_embedded_payouts_config": { + "connect_embedded_payouts_config_claim": { "description": "", "properties": { "enabled": { @@ -7286,7 +7326,7 @@ "enabled", "features" ], - "title": "ConnectEmbeddedPayoutsConfig", + "title": "ConnectEmbeddedPayoutsConfigClaim", "type": "object", "x-expandableFields": [ "features" @@ -12456,13 +12496,8 @@ ] }, "forwarding.request": { - "description": "Instructs Stripe to make a request on your behalf using the destination URL and HTTP method in the config.\nA config is set up for each destination URL by Stripe at the time of onboarding. Stripe verifies requests with\nyour credentials in the config, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).", + "description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).", "properties": { - "config": { - "description": "The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.", - "maxLength": 5000, - "type": "string" - }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", @@ -12537,7 +12572,6 @@ } }, "required": [ - "config", "created", "id", "livemode", @@ -15276,6 +15310,20 @@ "type": "object", "x-expandableFields": [] }, + "invoice_setting_customer_rendering_options": { + "description": "", + "properties": { + "amount_tax_display": { + "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "InvoiceSettingCustomerRenderingOptions", + "type": "object", + "x-expandableFields": [] + }, "invoice_setting_customer_setting": { "description": "", "properties": { @@ -15316,7 +15364,7 @@ "rendering_options": { "anyOf": [ { - "$ref": "#/components/schemas/invoice_setting_rendering_options" + "$ref": "#/components/schemas/invoice_setting_customer_rendering_options" } ], "description": "Default options for invoice PDF rendering for this customer.", @@ -21513,7 +21561,7 @@ "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "description": "The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`.", "maxLength": 5000, "type": "string" }, @@ -32361,6 +32409,36 @@ "type": "object", "x-expandableFields": [] }, + "payment_pages_checkout_session_saved_payment_method_options": { + "description": "", + "properties": { + "allow_redisplay_filters": { + "description": "Controls which payment methods are eligible to be redisplayed to returning customers. Corresponds to `allow_redisplay` on the payment method.", + "items": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "payment_method_save": { + "description": "Enable customers to choose if they wish to save their payment method for future use.", + "enum": [ + "disabled", + "enabled" + ], + "nullable": true, + "type": "string" + } + }, + "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "payment_pages_checkout_session_shipping_address_collection": { "description": "", "properties": { @@ -49364,6 +49442,33 @@ "title": "account_config_param", "type": "object" }, + "balances": { + "properties": { + "enabled": { + "type": "boolean" + }, + "features": { + "properties": { + "edit_payout_schedule": { + "type": "boolean" + }, + "instant_payouts": { + "type": "boolean" + }, + "standard_payouts": { + "type": "boolean" + } + }, + "title": "payouts_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "payouts_config_param", + "type": "object" + }, "documents": { "properties": { "enabled": { @@ -49488,6 +49593,23 @@ ], "title": "payouts_config_param", "type": "object" + }, + "payouts_list": { + "properties": { + "enabled": { + "type": "boolean" + }, + "features": { + "properties": {}, + "title": "base_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "base_config_param", + "type": "object" } }, "title": "account_session_create_components_param", @@ -59654,11 +59776,11 @@ "additionalProperties": { "type": "string" }, - "description": "The payload of the event. This must contain a field with the event's numerical value and a field to map the event to a customer.", + "description": "The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", "type": "object" }, "timestamp": { - "description": "The time of the event. Measured in seconds since the Unix epoch. Defaults to current timestamp if not specified.", + "description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.", "format": "unix-time", "type": "integer" } @@ -59907,12 +60029,12 @@ "type": "string" }, "event_name": { - "description": "The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.", + "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", "maxLength": 100, "type": "string" }, "event_time_window": { - "description": "The time window to pre-aggregate usage events for, if any.", + "description": "The time window to pre-aggregate meter events for, if any.", "enum": [ "day", "hour" @@ -59928,7 +60050,7 @@ "type": "array" }, "value_settings": { - "description": "Fields that specify how to calculate a usage event's value.", + "description": "Fields that specify how to calculate a meter event's value.", "properties": { "event_payload_key": { "maxLength": 100, @@ -60202,7 +60324,7 @@ "style": "form" }, { - "description": "The timestamp from when to stop aggregating usage events (exclusive).", + "description": "The timestamp from when to stop aggregating meter events (exclusive).", "in": "query", "name": "end_time", "required": true, @@ -60260,7 +60382,7 @@ "style": "form" }, { - "description": "The timestamp from when to start aggregating usage events (inclusive).", + "description": "The timestamp from when to start aggregating meter events (inclusive).", "in": "query", "name": "start_time", "required": true, @@ -63883,6 +64005,10 @@ "explode": true, "style": "deepObject" }, + "payment_method_data": { + "explode": true, + "style": "deepObject" + }, "payment_method_options": { "explode": true, "style": "deepObject" @@ -63895,6 +64021,10 @@ "explode": true, "style": "deepObject" }, + "saved_payment_method_options": { + "explode": true, + "style": "deepObject" + }, "setup_intent_data": { "explode": true, "style": "deepObject" @@ -64779,6 +64909,21 @@ "maxLength": 100, "type": "string" }, + "payment_method_data": { + "description": "This parameter allows you to set some attributes on the payment method created during a Checkout session.", + "properties": { + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + } + }, + "title": "payment_method_data_param", + "type": "object" + }, "payment_method_options": { "description": "Payment-method-specific configuration.", "properties": { @@ -65184,6 +65329,18 @@ "title": "payment_method_options_param", "type": "object" }, + "mobilepay": { + "properties": { + "setup_future_usage": { + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, "oxxo": { "properties": { "expires_after_days": { @@ -65451,6 +65608,7 @@ "klarna", "konbini", "link", + "mobilepay", "oxxo", "p24", "paynow", @@ -65497,6 +65655,31 @@ "maxLength": 5000, "type": "string" }, + "saved_payment_method_options": { + "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", + "properties": { + "allow_redisplay_filters": { + "items": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_save": { + "enum": [ + "disabled", + "enabled" + ], + "type": "string" + } + }, + "title": "saved_payment_method_options_param", + "type": "object" + }, "setup_intent_data": { "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.", "properties": { @@ -69917,7 +70100,7 @@ "type": "string" } }, - "title": "rendering_options_param", + "title": "customer_rendering_options_param", "type": "object" }, { @@ -70829,7 +71012,7 @@ "type": "string" } }, - "title": "rendering_options_param", + "title": "customer_rendering_options_param", "type": "object" }, { @@ -73618,264 +73801,279 @@ "operationId": "GetCustomersCustomerPaymentMethods", "parameters": [ { - "in": "path", - "name": "customer", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "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": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "in": "query", - "name": "starting_after", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.", + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", "in": "query", - "name": "type", + "name": "allow_redisplay", "required": false, "schema": { "enum": [ - "acss_debit", - "affirm", - "afterpay_clearpay", - "alipay", - "amazon_pay", - "au_becs_debit", - "bacs_debit", - "bancontact", - "blik", - "boleto", - "card", - "cashapp", - "customer_balance", - "eps", - "fpx", - "giropay", - "grabpay", - "ideal", - "klarna", - "konbini", - "link", - "mobilepay", - "oxxo", - "p24", - "paynow", - "paypal", - "pix", - "promptpay", - "revolut_pay", - "sepa_debit", - "sofort", - "swish", - "us_bank_account", - "wechat_pay", - "zip" + "always", + "limited", + "unspecified" ], - "type": "string", - "x-stripeBypassValidation": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/payment_method" - }, - "type": "array" - }, - "has_more": { - "description": "True if this list has another page of items after this one that can be fetched.", - "type": "boolean" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "enum": [ - "list" - ], - "type": "string" - }, - "url": { - "description": "The URL where this list can be accessed.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ], - "title": "CustomerPaymentMethodResourceList", - "type": "object", - "x-expandableFields": [ - "data" - ] - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/customers/{customer}/payment_methods/{payment_method}": { - "get": { - "description": "

Retrieves a PaymentMethod object for a given Customer.

", - "operationId": "GetCustomersCustomerPaymentMethodsPaymentMethod", - "parameters": [ - { - "in": "path", - "name": "customer", - "required": true, - "schema": { - "maxLength": 5000, "type": "string" }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "payment_method", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/payment_method" - } - } - }, - "description": "Successful response." + "style": "form" }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/customers/{customer}/sources": { - "get": { - "description": "

List sources for a specified customer.

", - "operationId": "GetCustomersCustomerSources", - "parameters": [ + { + "in": "path", + "name": "customer", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "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": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "us_bank_account", + "wechat_pay", + "zip" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/payment_method" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "CustomerPaymentMethodResourceList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/customers/{customer}/payment_methods/{payment_method}": { + "get": { + "description": "

Retrieves a PaymentMethod object for a given Customer.

", + "operationId": "GetCustomersCustomerPaymentMethodsPaymentMethod", + "parameters": [ + { + "in": "path", + "name": "customer", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "payment_method", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/customers/{customer}/sources": { + "get": { + "description": "

List sources for a specified customer.

", + "operationId": "GetCustomersCustomerSources", + "parameters": [ { "in": "path", "name": "customer", @@ -81621,11 +81819,6 @@ "schema": { "additionalProperties": false, "properties": { - "config": { - "description": "The Forwarding Config used when making the forwarded request. The config specifes the HTTP method, merchant credentials, connection settings, and supported destination URLs.", - "maxLength": 5000, - "type": "string" - }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -81691,7 +81884,6 @@ } }, "required": [ - "config", "payment_method", "replacements", "url" @@ -84847,523 +85039,1933 @@ } } }, - "/v1/invoices/search": { - "get": { - "description": "

Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", - "operationId": "GetInvoicesSearch", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).", - "in": "query", - "name": "query", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - } - ], + "/v1/invoices/create_preview": { + "post": { + "description": "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

", + "operationId": "PostInvoicesCreatePreview", "requestBody": { "content": { "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/invoice" - }, - "type": "array" - }, - "has_more": { - "type": "boolean" - }, - "next_page": { - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value.", - "enum": [ - "search_result" - ], - "type": "string" - }, - "total_count": { - "description": "The total number of objects that match the query, only accurate up to 10,000.", - "type": "integer" - }, - "url": { - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ], - "title": "SearchResult", - "type": "object", - "x-expandableFields": [ - "data" - ] - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/invoices/upcoming": { - "get": { - "description": "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date value passed in the request.

", - "operationId": "GetInvoicesUpcoming", - "parameters": [ - { - "description": "Settings for automatic tax lookup for this invoice preview.", - "explode": true, - "in": "query", - "name": "automatic_tax", - "required": false, - "schema": { - "properties": { - "enabled": { - "type": "boolean" + "encoding": { + "automatic_tax": { + "explode": true, + "style": "deepObject" }, - "liability": { - "properties": { - "account": { - "type": "string" - }, - "type": { - "enum": [ - "account", - "self" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "title": "param", - "type": "object" - } - }, - "required": [ - "enabled" - ], - "title": "automatic_tax_param", - "type": "object" - }, - "style": "deepObject" - }, - { - "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", - "in": "query", - "name": "coupon", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.", - "in": "query", - "name": "currency", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", - "in": "query", - "name": "customer", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", - "explode": true, - "in": "query", - "name": "customer_details", - "required": false, - "schema": { - "properties": { - "address": { - "anyOf": [ - { - "properties": { - "city": { - "maxLength": 5000, - "type": "string" - }, - "country": { - "maxLength": 5000, - "type": "string" - }, - "line1": { - "maxLength": 5000, - "type": "string" - }, - "line2": { - "maxLength": 5000, - "type": "string" - }, - "postal_code": { - "maxLength": 5000, - "type": "string" - }, - "state": { - "maxLength": 5000, - "type": "string" - } - }, - "title": "optional_fields_address", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] + "customer_details": { + "explode": true, + "style": "deepObject" }, - "shipping": { - "anyOf": [ - { - "properties": { - "address": { - "properties": { - "city": { - "maxLength": 5000, - "type": "string" - }, - "country": { - "maxLength": 5000, - "type": "string" - }, - "line1": { - "maxLength": 5000, - "type": "string" - }, - "line2": { - "maxLength": 5000, - "type": "string" - }, - "postal_code": { - "maxLength": 5000, - "type": "string" - }, - "state": { - "maxLength": 5000, - "type": "string" - } - }, - "title": "optional_fields_address", - "type": "object" - }, - "name": { - "maxLength": 5000, - "type": "string" - }, - "phone": { - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "address", - "name" - ], - "title": "customer_shipping", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] + "discounts": { + "explode": true, + "style": "deepObject" }, - "tax": { - "properties": { - "ip_address": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] - } - }, - "title": "tax_param", - "type": "object" + "expand": { + "explode": true, + "style": "deepObject" }, - "tax_exempt": { - "enum": [ - "", - "exempt", - "none", - "reverse" - ], - "type": "string" + "invoice_items": { + "explode": true, + "style": "deepObject" }, - "tax_ids": { - "items": { - "properties": { - "type": { - "enum": [ - "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", - "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", - "za_vat" - ], - "maxLength": 5000, - "type": "string", - "x-stripeBypassValidation": true - }, - "value": { - "type": "string" - } - }, - "required": [ - "type", - "value" - ], - "title": "data_params", - "type": "object" - }, - "type": "array" + "issuer": { + "explode": true, + "style": "deepObject" + }, + "on_behalf_of": { + "explode": true, + "style": "deepObject" + }, + "schedule_details": { + "explode": true, + "style": "deepObject" + }, + "subscription_details": { + "explode": true, + "style": "deepObject" } }, - "title": "customer_details_param", - "type": "object" - }, - "style": "deepObject" - }, - { - "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", - "explode": true, - "in": "query", - "name": "discounts", - "required": false, - "schema": { - "anyOf": [ - { - "items": { + "schema": { + "additionalProperties": false, + "properties": { + "automatic_tax": { + "description": "Settings for automatic tax lookup for this invoice preview.", "properties": { - "coupon": { - "maxLength": 5000, - "type": "string" - }, - "discount": { - "maxLength": 5000, - "type": "string" + "enabled": { + "type": "boolean" }, - "promotion_code": { - "maxLength": 5000, - "type": "string" + "liability": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, - "title": "discounts_data_param", + "required": [ + "enabled" + ], + "title": "automatic_tax_param", "type": "object" }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] - }, - "style": "deepObject" - }, - { - "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": "List of invoice items to add or update in the upcoming invoice preview.", - "explode": true, - "in": "query", - "name": "invoice_items", - "required": false, - "schema": { - "items": { - "properties": { - "amount": { - "type": "integer" + "coupon": { + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "maxLength": 5000, + "type": "string" }, "currency": { + "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.", "type": "string" }, - "description": { + "customer": { + "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", "maxLength": 5000, "type": "string" }, - "discountable": { - "type": "boolean" + "customer_details": { + "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", + "properties": { + "address": { + "anyOf": [ + { + "properties": { + "city": { + "maxLength": 5000, + "type": "string" + }, + "country": { + "maxLength": 5000, + "type": "string" + }, + "line1": { + "maxLength": 5000, + "type": "string" + }, + "line2": { + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "maxLength": 5000, + "type": "string" + }, + "state": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "optional_fields_address", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "shipping": { + "anyOf": [ + { + "properties": { + "address": { + "properties": { + "city": { + "maxLength": 5000, + "type": "string" + }, + "country": { + "maxLength": 5000, + "type": "string" + }, + "line1": { + "maxLength": 5000, + "type": "string" + }, + "line2": { + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "maxLength": 5000, + "type": "string" + }, + "state": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "optional_fields_address", + "type": "object" + }, + "name": { + "maxLength": 5000, + "type": "string" + }, + "phone": { + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "address", + "name" + ], + "title": "customer_shipping", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "tax": { + "properties": { + "ip_address": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "tax_param", + "type": "object" + }, + "tax_exempt": { + "enum": [ + "", + "exempt", + "none", + "reverse" + ], + "type": "string" + }, + "tax_ids": { + "items": { + "properties": { + "type": { + "enum": [ + "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", + "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", + "za_vat" + ], + "maxLength": 5000, + "type": "string", + "x-stripeBypassValidation": true + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "value" + ], + "title": "data_params", + "type": "object" + }, + "type": "array" + } + }, + "title": "customer_details_param", + "type": "object" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts." + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_items": { + "description": "List of invoice items to add or update in the upcoming invoice preview.", + "items": { + "properties": { + "amount": { + "type": "integer" + }, + "currency": { + "type": "string" + }, + "description": { + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "invoiceitem": { + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "period": { + "properties": { + "end": { + "format": "unix-time", + "type": "integer" + }, + "start": { + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "tax_code": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "invoice_item_preview_params", + "type": "object" + }, + "type": "array" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, + "on_behalf_of": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details." + }, + "schedule": { + "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", + "maxLength": 5000, + "type": "string" + }, + "schedule_details": { + "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", + "properties": { + "end_behavior": { + "enum": [ + "cancel", + "release" + ], + "type": "string" + }, + "phases": { + "items": { + "properties": { + "add_invoice_items": { + "items": { + "properties": { + "discounts": { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data_with_negative_amounts", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "add_invoice_item_entry", + "type": "object" + }, + "type": "array" + }, + "application_fee_percent": { + "type": "number" + }, + "automatic_tax": { + "properties": { + "enabled": { + "type": "boolean" + }, + "liability": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_config", + "type": "object" + }, + "billing_cycle_anchor": { + "enum": [ + "automatic", + "phase_start" + ], + "type": "string" + }, + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "amount_gte": { + "type": "integer" + }, + "reset_billing_cycle_anchor": { + "type": "boolean" + } + }, + "title": "billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "collection_method": { + "enum": [ + "charge_automatically", + "send_invoice" + ], + "type": "string" + }, + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "default_payment_method": { + "maxLength": 5000, + "type": "string" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "description": { + "anyOf": [ + { + "maxLength": 500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "end_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] + }, + "invoice_settings": { + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "days_until_due": { + "type": "integer" + }, + "issuer": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings", + "type": "object" + }, + "items": { + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "properties": { + "interval": { + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "configuration_item_params", + "type": "object" + }, + "type": "array" + }, + "iterations": { + "type": "integer" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "on_behalf_of": { + "type": "string" + }, + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "start_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] + }, + "transfer_data": { + "properties": { + "amount_percent": { + "type": "number" + }, + "destination": { + "type": "string" + } + }, + "required": [ + "destination" + ], + "title": "transfer_data_specs", + "type": "object" + }, + "trial": { + "type": "boolean" + }, + "trial_end": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] + } + }, + "required": [ + "items" + ], + "title": "phase_configuration_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + } + }, + "title": "schedule_details_params", + "type": "object" + }, + "subscription": { + "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.", + "maxLength": 5000, + "type": "string" + }, + "subscription_details": { + "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", + "properties": { + "billing_cycle_anchor": { + "anyOf": [ + { + "enum": [ + "now", + "unchanged" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ] + }, + "cancel_at": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "cancel_at_period_end": { + "type": "boolean" + }, + "cancel_now": { + "type": "boolean" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "items": { + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "clear_usage": { + "type": "boolean" + }, + "deleted": { + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "id": { + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "properties": { + "interval": { + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "subscription_item_update_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "format": "unix-time", + "type": "integer" + }, + "resume_at": { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + "start_date": { + "format": "unix-time", + "type": "integer" + }, + "trial_end": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ] + } + }, + "title": "subscription_details_params", + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "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/search": { + "get": { + "description": "

Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

", + "operationId": "GetInvoicesSearch", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", + "in": "query", + "name": "page", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).", + "in": "query", + "name": "query", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/invoice" + }, + "type": "array" + }, + "has_more": { + "type": "boolean" + }, + "next_page": { + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "search_result" + ], + "type": "string" + }, + "total_count": { + "description": "The total number of objects that match the query, only accurate up to 10,000.", + "type": "integer" + }, + "url": { + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "SearchResult", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoices/upcoming": { + "get": { + "description": "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

\n\n

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

\n\n

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date value passed in the request.

", + "operationId": "GetInvoicesUpcoming", + "parameters": [ + { + "description": "Settings for automatic tax lookup for this invoice preview.", + "explode": true, + "in": "query", + "name": "automatic_tax", + "required": false, + "schema": { + "properties": { + "enabled": { + "type": "boolean" + }, + "liability": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_param", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "in": "query", + "name": "coupon", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.", + "in": "query", + "name": "currency", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", + "in": "query", + "name": "customer", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", + "explode": true, + "in": "query", + "name": "customer_details", + "required": false, + "schema": { + "properties": { + "address": { + "anyOf": [ + { + "properties": { + "city": { + "maxLength": 5000, + "type": "string" + }, + "country": { + "maxLength": 5000, + "type": "string" + }, + "line1": { + "maxLength": 5000, + "type": "string" + }, + "line2": { + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "maxLength": 5000, + "type": "string" + }, + "state": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "optional_fields_address", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "shipping": { + "anyOf": [ + { + "properties": { + "address": { + "properties": { + "city": { + "maxLength": 5000, + "type": "string" + }, + "country": { + "maxLength": 5000, + "type": "string" + }, + "line1": { + "maxLength": 5000, + "type": "string" + }, + "line2": { + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "maxLength": 5000, + "type": "string" + }, + "state": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "optional_fields_address", + "type": "object" + }, + "name": { + "maxLength": 5000, + "type": "string" + }, + "phone": { + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "address", + "name" + ], + "title": "customer_shipping", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "tax": { + "properties": { + "ip_address": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "tax_param", + "type": "object" + }, + "tax_exempt": { + "enum": [ + "", + "exempt", + "none", + "reverse" + ], + "type": "string" + }, + "tax_ids": { + "items": { + "properties": { + "type": { + "enum": [ + "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", + "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", + "za_vat" + ], + "maxLength": 5000, + "type": "string", + "x-stripeBypassValidation": true + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "value" + ], + "title": "data_params", + "type": "object" + }, + "type": "array" + } + }, + "title": "customer_details_param", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", + "explode": true, + "in": "query", + "name": "discounts", + "required": false, + "schema": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "style": "deepObject" + }, + { + "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": "List of invoice items to add or update in the upcoming invoice preview.", + "explode": true, + "in": "query", + "name": "invoice_items", + "required": false, + "schema": { + "items": { + "properties": { + "amount": { + "type": "integer" + }, + "currency": { + "type": "string" + }, + "description": { + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "type": "boolean" }, "discounts": { "anyOf": [ @@ -85408,183 +87010,724 @@ }, "type": "object" }, - { - "enum": [ - "" - ], + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "period": { + "properties": { + "end": { + "format": "unix-time", + "type": "integer" + }, + "start": { + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "tax_code": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "invoice_item_preview_params", + "type": "object" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "explode": true, + "in": "query", + "name": "issuer", + "required": false, + "schema": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", + "explode": true, + "in": "query", + "name": "on_behalf_of", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "style": "deepObject" + }, + { + "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", + "in": "query", + "name": "schedule", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", + "explode": true, + "in": "query", + "name": "schedule_details", + "required": false, + "schema": { + "properties": { + "end_behavior": { + "enum": [ + "cancel", + "release" + ], + "type": "string" + }, + "phases": { + "items": { + "properties": { + "add_invoice_items": { + "items": { + "properties": { + "discounts": { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data_with_negative_amounts", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "add_invoice_item_entry", + "type": "object" + }, + "type": "array" + }, + "application_fee_percent": { + "type": "number" + }, + "automatic_tax": { + "properties": { + "enabled": { + "type": "boolean" + }, + "liability": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_config", + "type": "object" + }, + "billing_cycle_anchor": { + "enum": [ + "automatic", + "phase_start" + ], + "type": "string" + }, + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "amount_gte": { + "type": "integer" + }, + "reset_billing_cycle_anchor": { + "type": "boolean" + } + }, + "title": "billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "collection_method": { + "enum": [ + "charge_automatically", + "send_invoice" + ], + "type": "string" + }, + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "default_payment_method": { + "maxLength": 5000, + "type": "string" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "description": { + "anyOf": [ + { + "maxLength": 500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "end_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] + }, + "invoice_settings": { + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "days_until_due": { + "type": "integer" + }, + "issuer": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings", + "type": "object" + }, + "items": { + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "properties": { + "interval": { + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "configuration_item_params", + "type": "object" + }, + "type": "array" + }, + "iterations": { + "type": "integer" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "on_behalf_of": { "type": "string" - } - ] - }, - "period": { - "properties": { - "end": { - "format": "unix-time", - "type": "integer" }, - "start": { - "format": "unix-time", - "type": "integer" - } - }, - "required": [ - "end", - "start" - ], - "title": "period", - "type": "object" - }, - "price": { - "maxLength": 5000, - "type": "string" - }, - "price_data": { - "properties": { - "currency": { + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], "type": "string" }, - "product": { - "maxLength": 5000, - "type": "string" + "start_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] }, - "tax_behavior": { - "enum": [ - "exclusive", - "inclusive", - "unspecified" + "transfer_data": { + "properties": { + "amount_percent": { + "type": "number" + }, + "destination": { + "type": "string" + } + }, + "required": [ + "destination" ], - "type": "string" + "title": "transfer_data_specs", + "type": "object" }, - "unit_amount": { - "type": "integer" + "trial": { + "type": "boolean" }, - "unit_amount_decimal": { - "format": "decimal", - "type": "string" + "trial_end": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] } }, "required": [ - "currency", - "product" + "items" ], - "title": "one_time_price_data", + "title": "phase_configuration_params", "type": "object" }, - "quantity": { - "type": "integer" - }, - "tax_behavior": { - "enum": [ - "exclusive", - "inclusive", - "unspecified" - ], - "type": "string" - }, - "tax_code": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] - }, - "tax_rates": { - "anyOf": [ - { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] - }, - "unit_amount": { - "type": "integer" - }, - "unit_amount_decimal": { - "format": "decimal", - "type": "string" - } - }, - "title": "invoice_item_preview_params", - "type": "object" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", - "explode": true, - "in": "query", - "name": "issuer", - "required": false, - "schema": { - "properties": { - "account": { - "type": "string" + "type": "array" }, - "type": { + "proration_behavior": { "enum": [ - "account", - "self" + "always_invoice", + "create_prorations", + "none" ], "type": "string" } }, - "required": [ - "type" - ], - "title": "param", + "title": "schedule_details_params", "type": "object" }, "style": "deepObject" }, - { - "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", - "explode": true, - "in": "query", - "name": "on_behalf_of", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] - }, - "style": "deepObject" - }, - { - "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", - "in": "query", - "name": "schedule", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, { "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.", "in": "query", @@ -85597,7 +87740,7 @@ "style": "form" }, { - "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.", + "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.", "explode": true, "in": "query", "name": "subscription_billing_cycle_anchor", @@ -85621,7 +87764,7 @@ "style": "deepObject" }, { - "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", + "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.", "explode": true, "in": "query", "name": "subscription_cancel_at", @@ -85643,7 +87786,7 @@ "style": "deepObject" }, { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", "in": "query", "name": "subscription_cancel_at_period_end", "required": false, @@ -85653,7 +87796,7 @@ "style": "form" }, { - "description": "This simulates the subscription being canceled or expired immediately.", + "description": "This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.", "in": "query", "name": "subscription_cancel_now", "required": false, @@ -85663,7 +87806,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.", + "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.", "explode": true, "in": "query", "name": "subscription_default_tax_rates", @@ -85688,7 +87831,278 @@ "style": "deepObject" }, { - "description": "A list of up to 20 subscription items, each with an attached price.", + "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", + "explode": true, + "in": "query", + "name": "subscription_details", + "required": false, + "schema": { + "properties": { + "billing_cycle_anchor": { + "anyOf": [ + { + "enum": [ + "now", + "unchanged" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ] + }, + "cancel_at": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "cancel_at_period_end": { + "type": "boolean" + }, + "cancel_now": { + "type": "boolean" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "items": { + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "clear_usage": { + "type": "boolean" + }, + "deleted": { + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "id": { + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "properties": { + "interval": { + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "subscription_item_update_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "format": "unix-time", + "type": "integer" + }, + "resume_at": { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + "start_date": { + "format": "unix-time", + "type": "integer" + }, + "trial_end": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ] + } + }, + "title": "subscription_details_params", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.", "explode": true, "in": "query", "name": "subscription_items", @@ -85862,7 +88276,7 @@ "style": "deepObject" }, { - "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.", "in": "query", "name": "subscription_proration_behavior", "required": false, @@ -85877,7 +88291,7 @@ "style": "form" }, { - "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'.", + "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.", "in": "query", "name": "subscription_proration_date", "required": false, @@ -85888,7 +88302,7 @@ "style": "form" }, { - "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.", + "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.", "in": "query", "name": "subscription_resume_at", "required": false, @@ -85902,7 +88316,7 @@ "style": "form" }, { - "description": "Date a subscription is intended to start (can be future or past).", + "description": "Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.", "in": "query", "name": "subscription_start_date", "required": false, @@ -85913,7 +88327,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required.", + "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.", "explode": true, "in": "query", "name": "subscription_trial_end", @@ -85934,16 +88348,6 @@ ] }, "style": "deepObject" - }, - { - "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", - "in": "query", - "name": "subscription_trial_from_plan", - "required": false, - "schema": { - "type": "boolean" - }, - "style": "form" } ], "requestBody": { @@ -86610,6 +89014,547 @@ }, "style": "form" }, + { + "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", + "explode": true, + "in": "query", + "name": "schedule_details", + "required": false, + "schema": { + "properties": { + "end_behavior": { + "enum": [ + "cancel", + "release" + ], + "type": "string" + }, + "phases": { + "items": { + "properties": { + "add_invoice_items": { + "items": { + "properties": { + "discounts": { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data_with_negative_amounts", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "add_invoice_item_entry", + "type": "object" + }, + "type": "array" + }, + "application_fee_percent": { + "type": "number" + }, + "automatic_tax": { + "properties": { + "enabled": { + "type": "boolean" + }, + "liability": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_config", + "type": "object" + }, + "billing_cycle_anchor": { + "enum": [ + "automatic", + "phase_start" + ], + "type": "string" + }, + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "amount_gte": { + "type": "integer" + }, + "reset_billing_cycle_anchor": { + "type": "boolean" + } + }, + "title": "billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "collection_method": { + "enum": [ + "charge_automatically", + "send_invoice" + ], + "type": "string" + }, + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "default_payment_method": { + "maxLength": 5000, + "type": "string" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "description": { + "anyOf": [ + { + "maxLength": 500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "end_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] + }, + "invoice_settings": { + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "days_until_due": { + "type": "integer" + }, + "issuer": { + "properties": { + "account": { + "type": "string" + }, + "type": { + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings", + "type": "object" + }, + "items": { + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "properties": { + "interval": { + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "configuration_item_params", + "type": "object" + }, + "type": "array" + }, + "iterations": { + "type": "integer" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "on_behalf_of": { + "type": "string" + }, + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "start_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] + }, + "transfer_data": { + "properties": { + "amount_percent": { + "type": "number" + }, + "destination": { + "type": "string" + } + }, + "required": [ + "destination" + ], + "title": "transfer_data_specs", + "type": "object" + }, + "trial": { + "type": "boolean" + }, + "trial_end": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ] + } + }, + "required": [ + "items" + ], + "title": "phase_configuration_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + } + }, + "title": "schedule_details_params", + "type": "object" + }, + "style": "deepObject" + }, { "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", "in": "query", @@ -86633,7 +89578,7 @@ "style": "form" }, { - "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.", + "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.", "explode": true, "in": "query", "name": "subscription_billing_cycle_anchor", @@ -86657,7 +89602,7 @@ "style": "deepObject" }, { - "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", + "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.", "explode": true, "in": "query", "name": "subscription_cancel_at", @@ -86679,7 +89624,7 @@ "style": "deepObject" }, { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", "in": "query", "name": "subscription_cancel_at_period_end", "required": false, @@ -86689,7 +89634,7 @@ "style": "form" }, { - "description": "This simulates the subscription being canceled or expired immediately.", + "description": "This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.", "in": "query", "name": "subscription_cancel_now", "required": false, @@ -86699,7 +89644,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.", + "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.", "explode": true, "in": "query", "name": "subscription_default_tax_rates", @@ -86724,7 +89669,278 @@ "style": "deepObject" }, { - "description": "A list of up to 20 subscription items, each with an attached price.", + "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", + "explode": true, + "in": "query", + "name": "subscription_details", + "required": false, + "schema": { + "properties": { + "billing_cycle_anchor": { + "anyOf": [ + { + "enum": [ + "now", + "unchanged" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ] + }, + "cancel_at": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "cancel_at_period_end": { + "type": "boolean" + }, + "cancel_now": { + "type": "boolean" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "items": { + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "clear_usage": { + "type": "boolean" + }, + "deleted": { + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "maxLength": 5000, + "type": "string" + }, + "discount": { + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "id": { + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "price": { + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "properties": { + "currency": { + "type": "string" + }, + "product": { + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "properties": { + "interval": { + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "type": "integer" + }, + "unit_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "subscription_item_update_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "format": "unix-time", + "type": "integer" + }, + "resume_at": { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + "start_date": { + "format": "unix-time", + "type": "integer" + }, + "trial_end": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ] + } + }, + "title": "subscription_details_params", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.", "explode": true, "in": "query", "name": "subscription_items", @@ -86898,7 +90114,7 @@ "style": "deepObject" }, { - "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.", "in": "query", "name": "subscription_proration_behavior", "required": false, @@ -86913,7 +90129,7 @@ "style": "form" }, { - "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'.", + "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.", "in": "query", "name": "subscription_proration_date", "required": false, @@ -86924,7 +90140,7 @@ "style": "form" }, { - "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.", + "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.", "in": "query", "name": "subscription_resume_at", "required": false, @@ -86938,7 +90154,7 @@ "style": "form" }, { - "description": "Date a subscription is intended to start (can be future or past).", + "description": "Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.", "in": "query", "name": "subscription_start_date", "required": false, @@ -86949,7 +90165,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required.", + "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.", "explode": true, "in": "query", "name": "subscription_trial_end", @@ -86970,16 +90186,6 @@ ] }, "style": "deepObject" - }, - { - "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.", - "in": "query", - "name": "subscription_trial_from_plan", - "required": false, - "schema": { - "type": "boolean" - }, - "style": "form" } ], "requestBody": { @@ -99815,6 +103021,14 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -102521,6 +105735,14 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -105371,6 +108593,14 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -113549,6 +116779,15 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -114329,6 +117568,15 @@ "schema": { "additionalProperties": false, "properties": { + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { @@ -124481,6 +127729,14 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -125684,6 +128940,14 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -126911,6 +130175,14 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -142929,6 +146201,14 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -144324,6 +147604,7 @@ "unit": { "enum": [ "liter", + "other", "us_gallon" ], "maxLength": 5000, @@ -145602,6 +148883,7 @@ "unit": { "enum": [ "liter", + "other", "us_gallon" ], "maxLength": 5000, @@ -146154,6 +149436,7 @@ "unit": { "enum": [ "liter", + "other", "us_gallon" ], "maxLength": 5000,