View Source ExChargebee.Usage (ex_chargebee v0.4.5)

an interface for interacting with Purchases

Summary

Functions

Returns a list of usages. Pagination is handled automatically unless the opt paginate is set to false.

Perform a usage pdf.

Returns a stream of usages. Pagination is handled automatically as the stream is consumed.

Functions

Link to this function

create_usage(subscription_id, params, opts \\ [])

View Source

See ExChargebee.Subscription.create_usage/3.

Link to this function

delete_usage(subscription_id, params, opts \\ [])

View Source

See ExChargebee.Subscription.delete_usage/3.

Link to this function

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

View Source
@spec list(
  map(),
  keyword()
) :: [map()] | nil

Returns a list of usages. Pagination is handled automatically unless the opt paginate is set to false.

opts:

  • site: the site to use for the request. Defaults to the default site.
  • paginate: whether to paginate the results. Defaults to false. If false, all results will be returned.
@spec operations() :: Keyword.t()
@spec pdf(
  map(),
  keyword()
) :: map() | nil

Perform a usage pdf.

Find more information in the Chargebee Documentation

Link to this function

stream_list(params \\ %{}, opts \\ [])

View Source
@spec stream_list(
  map(),
  keyword()
) :: Enumerable.t()

Returns a stream of usages. Pagination is handled automatically as the stream is consumed.