Stripe.SubscriptionItem.Usage (stripity_stripe v2.17.3) View Source

Work with Stripe usage record objects.

Stripe API reference: https://stripe.com/docs/api/usage_records

Link to this section Summary

Types

t()

Functions

create(id, params, opts \\ [])

Creates a usage record for a specified subscription item id and date, and fills it with a quantity.

list(id, params \\ %{}, opts \\ [])

List all subscription item period summaries

Link to this section Types

t()

Specs

t() :: %Stripe.SubscriptionItem.Usage{
  id: Stripe.id(),
  livemode: boolean(),
  object: String.t(),
  quantity: non_neg_integer(),
  subscription_item: Stripe.id() | Stripe.SubscriptionItem.t(),
  timestamp: Stripe.timestamp()
}

Link to this section Functions

create(id, params, opts \\ [])

Specs

create(Stripe.id(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       :quantity => float() | pos_integer() | 0,
       :timestamp => Stripe.timestamp() | non_neg_integer(),
       optional(:action) => String.t()
     }

Creates a usage record for a specified subscription item id and date, and fills it with a quantity.

list(id, params \\ %{}, opts \\ [])

Specs

list(Stripe.id(), params, Stripe.options()) ::
  {:ok, Stripe.List.t(Stripe.SubscriptionItem.UsageRecordSummary.t())}
  | {:error, Stripe.Error.t()}
when params: %{
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all subscription item period summaries