Nombaone.Plans.Prices (Nomba One v0.1.0)

View Source

Prices nested under a plan — create and list. Read and deactivate prices directly via Nombaone.Prices.

Summary

Functions

Create a price under a plan. Prices are immutable once created.

List a plan's prices, newest first.

Functions

create(client, plan_id, params, opts \\ [])

@spec create(Nombaone.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Nombaone.Price.t()} | {:error, Nombaone.Error.t()}

Create a price under a plan. Prices are immutable once created.

Money is integer kobo

unit_amount_in_kobo is integer kobo250_000 is ₦2,500.00.

Example

{:ok, price} =
  Nombaone.Plans.Prices.create(client, plan.id, %{
    unit_amount_in_kobo: 250_000,
    interval: "month"
  })

create!(client, plan_id, params, opts \\ [])

@spec create!(Nombaone.Client.t(), String.t(), map(), keyword()) :: Nombaone.Price.t()

Raising variant of create/4.

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

@spec list(Nombaone.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Nombaone.Page.t()} | {:error, Nombaone.Error.t()}

List a plan's prices, newest first.

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

@spec list!(Nombaone.Client.t(), String.t(), map(), keyword()) :: Nombaone.Page.t()

Raising variant of list/4.