Before creating subscriptions, you must create a plan in the Control Panel. Plans cannot be created, updated, or deleted via the API. However, you can retrieve existing plans via the API. A plan is a template for your subscriptions: when you create a plan, it will be used to populate the following attributes when a new subscription is created:

  • plan name
  • description
  • trial period
  • billing day of month
  • number of billing cycles
  • amount
  • currency
  • billing cycle

You will need to specify the plan_id when creating a subscription.

Merchants operating in the European Union must give customers 7 business days’ notice before changing the price of their recurring billing plan; 7 business days’ notice is also required before billing customers if it has been 6+ months since their last payment. If you don’t operate in the EU, these notices aren't required (but they're still good practice).

Add-ons and discounts

Add-ons and discounts are created in the Control Panel. You cannot create or update them through the API.

Add-ons and discounts can be applied manually on a case-by-case basis, or you can associate them with certain plans to apply them automatically to new subscriptions. When creating a subscription, it will automatically inherit any add-ons and/or discounts associated with the plan. You can override those details at the time you create or update the subscription.

When creating an add-on or discount you can specify:

  • id
  • name
  • description
  • amount (must be a number between 1 and 9999.99)
  • number_of_billing_cycles

Next: Creating Subscriptions →

See also

Still Have Questions?

If you can’t find an answer, give us a call at 877.434.2894 or email our Support team.