Chargebeex.HostedPage (chargebeex v0.6.0)

View Source

Summary

Functions

Creates a Chargebee hosted page to accept payment details from a customer and checkout to update the subscription.

Creates a Chargebee hosted page to collect due payments from a customer

Types

t()

@type t() :: %Chargebeex.HostedPage{
  business_entity_id: String.t() | nil,
  checkout_info: map() | nil,
  content: map() | nil,
  created_at: integer() | nil,
  embed: String.t() | nil,
  expires_at: integer() | nil,
  id: String.t() | nil,
  object: map() | nil,
  pass_thru_content: String.t() | nil,
  resource_version: integer() | nil,
  state: String.t() | nil,
  type: String.t() | nil,
  updated_at: integer() | nil,
  url: String.t() | nil
}

Functions

build(map_or_kwlist, opts \\ [])

@spec build(ExConstructor.map_or_kwlist(), Keyword.t()) :: %Chargebeex.HostedPage{
  business_entity_id: term(),
  checkout_info: term(),
  content: term(),
  created_at: term(),
  embed: term(),
  expires_at: term(),
  id: term(),
  object: term(),
  pass_thru_content: term(),
  resource_version: term(),
  state: term(),
  type: term(),
  updated_at: term(),
  url: term()
}

checkout_existing_for_items(params, opts \\ [])

Creates a Chargebee hosted page to accept payment details from a customer and checkout to update the subscription.

Examples

iex> Chargebeex.HostedPage.checkout_existing_for_items(%{
  subscription: %{id: "subscription_id"},
  layout: "in_app",
  subscription_items: [
    %{item_price_id: "item_price_id", quantity: 1}
  ]
})
{:ok, %Chargebeex.HostedPage{}}

collect_now(params, opts \\ [])

Creates a Chargebee hosted page to collect due payments from a customer

Examples

iex> Chargebeex.HostedPage.collect_now(%{
  customer: %{
    id: "customer_id"
  },
  card: %{
    gateway_account_id: "gateway_account_id"
  }
})
{:ok, %Chargebeex.HostedPage{}}

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

Callback implementation for Chargebeex.Resource.list/2.

retrieve(id, opts \\ [])

Callback implementation for Chargebeex.Resource.retrieve/2.