Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" + @doc "Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.
\n\nBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a
Switching prices does not normally change the billing date or generate an immediate charge unless:
\n\nIn these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.
\n\nIf you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.
If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.
\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/subscriptions/{subscription_exposed_id}`\n" ( @spec update( subscription_exposed_id :: binary(), diff --git a/lib/generated/terminal__configuration.ex b/lib/generated/terminal__configuration.ex index 6c7e3c85..21e2719b 100644 --- a/lib/generated/terminal__configuration.ex +++ b/lib/generated/terminal__configuration.ex @@ -9,17 +9,19 @@ defmodule Stripe.Terminal.Configuration do :is_account_default, :livemode, :object, + :offline, :tipping, :verifone_p400 ] - @typedoc "The `terminal.configuration` type.\n\n * `bbpos_wisepos_e` \n * `id` Unique identifier for the object.\n * `is_account_default` Whether this Configuration is the default for your account\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `tipping` \n * `verifone_p400` \n" + @typedoc "The `terminal.configuration` type.\n\n * `bbpos_wisepos_e` \n * `id` Unique identifier for the object.\n * `is_account_default` Whether this Configuration is the default for your account\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `offline` \n * `tipping` \n * `verifone_p400` \n" @type t :: %__MODULE__{ bbpos_wisepos_e: term, id: binary, is_account_default: boolean | nil, livemode: boolean, object: binary, + offline: term, tipping: term, verifone_p400: term } @@ -129,6 +131,11 @@ defmodule Stripe.Terminal.Configuration do } ) + ( + @typedoc nil + @type offline :: %{optional(:enabled) => boolean} + ) + ( @typedoc "Tipping configuration for SEK" @type sek :: %{ @@ -190,6 +197,7 @@ defmodule Stripe.Terminal.Configuration do params :: %{ optional(:bbpos_wisepos_e) => bbpos_wisepos_e, optional(:expand) => list(binary), + optional(:offline) => offline | binary, optional(:tipping) => tipping | binary, optional(:verifone_p400) => verifone_p400 }, @@ -294,6 +302,7 @@ defmodule Stripe.Terminal.Configuration do params :: %{ optional(:bbpos_wisepos_e) => bbpos_wisepos_e | binary, optional(:expand) => list(binary), + optional(:offline) => offline | binary, optional(:tipping) => tipping | binary, optional(:verifone_p400) => verifone_p400 | binary }, diff --git a/priv/openapi/spec3.sdk.json b/priv/openapi/spec3.sdk.json index 7589c26c..ec06ffac 100644 --- a/priv/openapi/spec3.sdk.json +++ b/priv/openapi/spec3.sdk.json @@ -28442,13 +28442,7 @@ "description": "", "properties": { "dropdown": { - "anyOf": [ - { - "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown" - } - ], - "description": "Configuration for `type=dropdown` fields.", - "nullable": true + "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown" }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", @@ -28459,26 +28453,14 @@ "$ref": "#/components/schemas/payment_links_resource_custom_fields_label" }, "numeric": { - "anyOf": [ - { - "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric" - } - ], - "description": "Configuration for `type=numeric` fields.", - "nullable": true + "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric" }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { - "anyOf": [ - { - "$ref": "#/components/schemas/payment_links_resource_custom_fields_text" - } - ], - "description": "Configuration for `type=text` fields.", - "nullable": true + "$ref": "#/components/schemas/payment_links_resource_custom_fields_text" }, "type": { "description": "The type of the field.", @@ -28491,12 +28473,9 @@ } }, "required": [ - "dropdown", "key", "label", - "numeric", "optional", - "text", "type" ], "title": "PaymentLinksResourceCustomFields", @@ -35271,13 +35250,7 @@ "description": "", "properties": { "dropdown": { - "anyOf": [ - { - "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown" - } - ], - "description": "Configuration for `type=dropdown` fields.", - "nullable": true + "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown" }, "key": { "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.", @@ -35288,26 +35261,14 @@ "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_label" }, "numeric": { - "anyOf": [ - { - "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric" - } - ], - "description": "Configuration for `type=numeric` fields.", - "nullable": true + "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric" }, "optional": { "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.", "type": "boolean" }, "text": { - "anyOf": [ - { - "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text" - } - ], - "description": "Configuration for `type=text` fields.", - "nullable": true + "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text" }, "type": { "description": "The type of the field.", @@ -35320,12 +35281,9 @@ } }, "required": [ - "dropdown", "key", "label", - "numeric", "optional", - "text", "type" ], "title": "PaymentPagesCheckoutSessionCustomFields", @@ -50218,6 +50176,9 @@ ], "type": "string" }, + "offline": { + "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config" + }, "tipping": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_tipping" }, @@ -50235,6 +50196,7 @@ "type": "object", "x-expandableFields": [ "bbpos_wisepos_e", + "offline", "tipping", "verifone_p400" ], @@ -50723,6 +50685,26 @@ "in_package": "" } }, + "terminal_configuration_configuration_resource_offline_config": { + "description": "", + "properties": { + "enabled": { + "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.", + "nullable": true, + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "title": "TerminalConfigurationConfigurationResourceOfflineConfig", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "OfflineConfig", + "in_package": "" + } + }, "terminal_configuration_configuration_resource_tipping": { "description": "", "properties": { @@ -127625,7 +127607,7 @@ } }, "post": { - "description": "Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
", + "description": "Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.
\n\nBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a
Switching prices does not normally change the billing date or generate an immediate charge unless:
\n\nIn these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.
\n\nIf you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.
If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.
", "operationId": "PostSubscriptionsSubscriptionExposedId", "parameters": [ { @@ -130841,6 +130823,10 @@ "explode": true, "style": "deepObject" }, + "offline": { + "explode": true, + "style": "deepObject" + }, "tipping": { "explode": true, "style": "deepObject" @@ -130882,6 +130868,30 @@ }, "type": "array" }, + "offline": { + "anyOf": [ + { + "properties": { + "enabled": { + "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "title": "offline", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Configurations for collecting transactions offline." + }, "tipping": { "anyOf": [ { @@ -131453,6 +131463,10 @@ "explode": true, "style": "deepObject" }, + "offline": { + "explode": true, + "style": "deepObject" + }, "tipping": { "explode": true, "style": "deepObject" @@ -131504,6 +131518,30 @@ }, "type": "array" }, + "offline": { + "anyOf": [ + { + "properties": { + "enabled": { + "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "title": "offline", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Configurations for collecting transactions offline." + }, "tipping": { "anyOf": [ {