exoapi_stripe v0.1.4

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

description: A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.

Related guide: Subscription Schedules.

:canceled_at :: :integer

Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

:completed_at :: :integer

Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:current_phase :: ExOAPI.Stripe.Schemas.SubscriptionScheduleCurrentPhase

Object representing the start and end dates for the current phase of the subscription schedule, if it is active.

:customer :: ExOAPI.Stripe.Schemas.DeletedCustomer | ExOAPI.Stripe.Schemas.Customer | :string

ID of the customer who owns the subscription schedule.

:default_settings :: ExOAPI.Stripe.Schemas.SubscriptionSchedulesResourceDefaultSettings

:end_behavior :: :string

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release and cancel.

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

::phases :: ExOAPI.Stripe.Schemas.SubscriptionSchedulePhaseConfiguration

:released_at :: :integer

Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

:released_subscription :: :string

ID of the subscription once managed by the subscription schedule (if it is released).

:status :: :string

The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

:subscription :: ExOAPI.Stripe.Schemas.Subscription | :string

ID of the subscription managed by the subscription schedule.

:test_clock :: ExOAPI.Stripe.Schemas.TestHelpers_testClock | :string

ID of the test clock this subscription schedule belongs to.

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.SubscriptionSchedule{
  canceled_at: integer() | nil,
  completed_at: integer() | nil,
  created: integer() | nil,
  current_phase: ExOAPI.EctoTypes.AnyOf.t() | nil,
  customer: ExOAPI.EctoTypes.AnyOf.t() | nil,
  default_settings:
    ExOAPI.Stripe.Schemas.SubscriptionSchedulesResourceDefaultSettings.t() | nil,
  end_behavior: (:renew | :release | :none | :cancel) | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :subscription_schedule | nil,
  phases: [ExOAPI.Stripe.Schemas.SubscriptionSchedulePhaseConfiguration.t()],
  released_at: integer() | nil,
  released_subscription: String.t() | nil,
  status: (:released | :not_started | :completed | :canceled | :active) | nil,
  subscription: ExOAPI.EctoTypes.AnyOf.t() | nil,
  test_clock: ExOAPI.EctoTypes.AnyOf.t() | nil
}

Link to this section Functions

Link to this function

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

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