Packages

tiger_stripe

0.4.0
0.4.0 0.3.0 0.2.0 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.

HexDocs

Current section

Files

Jump to
Readme
15 Versions
3 Dependencies
Dependants
Files
Activity
tiger_stripe lib stripe params subscription_resume_params.ex
Raw

lib/stripe/params/subscription_resume_params.ex 

# File generated from our OpenAPI spec

defmodule Stripe.Params.SubscriptionResumeParams do

  @moduledoc "Parameters for subscription resume."



  @typedoc """

  * `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](https://docs.stripe.com/billing/subscriptions/billing-cycle). Possible values: `now`, `unchanged`.

  * `expand` - Specifies which fields in the response should be expanded.

  * `proration_behavior` - Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/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](https://stripe.com/docs/api/invoices/create_preview) endpoint. Format: Unix timestamp.

  """

  @type t :: %__MODULE__{}



  defstruct [:billing_cycle_anchor, :expand, :proration_behavior, :proration_date]

end