View Source ExChargebee.Order (ex_chargebee v0.4.5)

An interface for Interacting with orders

For More information see Chargebee order Documentation

Summary

Functions

Perform a assign_order_number on individual order.

Perform a cancel on individual order.

Creates a order.

Perform a create_refundable_credit_note on individual order.

Perform a delete on individual order.

Perform a order import_order.

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

Perform a reopen on individual order.

Perform a resend on individual order.

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

Functions

Link to this function

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

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

Perform a assign_order_number on individual order.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a cancel on individual order.

Find more information in the Chargebee Documentation

Link to this function

create(params, opts \\ [])

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

Creates a order.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a create_refundable_credit_note on individual order.

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

Find more information in the Chargebee Documentation

Link to this function

import_order(params, opts \\ [])

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

Perform a order import_order.

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

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

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

Perform a reopen on individual order.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a resend on individual order.

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 orders. 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 order.

Find more information in the Chargebee Documentation