View Source ExChargebee.Subscription (ex_chargebee v0.4.5)

An interface for Interacting with subscriptions

For More information see Chargebee subscription Documentation

Summary

Functions

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

Perform a add_charge_at_term_end on individual subscription.

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

Perform a cancel_for_items on individual subscription.

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

Perform a change_term_end on individual subscription.

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

Perform a charge_future_renewals on individual subscription.

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

Perform a contract_terms on individual subscription.

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

Perform a create_usage on individual usage.

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

Perform a delete on individual subscription.

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

Perform a delete_usage on individual usage.

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

Perform a discounts on individual subscription.

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

Perform a edit_advance_invoice_schedule on individual subscription.

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

Perform a import_contract_term on individual subscription.

import_for_items(customer_id, params, opts)

See ExChargebee.Customer.import_for_items/3.

import_unbilled_charges(params, opts \\ [])

chargebee docs

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

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

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

Perform a override_billing_profile on individual subscription.

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

Perform a pause on individual subscription.

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

Perform a reactivate on individual subscription.

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

Perform a regenerate_invoice on individual subscription.

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

Perform a remove_advance_invoice_schedule on individual subscription.

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

Perform a remove_coupons on individual subscription.

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

Perform a remove_scheduled_cancellation on individual subscription.

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

Perform a remove_scheduled_changes on individual subscription.

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

Perform a remove_scheduled_pause on individual subscription.

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

Perform a remove_scheduled_resumption on individual subscription.

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

Perform a resume on individual subscription.

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

Perform a retrieve_advance_invoice_schedule on individual subscription.

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

Perform a retrieve_with_scheduled_changes on individual subscription.

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

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

subscription_for_items(customer_id, params, opts)

See ExChargebee.Customer.subscription_for_items/3.

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

Perform a update_for_items on individual subscription.

Functions

Link to this function

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

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

Perform a add_charge_at_term_end on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a cancel_for_items on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a change_term_end on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a charge_future_renewals on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a contract_terms on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a create_usage on individual usage.

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

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a delete_usage on individual usage.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a discounts on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a edit_advance_invoice_schedule on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a import_contract_term on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

import_for_items(customer_id, params, opts)

View Source

See ExChargebee.Customer.import_for_items/3.

Link to this function

import_unbilled_charges(params, opts \\ [])

View Source

chargebee docs

Link to this function

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

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

Returns a list of subscriptions. 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

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

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

Perform a override_billing_profile on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a pause on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a reactivate on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a regenerate_invoice on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a remove_advance_invoice_schedule on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a remove_coupons on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a remove_scheduled_cancellation on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a remove_scheduled_changes on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a remove_scheduled_pause on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a remove_scheduled_resumption on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a resume on individual subscription.

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_advance_invoice_schedule(resource_id, params \\ %{}, opts \\ [])

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

Perform a retrieve_advance_invoice_schedule on individual subscription.

Find more information in the Chargebee Documentation

Link to this function

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

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

Perform a retrieve_with_scheduled_changes on individual subscription.

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

Link to this function

subscription_for_items(customer_id, params, opts)

View Source

See ExChargebee.Customer.subscription_for_items/3.

Link to this function

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

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

Perform a update_for_items on individual subscription.

Find more information in the Chargebee Documentation