Stripe.Resources.Subscription.PendingUpdate (tiger_stripe v0.1.10)

Copy Markdown View Source

Nested struct within the parent resource.

Summary

Types

t()

Types

t()

@type t() :: %Stripe.Resources.Subscription.PendingUpdate{
  billing_cycle_anchor: integer() | nil,
  expires_at: integer() | nil,
  subscription_items: [Stripe.Resources.SubscriptionItem.t()] | nil,
  trial_end: integer() | nil,
  trial_from_plan: boolean() | nil
}
  • billing_cycle_anchor - 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. The timestamp is in UTC format. Format: Unix timestamp. Nullable.
  • expires_at - The point after which the changes reflected by this update will be discarded and no longer applied. Format: Unix timestamp.
  • subscription_items - List of subscription items, each with an attached plan, that will be set if the update is applied. Nullable.
  • trial_end - 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. Format: Unix timestamp. Nullable.
  • trial_from_plan - 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. Nullable.