View Source ExChargebee.Quote (ex_chargebee v0.4.5)

An interface for Interacting with quotes

For More information see Chargebee quote Documentation

Summary

Functions

Perform a convert on individual quote.

Perform a quote create_for_charge_items_and_charges.

Perform a delete on individual quote.

Perform a edit_create_subscription_quote_for_items on individual quote.

Perform a edit_for_charge_items_and_charges on individual quote.

Perform a edit_update_subscription_quote_for_items on individual quote.

Perform a extend_expiry_date on individual quote.

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

Returns a list of quotes quote_line_groups.

Perform a pdf on individual download.

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

Perform a update_status on individual quote.

Perform a quote update_subscription_quote_for_items.

Functions

Link to this function

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

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

Perform a convert on individual quote.

Find more information in the Chargebee Documentation

Link to this function

create_for_charge_items_and_charges(params, opts \\ [])

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

Perform a quote create_for_charge_items_and_charges.

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 quote.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a edit_create_subscription_quote_for_items on individual quote.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a edit_for_charge_items_and_charges on individual quote.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a edit_update_subscription_quote_for_items on individual quote.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a extend_expiry_date on individual quote.

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 quotes. 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

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

View Source
@spec list_quote_line_groups(String.t(), map(), keyword()) :: [map()] | nil

Returns a list of quotes quote_line_groups.

Pagination is handled automatically. For more information see the Chargebee Documentation

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

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

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

Perform a pdf on individual download.

Find more information in the Chargebee Documentation

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

Link to this function

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

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

Perform a update_status on individual quote.

Find more information in the Chargebee Documentation

Link to this function

update_subscription_quote_for_items(params, opts \\ [])

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

Perform a quote update_subscription_quote_for_items.

Find more information in the Chargebee Documentation