Overview of recurring API

The Recurring API lets you manage your recurring payments and subscription management setup. Under this API, you can:

  • View recurring plans
  • Queue (trigger) a recurring plan for processing
  • Create and modify subscriptions
  • Add and remove subscription add-ons
  • List and view subscriptions


Authentication and general API information

This API is an extension of the Helcim General API. Please refer to the documentation above for information on authentication, security, TLS ciphers and error handling.

Understanding subscription management

What is subscription management?
In your Helcim Account you can create subscriptions for simple or complex automatic billing cycles based on your needs. Each of these billing methods will allow you to add and customize initial setup fees, monthly fees, trial periods, and frequency of charges.

There are three different types of subscription management plans that are available:

Subscription Based Plans:

  • All customers will be billed following a chosen billing period start date and frequency
  • You can choose different days you would like each customer to be billed on

Cycle Based Plans:

  • All customers for this plan type will be billed on the same day

Pro-Rata Based Plans:

  • The recurring amount is prorated from the start date of the subscription to the next billing date of the plan

When you create a new plan in your Helcim Account, you are able to specify which type of subscription plan you want to create based on the product or service you offer. To learn more, visit our merchant guides and tutorials.