View Source ExChargebee.Plan (ex_chargebee v0.4.5)

An interface for Interacting with plans

For More information see Chargebee plan Documentation

Summary

Functions

create(params, opts \\ [])

Creates a plan.

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

Perform a delete on individual plan.

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

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

operations()
operations(group)
retrieve(resource_id, opts \\ [])
stream_list(params \\ %{}, opts \\ [])

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

update(resource_id, params, opts \\ [])

Updates a plan.

Functions

Link to this function

create(params, opts \\ [])

View Source 
@spec create(
  map(),
  keyword()
) :: map() | nil

Creates a plan.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a delete on individual plan.

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 plans. 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.
Link to this function

operations()

View Source 
@spec operations() :: Keyword.t()
Link to this function

operations(group)

View Source
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 plans. Pagination is handled automatically as the stream is consumed.

Link to this function

update(resource_id, params, opts \\ [])

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

Updates a plan.

Find more information in the Chargebee Documentation