View Source Chargebeex.Quote (chargebeex v0.1.0)

Struct that represent a Chargebee's API quote.

Link to this section Summary

Types

"create_subscription_for_customer" | "change_subscription" | "onetime_invoice"

"tax_exclusive" | "tax_inclusive"

"open" | "accepted" | "declined" | "invoiced" | "closed"

t()

Functions

Callback implementation for Chargebeex.Resource.build/1.

Changes the quote produced for creating a new subscription items (operation_type = create_subscription_for_customer)

Changes the quote produced for adding one-time charges and charge items. (operation_type = onetime_invoice)

Changes the quote produced for updating the subscription items. (operation_type = change_subscription)

Callback implementation for Chargebeex.Resource.list/1.

Callback implementation for Chargebeex.Resource.retrieve/1.

Link to this section Types

@type operation_type() :: String.t()

"create_subscription_for_customer" | "change_subscription" | "onetime_invoice"

@type price_type() :: String.t()

"tax_exclusive" | "tax_inclusive"

@type status() :: String.t()

"open" | "accepted" | "declined" | "invoiced" | "closed"

@type t() :: %Chargebeex.Quote{
  amount_due: non_neg_integer(),
  amount_paid: non_neg_integer(),
  billing_address: map(),
  business_entity_id: String.t(),
  charge_on_acceptance: non_neg_integer(),
  contract_term_end: non_neg_integer(),
  contract_term_start: non_neg_integer(),
  contract_term_termination_fee: non_neg_integer(),
  credits_applied: non_neg_integer(),
  currency_code: String.t(),
  customer_id: String.t(),
  date: non_neg_integer(),
  discounts: [map()],
  id: String.t(),
  invoice_id: String.t(),
  line_item_discounts: [map()],
  line_item_taxes: [map()],
  line_item_tiers: [map()],
  line_items: [map()],
  name: String.t(),
  notes: [String.t()],
  operation_type: operation_type(),
  po_number: String.t(),
  price_type: price_type(),
  resource_version: non_neg_integer(),
  resources: map(),
  shipping_address: map(),
  status: status(),
  sub_total: non_neg_integer(),
  subscription_id: String.t(),
  taxes: [map()],
  total: non_neg_integer(),
  total_payable: non_neg_integer(),
  updated_at: non_neg_integer(),
  valid_till: non_neg_integer(),
  vat_number: String.t(),
  vat_number_prefix: String.t(),
  version: pos_integer()
}

Link to this section Functions

Callback implementation for Chargebeex.Resource.build/1.

Link to this function

edit_create_subscription_quote_for_items(id, params)

View Source

Changes the quote produced for creating a new subscription items (operation_type = create_subscription_for_customer)

Link to this function

edit_for_charge_items_and_charges(id, params)

View Source

Changes the quote produced for adding one-time charges and charge items. (operation_type = onetime_invoice)

Link to this function

edit_update_subscription_quote_for_items(id, params)

View Source

Changes the quote produced for updating the subscription items. (operation_type = change_subscription)

Callback implementation for Chargebeex.Resource.list/1.

Callback implementation for Chargebeex.Resource.retrieve/1.