Subscription (Recurring) Payments Creation
Only applicable to partners using the Ezypay subscription model
Using Ezypay’s Subscription APIs helps merchants set up payment schedules, allowing Ezypay to manage recurring payments efficiently. You only need to set up the schedule once, and Ezypay will handle the automatic collections accordingly. By using the subscription model, Ezypay can send pre-debit notifications to customers as reminders to ensure they have enough balance in their accounts.
https://developer.ezypay.com/docs/subscription-payments-for-subscription-model-option
Ezypay provides full flexibility for partners to customize the frequency, start date, subscription type, and the amount to collect for their subscriptions. We also understand the need for the first payment to differ from the recurring subscription amount and offer various options to partners. Below are some examples of what we can support:
Frequencies | Subscription type | First Payment |
---|---|---|
Daily | Total Amount Collected | Full Subscription amount |
Weekly | Number of Billing Cycles | Prorate amount |
Fortnightly | End on specific date | Self-defined amount |
Monthly | Ongoing without ending |
Below is a table of key terms we will use throughout the following section.
Terms | Description |
---|---|
Plan | Plan is the parent to a subscription that holds the billing schedule and amount. A plan id must be pass when creating a subscription and all the details will be inherited by the subscription. A single plan can have multiple subscription created under it. |
Subscription | This is an actual billing plan that is attach to a customer. It inherits all the information from a plan. However, if billing information is provided during subscription creation, it will overwrite the inherited details. |
Important Items
Create plan
Creating a plan is a mandatory step before setting up a subscription. As a best practice, you should create a single default plan and customize your subscription for each customer. The default plan details are irrelevant to your subscription; the plan ID is required to be provided when creating a subscription. All configurations will be made during subscription creation.
Create subscription
You must include a plan ID when creating a subscription. Ensure you define the billing schedule and amount during subscription creation. Ezypay APIs are flexible to satisfy different subscription scenarios required by your business.
After creating a subscription be sure to retrieve the subscription to refresh its latest information and status, especially since the first payment is usually charged immediately after the subscription creation. Refreshing ensures the information provided is updated and accurate.
Update subscription
Changes are inevitable, and it’s important to have the functionality to update subscriptions without needing to recreate them from scratch. This improves the usability of your platform and the satisfaction of both merchants and customers.
Updated 5 months ago