exoapi_stripe v0.1.4

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

description: Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment.

:billing_cycle_anchor :: :integer

If the update is applied, determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.

:expires_at :: :integer

The point after which the changes reflected by this update will be discarded and no longer applied.

::subscription_items :: ExOAPI.Stripe.Schemas.SubscriptionItem

:trial_end :: :integer

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.

:trial_from_plan :: :boolean

Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.

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.SubscriptionsResourcePendingUpdate{
  billing_cycle_anchor: integer() | nil,
  expires_at: integer() | nil,
  subscription_items: [ExOAPI.Stripe.Schemas.SubscriptionItem.t()],
  trial_end: integer() | nil,
  trial_from_plan: boolean() | nil
}

Link to this section Functions

Link to this function

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

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