ExShopify v0.2.0 ExShopify.RecurringApplicationCharge
Request to charge a shop a recurring fee.
Summary
Functions
Activate a recurring application charge
Create a recurring application charge
Customize a recurring application charge
Cancel a recurring application charge
Receive a single recurring application charge
Receive all recurring application charges
Types
recurring_application_charge_plural()
recurring_application_charge_plural() :: {:ok, [%ExShopify.RecurringApplicationCharge{activated_on: term, billing_on: term, cancelled_on: term, capped_amount: term, confirmation_url: term, created_at: term, id: term, name: term, price: term, return_url: term, status: term, terms: term, test: term, trial_days: term, trial_ends_on: term, updated_at: term}], %ExShopify.Meta{api_call_limit: term}}
recurring_application_charge_singular()
recurring_application_charge_singular() :: {:ok, %ExShopify.RecurringApplicationCharge{activated_on: term, billing_on: term, cancelled_on: term, capped_amount: term, confirmation_url: term, created_at: term, id: term, name: term, price: term, return_url: term, status: term, terms: term, test: term, trial_days: term, trial_ends_on: term, updated_at: term}, %ExShopify.Meta{api_call_limit: term}}
Functions
activate(session, id)
activate(%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) :: recurring_application_charge_singular | ExShopify.Resource.error
Activate a recurring application charge.
Examples
iex> ExShopify.RecurringApplicationCharge.activate(session, 455696195)
{:ok, recurring_application_charge, meta}
create(session, params)
create(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, map) :: recurring_application_charge_singular | ExShopify.Resource.error
Create a recurring application charge.
Examples
Create a new charge called ‘Super Duper Plan’ for $10.00 USD per month
iex> params = %{
...> name: "Super Duper Plan",
...> price: 10.0,
...> return_url: "http://super-duper.shopifyapps.com"
...> }
iex> ExShopify.RecurringApplicationCharge.create(session, params)
{:ok, recurring_application_charge, meta}
Create a recurring test charge that will not cause a credit card to be charged
iex> params = %{
...> name: "Super Duper Plan",
...> price: 10.0,
...> return_url: "http://super-duper.shopifyapps.com",
...> test: true
...> }
iex> ExShopify.RecurringApplicationCharge.create(session, params)
{:ok, recurring_application_charge, meta}
customize(session, id, params)
customize(%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) :: recurring_application_charge_singular | ExShopify.Resource.error
Customize a recurring application charge.
Examples
iex> params = %{
...> capped_amount: 200
...> }
iex> ExShopify.RecurringApplicationCharge.customize(session, 455696195, params)
{:ok, recurring_application_charge, meta}
delete(session, id)
delete(%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) :: ExShopify.Resource.meta_only | ExShopify.Resource.error
Cancel a recurring application charge.
Examples
iex> ExShopify.RecurringApplicationCharge.delete(session, 455696195)
{:ok, meta}
find(session, 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) :: recurring_application_charge_singular | ExShopify.Resource.error
find(session, 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, map) :: recurring_application_charge_singular | ExShopify.Resource.error
Receive a single recurring application charge.
Examples
iex> ExShopify.RecurringApplicationCharge.find(session, 455696195)
{:ok, recurring_application_charge, meta}
list(session)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}) :: recurring_application_charge_plural | ExShopify.Resource.error
list(session, params)
list(%ExShopify.Session{access_token: term, api_key: term, domain: term, port: term, protocol: term, secret: term, shop_name: term, shop_url: term}, map) :: recurring_application_charge_plural | ExShopify.Resource.error
Receive all recurring application charges.
Examples
iex> ExShopify.RecurringApplicationCharge.list(session)
{:ok, recurring_application_charge, meta}