View Source ExChargebee.CouponCode (ex_chargebee v0.4.5)

An interface for Interacting with coupon_codes

For More information see Chargebee coupon_code Documentation

Summary

Functions

Perform a archive on individual coupon_code.

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

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

Functions

Link to this function

archive(resource_id, params \\ %{}, opts \\ [])

View Source
@spec archive(String.t(), map(), keyword()) :: map() | nil

Perform a archive on individual coupon_code.

Find more information in the Chargebee Documentation

Link to this function

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

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

Returns a list of coupon_codes. 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()
Link to this function

retrieve(resource_id, opts \\ [])

View Source
@spec retrieve(
  String.t(),
  keyword()
) :: map() | nil
Link to this function

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

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

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