exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.PortalSubscriptionCancel (exoapi_stripe v0.1.4)

:cancellation_reason :: ExOAPI.Stripe.Schemas.PortalSubscriptionCancellationReason

:enabled :: :boolean

Whether the feature is enabled.

:mode :: :string

Whether to cancel subscriptions immediately or at the end of the billing period.

:proration_behavior :: :string

Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.PortalSubscriptionCancel{
  cancellation_reason:
    ExOAPI.Stripe.Schemas.PortalSubscriptionCancellationReason.t() | nil,
  enabled: boolean() | nil,
  mode: (:immediately | :at_period_end) | nil,
  proration_behavior: (:none | :create_prorations | :always_invoice) | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()