View Source ExChargebee.HostedPage (ex_chargebee v0.4.5)

An interface for Interacting with hosted_pages

For More information see Chargebee hosted_page Documentation

Summary

Functions

Perform a hosted_page accept_quote.

Perform a acknowledge on individual hosted_page.

Perform a hosted_page checkout_existing_for_items.

Perform a hosted_page checkout_gift_for_items.

Perform a hosted_page checkout_new_for_items.

Perform a hosted_page checkout_one_time_for_items.

Perform a hosted_page claim_gift.

Perform a hosted_page collect_now.

Creates a hosted_page.

Perform a delete on individual hosted_page.

Perform a hosted_page events.

Perform a hosted_page extend_subscription.

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

Perform a hosted_page manage_payment_sources.

Perform a hosted_page pre_cancel.

Perform a hosted_page retrieve_agreement_pdf.

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

Perform a hosted_page update_payment_method.

Perform a hosted_page view_voucher.

Functions

Link to this function

accept_quote(params, opts \\ [])

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

Perform a hosted_page accept_quote.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a acknowledge on individual hosted_page.

Find more information in the Chargebee Documentation

Link to this function

checkout_existing_for_items(params, opts \\ [])

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

Perform a hosted_page checkout_existing_for_items.

Find more information in the Chargebee Documentation

Link to this function

checkout_gift_for_items(params, opts \\ [])

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

Perform a hosted_page checkout_gift_for_items.

Find more information in the Chargebee Documentation

Link to this function

checkout_new_for_items(params, opts \\ [])

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

Perform a hosted_page checkout_new_for_items.

Find more information in the Chargebee Documentation

Link to this function

checkout_one_time_for_items(params, opts \\ [])

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

Perform a hosted_page checkout_one_time_for_items.

Find more information in the Chargebee Documentation

Link to this function

claim_gift(params, opts \\ [])

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

Perform a hosted_page claim_gift.

Find more information in the Chargebee Documentation

Link to this function

collect_now(params, opts \\ [])

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

Perform a hosted_page collect_now.

Find more information in the Chargebee Documentation

Link to this function

create(params, opts \\ [])

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

Creates a hosted_page.

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

Find more information in the Chargebee Documentation

Link to this function

events(params, opts \\ [])

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

Perform a hosted_page events.

Find more information in the Chargebee Documentation

Link to this function

extend_subscription(params, opts \\ [])

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

Perform a hosted_page extend_subscription.

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

manage_payment_sources(params, opts \\ [])

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

Perform a hosted_page manage_payment_sources.

Find more information in the Chargebee Documentation

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

pre_cancel(params, opts \\ [])

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

Perform a hosted_page pre_cancel.

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

retrieve_agreement_pdf(params, opts \\ [])

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

Perform a hosted_page retrieve_agreement_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 hosted_pages. 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 hosted_page.

Find more information in the Chargebee Documentation

Link to this function

update_payment_method(params, opts \\ [])

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

Perform a hosted_page update_payment_method.

Find more information in the Chargebee Documentation

Link to this function

view_voucher(params, opts \\ [])

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

Perform a hosted_page view_voucher.

Find more information in the Chargebee Documentation