exoapi_stripe v0.1.4

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

:aggregate_usage :: :string

Specifies a usage aggregation strategy for prices of usage_type=metered. Allowed values are sum for summing up all usage during a period, last_during_period for using the last usage record reported within a period, last_ever for using the last usage record ever (across period bounds) or max which uses the usage record with the maximum reported usage during a period. Defaults to sum.

:interval :: :string

The frequency at which a subscription is billed. One of day, week, month or year.

:interval_count :: :integer

The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

:usage_type :: :string

Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

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.Recurring{
  aggregate_usage: (:sum | :max | :last_ever | :last_during_period) | nil,
  interval: (:year | :week | :month | :day) | nil,
  interval_count: integer() | nil,
  usage_type: (:metered | :licensed) | nil
}

Link to this section Functions

Link to this function

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

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