StripeAPI.Operations.PostSubscriptionSchedulesSchedule

POST /v1/subscription_schedules/{schedule}

<p>Updates an existing subscription schedule.</p>

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBody with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings in the specification.

Object representing the subscription schedule's default settings.

Create a new PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings' with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.automatic_tax in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'AutomaticTax' with all required fields.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.billing_cycle_anchor in the specification.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.billing_thresholds.anyOf in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'BillingThresholds'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.billing_thresholds.anyOf in the specification.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.collection_method in the specification.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.invoice_settings in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'InvoiceSettings' with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.transfer_data.anyOf in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyDefaultSettings'TransferData'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_settings.properties.transfer_data.anyOf in the specification.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.end_behavior in the specification.

Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases' with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'AddInvoiceItems' with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items.properties.price_data in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'AddInvoiceItems'PriceData' with all required fields.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items.properties.price_data.properties.tax_behavior in the specification.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.add_invoice_items.items.properties.tax_rates.anyOf in the specification.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.automatic_tax in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'AutomaticTax' with all required fields.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.billing_cycle_anchor in the specification.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.billing_thresholds.anyOf in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'BillingThresholds'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.billing_thresholds.anyOf in the specification.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.collection_method in the specification.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.default_tax_rates.anyOf in the specification.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.end_date.anyOf in the specification.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.invoice_settings in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'InvoiceSettings' with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'Items' with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.billing_thresholds.anyOf in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'Items'BillingThresholds'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.billing_thresholds.anyOf in the specification.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'Items'PriceData' with all required fields.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data.properties.recurring in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'Items'PriceData'Recurring' with all required fields.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data.properties.recurring.properties.interval in the specification.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.price_data.properties.tax_behavior in the specification.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.items.items.properties.tax_rates.anyOf in the specification.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.proration_behavior in the specification.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.start_date.anyOf in the specification.

Defines the object schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.transfer_data in the specification.

Create a new PostSubscriptionSchedulesScheduleRequestBodyPhases'TransferData' with all required fields.

Defines the oneOf schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phases.items.properties.trial_end.anyOf in the specification.

Defines the enum schema located at paths./v1/subscription_schedules/{schedule}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.proration_behavior in the specification.

If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.

Represents a response of the operation postSubscriptionSchedulesSchedule.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostSubscriptionSchedulesScheduleResponseError is used.