Payment Scenarios for Subscription Model

This option is used only for integration partners using the subscription model

Scenarios on Recurring Subscriptions:

There are different recurring subscription scenarios that you can create. These subscription scenarios include:

  1. Ongoing recurring subscription
  2. Ongoing recurring subscription to be debited on a specific day
  3. Ongoing recurring subscription to have 1st debit billed immediately then recurring billing to occur on a specific day
  4. Subscription to end when a specific amount has been collected
  5. Subscription to end after a specific number of billing cycles
  6. Subscription to end on a specific date
  7. Subscription is a one-off payment or paid in full
  8. Prorated Subscription

1. Ongoing Recurring Subscription

Plans can be set to run on a recurring basis for a fixed amount, for example:

  • Gym Membership - $19.99 every 2 weeks
  • Online Newspaper Subscription- $12.99 every month

To have plans configured in this manner, set the plans amount, interval and intervalUnit. By default, plans will start immediately and are ongoing until such time as the subscription is cancelled by a user.

Plan NameDescriptionamountintervalintervaluUnitbillingStartbillingStartVaulebillingEndbillingEndValue
Plan Example 1Gym Membership19.992weeksdefault valuedefault valuedefault valuedefault value
Plan Example 2Online Newspaper Subscription12.991monthdefault valuedefault valuedefault valuedefault value

2. Ongoing Recurring Subscription on Specific Day (Option 1)

Plans can be set to run on a recurring basis and issue invoices on a specific day, for example:

  • Gym Membership - $19.99 every 2 weeks, issue customer invoice fortnightly on a Wednesday
  • Online Newspaper Subscription- $12.99 every month, issue customer invoice every 15th of the month

To have have plans configured in this manner, set the plan's billingStart and billingStartValue.

Plan NameDescriptionamountintervalintervalUnitbillingStartbillingStartValuebillingEndbillingEndValue
Plan Example 1Gym Membership19.992weeksday_of_weekweddefault valuedefault value
Plan Example 2Online Newspaper Subscription12.991monthday_of_month15default valuedefault value

3. Ongoing Recurring Subscription on Specific Day (Option 2)

Plans can be set to start immediately but later follow a set schedule, for example:

  • Gym Membership - $19.99 every 2 weeks, issue customer invoice immediately but later bill every second Wednesday
  • Online Newspaper Subscription- $12.99 every month, issue customer invoice immediately but later bill every 15th of the month

To have have plans configured in this manner, set the plan's billingStart to immediate and recurringBillingDay to the day you want the recurring billing to occur.

Plan NameDescriptionamountintervalintervalUnitbillingStartbillingStartValuebillingEndbillingEndValue
Plan Example 1Gym Membership19.992weeksday_of_weekweddefault valuedefault value
Plan Example 2Online Newspaper Subscription12.991monthdday_of_month15default valuedefault value

4. Ending When Specific Amount Collected

Plans can be set to end when a certain amount is collected, such as paying for a product in installments. For example:

  • Computer Purchase Installment - $9.99 every 2 weeks, issue bill on every second Wednesday, until amount collected is $1,370.50

To have plans configured in this manner, set the plan's billingEnd to amount_collected and billingEndValue to the amount required.

Plan NameDescriptionamountintervalintervalUnitbillingStartbillingStartValuebillingEndbillingEndValue
Plan Example 1Computer Purchase Installment9.992weeksday_of_weekwedamount_collected1370.50

5. Ending after Specific Number of Billing Cycles

Plans can be set to end after a number of billing cycles. For example:

  • Language Course Pack - $15.99 every lesson for 12 monthly lessons, issue bill every 15th of the month

To have plans configured in this manner, set the plan's billingEnd to billing_cycles and billingEndValue to the number of billing cycles required.

Plan NameDescriptionamountintervalintervalUnitbillingStartbillingStartValuebillingEndbillingEndValue
Plan Example 1Language Course Pack15.991monthday_of_month15billing_cycles12

6. Ending on Specific Date

Plans can be set to end on a specific date. However, the exact date is only set when you create a subscription. For example:

  • Special limited time offer - $10 for every month until June 12, 2017

To have plans configured in this manner, set the plan's billingEnd to end_date. When you create a subscription, set the subscription's billingEndValue to the date required.

Plan NameDescriptionamountintervalintervalUnitbillingStartbillingStartValuebillingEndbillingEndValue
Plan Example 1Special limited time offer101monthimmediatedefault valueend_date
Subscription 1Special limited time offer101monthimmediatedefault valueend_date2017-06-12

7. One-off or Paid in Full

Plans can be set to be billed one-off without recurring billing, for example:

  • Online Course Full Payment - $1,300.50 one-off payment

To have plans configured in this manner, set the plan's billingEnd set to billing_cycles and billingEndValue set to 1.

Plan NameDescriptionamountintervalintervalUnitbillingStartbillingStartValuebillingEndbillingEndValue
Plan Example 1Online Course Full Payment1300.501weekdefault_valuedefault_valuebilling_cycles1
  1. Prorated Subscription

A prorated amount can be calculated and applied to the first billing of a subscription, for example:

  • Online Newspaper Subscription - $10.99 every month, billed every 15th of the month but the subscription started before the 15th

In this scenario, the customer is billed before a full month has passed. You have the option to charge a prorated amount (auto-calculated by Ezypay) so that the customer is not charged a full one month but a prorated amount based on the number of days they have been subscribed. To have plans configured in this manner, set the firstBilling to prorate.

Plan NameDescriptionamountintervalintervalUnitbillingStartbillingStartValuefirstBilling
Plan Example 1Online Newspaper Subscription10.991monthday_of_month15prorate

📘

If you do not want to use the auto-calculated prorated amount, you can define your own amount at the subscription level. The subscription will override any values on the plan level. Set firstBilling to full_amount and firstBillingAmount to the desired value.