Operations API

Subscriptions

Tamio provides an array of billing tools to manage recurring payments, regardless of whether you're offering digital services, memberships, offline services, or physical product subscriptions. Subscriptions are initiated when customers are charged on a regular basis or with an installment plan. Key features include:

  • Option to run subscriptions monthly, yearly, weekly, or daily.
  • Trial periods can be added to Billing Plans, postponing credit card charges until trial completion. Trial periods can be manually extended if required.
  • Subscriptions can be paused on demand to halt payment collection.
  • Billing plans can be altered for a customer at any point.
  • Customers are emailed automatically if a recurring charge fails, prompting them to update their credit card.
  • Automated Confirmation Emails for 3D Secure flows and SCA regulations are fully supported.
  • Subscription discounts can be offered on a one-time basis, for a limited period, or for a lifetime. These discounts can apply to all orders or can be redeemed via coupons and vouchers.
  • Webhooks are supported.

Subscription Types

Every subscription comes with a corresponding Subscription Object that houses information like products purchased, customer data, next billing date, and upcoming invoice details. Its type can be one of the following:

  • instalment: A subscription of this type corresponds to an order paid via an instalment plan. These instalments cannot be updated or have addons.
  • subscription: A subscription of this type is created when a customer purchases a billing plan. They can be updated at any point and addons can be incorporated throughout the billing cycle.
  • recurring_invoice: A subscription of this type is created when a customer pays for manually created invoices. These invoices can be partially updated and addons can be added at any time during the billing cycle.

API Endpoints

Description

Method

URL

POST

/v2/subscriptions/pause/:id

POST

/v2/subscriptions/resume/:id

POST

/v2/subscriptions/update/:id

GET

/v2/subscriptions/retrieve/:id

POST

/v2/subscriptions/discounts/create/:id

POST

/v2/subscriptions/discounts/remove/:id

POST

/v2/subscriptions/trial/extend/:id

End Trial

POST

/v2/subscriptions/trial/end/:id

POST

/v2/subscriptions/cancel/:id

DELETE

/v2/subscriptions/:id

POST

/v2/subscriptions/bulk/delete

GET

/v2/subscriptions/list

GET

/v2/subscriptions/upgrades/:id

Remove VAT

POST

/v2/subscriptions/vat/remove/:id

Webhook Events

There are several webhook notification events associated with the Subscriptions API.

  • subscription-created
  • subscription-updated
  • subscription-renewed
  • subscription-payment-failed
  • subscription-cancelled
  • instalment-completed

You can see examples of notification events here:

Subscription Statuses

Status

Description

active

The subscription/instalment plan is active.

pending

The subscription/instalment plan is awaiting payment from the customer.

past due

The renewal payment for the current billing cycle has failed. More payment retries will be attempted.

cancelled

The subscription/instalment plan has been cancelled.

trialing

The subscription is active, and the customer is on trial.

paused

The subscription is paused, and payment collection is disabled.

cancel_at_period_end

The subscription will cancel at the end of the current billing period

completed

The instalment plan has been completed successfully.

Payment Methods

Subscriptions, instalments and all related features are available for merchants with Stripe accounts. If you haven't done so, visit your payments section inside your Tamio dashboard and connect your Stripe account.

Currency

Supported Gateways

EUR

Credit cards, iDeal, SEPA, Bancontact, Sofort

All the rest

Credit Cards

Permissions

Whether managing teammates or creating API developer keys, you can customise permissions when accessing Subscriptions API resources. The default set of Subscription permissions are view, edit and remove.