Stripe.Params.SubscriptionResumeParams (tiger_stripe v0.1.10)

Copy Markdown View Source

Parameters for subscription resume.

Summary

Types

t()

Types

t()

@type t() :: %Stripe.Params.SubscriptionResumeParams{
  billing_cycle_anchor: String.t() | nil,
  expand: [String.t()] | nil,
  proration_behavior: String.t() | nil,
  proration_date: integer() | nil
}
  • billing_cycle_anchor - The billing cycle anchor that applies when the subscription is resumed. Either now or unchanged. The default is now. For more information, see the billing cycle documentation. Possible values: now, unchanged.
  • expand - Specifies which fields in the response should be expanded.
  • proration_behavior - Determines how to handle prorations resulting from the billing_cycle_anchor being unchanged. When the billing_cycle_anchor is set to now (default value), no prorations are generated. If no value is passed, the default is create_prorations. Possible values: always_invoice, create_prorations, none.
  • proration_date - If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the create preview endpoint. Format: Unix timestamp.