Search documentation of stripe_elixir

# StripeElixir.Params.InvoiceCreatePreviewParams.ScheduleDetails (stripe_elixir v0.1.0)

Copy Markdown View Source

Nested parameters.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.InvoiceCreatePreviewParams.ScheduleDetails{
      billing_mode: map() | nil,
      end_behavior: String.t() | nil,
      phases: [map()] | nil,
      proration_behavior: String.t() | nil
    }

- `billing_mode` - Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- `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`, `release`.
- `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.
- `proration_behavior` - In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request. Possible values: `always_invoice`, `create_prorations`, `none`.