View Source Chargebeex.Subscription (chargebeex v0.1.0)

Link to this section Summary

Types

"not_paid" | "no_card" | "fraud_review_failed" | "non_compliant_eu_customer" | "tax_calculation_failed" | "currency_incompatible_with_gateway" | "non_compliant_customer"

"web" | "app_store" | "play_store"

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

"future" | "in_trial" | "active" | "non_renewing" | "paused" | "cancelled"

t()

"site_default" | "plan_default" | "activate_subscription" | "cancel_subscription"

Functions

Callback implementation for Chargebeex.Resource.build/1.

Callback implementation for Chargebeex.Resource.list/1.

Callback implementation for Chargebeex.Resource.retrieve/1.

Callback implementation for Chargebeex.Resource.update/2.

Link to this section Types

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

"not_paid" | "no_card" | "fraud_review_failed" | "non_compliant_eu_customer" | "tax_calculation_failed" | "currency_incompatible_with_gateway" | "non_compliant_customer"

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

"web" | "app_store" | "play_store"

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

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

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

"future" | "in_trial" | "active" | "non_renewing" | "paused" | "cancelled"

@type t() :: %Chargebeex.Subscription{
  activated_at: non_neg_integer() | nil,
  auto_close_invoices: boolean() | nil,
  base_currency_code: binary() | nil,
  billing_period: binary() | nil,
  billing_period_unit: period_unit() | nil,
  business_entity_id: binary() | nil,
  cancel_reason: cancel_reason() | nil,
  cancel_reason_code: binary() | nil,
  cancel_schedule_created_at: non_neg_integer() | nil,
  cancelled_at: non_neg_integer() | nil,
  changes_scheduled_at: non_neg_integer() | nil,
  channel: channel() | nil,
  charged_items: [%{}],
  contract_term: %{},
  contract_term_billing_cycle_on_renewal: non_neg_integer() | nil,
  coupons: [%{}],
  create_pending_invoices: boolean() | nil,
  created_at: non_neg_integer() | nil,
  created_from_ip: binary() | nil,
  currency_code: binary() | nil,
  current_term_end: non_neg_integer() | nil,
  current_term_start: non_neg_integer() | nil,
  custom_fields: %{},
  customer_id: binary(),
  deleted: boolean(),
  due_invoices_count: integer() | nil,
  due_since: non_neg_integer() | nil,
  exchange_rate: float() | nil,
  free_period: integer() | nil,
  free_period_unit: period_unit() | nil,
  has_scheduled_advance_invoices: boolean(),
  has_scheduled_changes: boolean(),
  id: binary(),
  invoice_notes: binary() | nil,
  item_tiers: [%{}],
  metadata: %{},
  mrr: non_neg_integer() | nil,
  net_term_days: integer() | nil,
  next_billing_at: non_neg_integer() | nil,
  object: binary() | nil,
  override_relationship: boolean() | nil,
  pause_date: non_neg_integer() | nil,
  payment_source_id: binary() | nil,
  plan_amount_in_decimal: binary() | nil,
  plan_free_quantity_in_decimal: binary() | nil,
  plan_quantity_in_decimal: binary() | nil,
  plan_unit_price_in_decimal: binary() | nil,
  po_number: binary() | nil,
  referral_info: %{},
  remaining_billing_cycles: non_neg_integer() | nil,
  resource_version: non_neg_integer() | nil,
  resume_date: non_neg_integer() | nil,
  shipping_address: %{},
  start_date: non_neg_integer() | nil,
  started_at: non_neg_integer() | nil,
  status: status(),
  subscription_items: [%{}],
  total_dues: non_neg_integer() | nil,
  trial_end: non_neg_integer() | nil,
  trial_end_action: trial_end_action() | nil,
  trial_start: binary() | nil,
  updated_at: non_neg_integer() | nil
}
@type trial_end_action() :: String.t()

"site_default" | "plan_default" | "activate_subscription" | "cancel_subscription"

Link to this section Functions

Callback implementation for Chargebeex.Resource.build/1.

Callback implementation for Chargebeex.Resource.list/1.

Callback implementation for Chargebeex.Resource.retrieve/1.

Callback implementation for Chargebeex.Resource.update/2.