conekta_ex v1.0.1 ConektaEx.Plan

Link to this section Summary

Functions

Creates a plan

Deletes a plan with plan_id

Retrieves a list of plans

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Plan. See ConektaEx.StructList.request_next/2 for examples

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Plan. See ConektaEx.StructList.request_previous/2 for examples

Retrieves a plan with plan_id

Updates a plan with plan_id and Map attrs

Link to this section Types

Link to this type t()
t() :: %ConektaEx.Plan{
  amount: term(),
  created_at: term(),
  currency: term(),
  expiry_count: term(),
  frequency: term(),
  id: term(),
  interval: term(),
  livemode: term(),
  name: term(),
  object: term(),
  trial_period_days: term()
}

Link to this section Functions

Link to this function create(attrs)
create(map()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Creates a plan.

Examples

iex> create(map_with_valid_params)
{:ok, %ConektaEx.Plan{}}

iex> create(map_with_bad_params)
{:error, %ConektaEx.Error{}}
Link to this function delete(plan_id)
delete(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Deletes a plan with plan_id

Examples

iex> delete(ok_plan_id)
{:ok, %ConektaEx.Plan{}}

iex> delete(bad_plan_id)
{:error, %ConektaEx.Error{}}
Link to this function list()
list() :: {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}

Retrieves a list of plans.

Link to this function next_page(struct_list, limit \\ nil)
next_page(ConektaEx.StructList.t(), any()) ::
  {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Plan. See ConektaEx.StructList.request_next/2 for examples.

Link to this function previous_page(struct_list, limit \\ nil)
previous_page(ConektaEx.StructList.t(), any()) ::
  {:ok, ConektaEx.StructList.t()} | {:error, ConektaEx.Error.t()}

Gets a ConektaEx.StructList with ‘data’ as a list of ConektaEx.Plan. See ConektaEx.StructList.request_previous/2 for examples.

Link to this function retrieve(plan_id)
retrieve(binary()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Retrieves a plan with plan_id

Examples

iex> retrieve(ok_plan_id)
{:ok, %ConektaEx.Plan{}}

iex> retrieve(bad_plan_id)
{:error, %ConektaEx.Error{}}
Link to this function update(plan_id, attrs)
update(binary(), map()) :: {:ok, t()} | {:error, ConektaEx.Error.t()}

Updates a plan with plan_id and Map attrs

Examples

iex> update(ok_plan_id, ok_attrs)
{:ok, %ConektaEx.Plan{}}

iex> update(bad_plan_id, ok_attrs)
{:error, %ConektaEx.Error{}}