# `Stripe.Params.SubscriptionScheduleUpdateParams`
[🔗](https://github.com/jeffhuen/tiger_stripe/blob/main/lib/stripe/params/subscription_schedule_update_params.ex#L2)

Parameters for subscription schedule update.

# `t`

```elixir
@type t() :: %Stripe.Params.SubscriptionScheduleUpdateParams{
  default_settings:
    Stripe.Params.SubscriptionScheduleUpdateParams.DefaultSettings.t() | nil,
  end_behavior: String.t() | nil,
  expand: [String.t()] | nil,
  metadata: map() | nil,
  phases: [Stripe.Params.SubscriptionScheduleUpdateParams.Phases.t()] | nil,
  proration_behavior: String.t() | nil
}
```

* `default_settings` - Object representing the subscription schedule's default settings.
* `end_behavior` - Behavior of the subscription schedule and underlying subscription 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. Possible values: `cancel`, `none`, `release`, `renew`.
* `expand` - Specifies which fields in the response should be expanded.
* `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
* `phases` - List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.
* `proration_behavior` - If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`. Possible values: `always_invoice`, `create_prorations`, `none`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*