View Source Chargebeex.ItemPrice (chargebeex v0.2.0)

Struct that represent a Chargebee's API item price resource.

Link to this section Summary

Types

"web" | "app_store" | "play_store"

"all" | "restricted"

"day" | "week" | "month" | "year"

"flat_fee" | "per_unit" | "tiered" | "volume" | "stairstep"

"active" | "archived" | "deleted"

t()

"site_default" | "activate_subscription" | "cancel_subscription"

"plan" | "addon" | "charge"

Link to this section Types

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

"web" | "app_store" | "play_store"

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

"all" | "restricted"

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

"day" | "week" | "month" | "year"

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

"flat_fee" | "per_unit" | "tiered" | "volume" | "stairstep"

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

"active" | "archived" | "deleted"

@type t() :: %Chargebeex.ItemPrice{
  accounting_detail: map(),
  archived_at: non_neg_integer() | nil,
  billing_cycles: non_neg_integer() | nil,
  channel: channel() | nil,
  created_at: non_neg_integer() | nil,
  currency_code: String.t() | nil,
  description: String.t() | nil,
  external_name: String.t() | nil,
  free_quantity: non_neg_integer() | nil,
  free_quantity_in_decimal: String.t() | nil,
  id: String.t() | nil,
  invoice_notes: String.t() | nil,
  is_taxable: boolean(),
  item_family_id: String.t() | nil,
  item_id: String.t() | nil,
  item_type: type() | nil,
  metadata: map(),
  name: String.t() | nil,
  period: non_neg_integer() | nil,
  period_unit: non_neg_integer() | nil,
  price: non_neg_integer() | nil,
  price_in_decimal: String.t() | nil,
  pricing_model: pricing_model() | nil,
  resource_version: String.t() | nil,
  shipping_period: non_neg_integer() | nil,
  shipping_period_unit: period_unit() | nil,
  show_description_in_invoices: boolean() | nil,
  show_description_in_quotes: boolean() | nil,
  status: status() | nil,
  tax_detail: map(),
  tiers: map(),
  trial_end_action: trial_end_action() | nil,
  trial_period: non_neg_integer() | nil,
  trial_period_unit: String.t() | nil,
  updated_at: non_neg_integer() | nil
}
@type trial_end_action() :: String.t()

"site_default" | "activate_subscription" | "cancel_subscription"

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

"plan" | "addon" | "charge"

Link to this section Functions

Link to this function

build(map_or_kwlist, opts \\ [])

View Source
@spec build(ExConstructor.map_or_kwlist(), Keyword.t()) :: %Chargebeex.ItemPrice{
  accounting_detail: term(),
  archived_at: term(),
  billing_cycles: term(),
  channel: term(),
  created_at: term(),
  currency_code: term(),
  description: term(),
  external_name: term(),
  free_quantity: term(),
  free_quantity_in_decimal: term(),
  id: term(),
  invoice_notes: term(),
  is_taxable: term(),
  item_family_id: term(),
  item_id: term(),
  item_type: term(),
  metadata: term(),
  name: term(),
  period: term(),
  period_unit: term(),
  price: term(),
  price_in_decimal: term(),
  pricing_model: term(),
  resource_version: term(),
  shipping_period: term(),
  shipping_period_unit: term(),
  show_description_in_invoices: term(),
  show_description_in_quotes: term(),
  status: term(),
  tax_detail: term(),
  tiers: term(),
  trial_end_action: term(),
  trial_period: term(),
  trial_period_unit: term(),
  updated_at: term()
}
Link to this function

create(params, opts \\ [])

View Source

Callback implementation for Chargebeex.Resource.create/2.

Callback implementation for Chargebeex.Resource.delete/2.

Link to this function

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

View Source

Callback implementation for Chargebeex.Resource.list/2.

Link to this function

retrieve(id, opts \\ [])

View Source

Callback implementation for Chargebeex.Resource.retrieve/2.

Link to this function

update(id, params, opts \\ [])

View Source

Callback implementation for Chargebeex.Resource.update/3.