ExShopify v0.2.0 ExShopify.UsageCharge

Charge a variable monthly fee for an app or a service.

Summary

Types

usage_charge_plural()
usage_charge_plural() :: {:ok, [%ExShopify.UsageCharge{created_at: term, description: term, id: term, price: term, recurring_application_charge_id: term, updated_at: term}], %ExShopify.Meta{api_call_limit: term}}
usage_charge_singular()
usage_charge_singular() :: {:ok, %ExShopify.UsageCharge{created_at: term, description: term, id: term, price: term, recurring_application_charge_id: term, updated_at: term}, %ExShopify.Meta{api_call_limit: term}}

Functions

create(session, recurring_application_charge_id, params)
create(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, map) ::
  usage_charge_singular |
  ExShopify.Resource.error

Create a usage charge.

Examples

iex> params = %{
...>   description: "Super Mega Plan 1000 emails",
...>   price: 1.0
...> }

iex> ExShopify.UsageCharge.create(session, 455696195, params)
{:ok, usage_charge, meta}
find(session, id, recurring_application_charge_id)
find(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, integer | String.t) ::
  usage_charge_singular |
  ExShopify.Resource.error
find(session, id, recurring_application_charge_id, params)
find(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, integer | String.t, map) ::
  usage_charge_singular |
  ExShopify.Resource.error

Receive a single usage charge.

Examples

iex> ExShopify.UsageCharge.find(session, 1034618214, 455696195)
{:ok, usage_charge, meta}
list(session, recurring_application_charge_id)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t) ::
  usage_charge_plural |
  ExShopify.Resource.error
list(session, recurring_application_charge_id, params)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, integer | String.t, map) ::
  usage_charge_plural |
  ExShopify.Resource.error

Retrieve all usage charges.

Examples

iex> ExShopify.UsageCharge.list(session, 455696195)
{:ok, usage_charges, meta}