Subscription Concepts

Subscription Plan

A subscription plan is a template on which a merchant can configure all the basic information for the subscription, such as the name and the schedule.

The schedule is composed of an interval and an interval count, these properties dictate when the buyer's card will be charged. Example: a schedule with a monthly interval and interval count of 2 will charge the buyer's card every 2 months.

Optionally a trial period can be specified using the same schedule format. A plan with trial option will not charge the buyer's card until the trial period is expired.

Plan Offer

An offer is a customized link created for a buyer. When creating an offer, you can associate a list of subscription plans.

When an offer is created, you will then receive a link. This link can be sent to the buyer and the buyer will then be able to choose between the available plans to complete their subscription.

When using the API, the offer object will contain 2 links. One labeled self, which can be sent directly to the buyer and one labeled embeddable which can be use to embed the checkout user experience into your own system.

Subscription

A subscription object is create when a buyer actively subscribes to a previously sent plan offer. A subscription is always tied to a checkout instrument (a buyer's credit card, apple pay, etc), which will be charged according to the selected plan's schedule.