Learn how to integrate with Pine Labs Online Plan APIs to define subscription models, set billing cycles, and manage recurring payments.
A Plan serves as the foundation for a Subscription, acting as a reusable template that defines the products or services offered, the pricing structure, and the billing cycle frequency. The billing frequency specifies how often your customers are charged daily, weekly, monthly, yearly, or at custom intervals ensuring automated and timely payments.
- Flexible Pricing: Create multiple variations with different pricing models and billing intervals based on your requirements.
- Automated Billing: Ensure consistency and automation in recurring payments with predefined billing cycles.
Note:
Before setting up a subscription through your checkout, you must first create a plan.
By setting up a Plan, you can streamline the subscription process, ensuring consistency and automation in recurring payments.
Billing Frequency
Our system allows you to easily define the debit frequency for your subscriptions. Select from the following options to determine how often the customer needs to be charged:
| Frequency | Parameters and Definition | Use Case |
|---|---|---|
Daily | 1 (Every day) | News subscriptions, daily services |
Weekly | 1 (Every Week) | Weekly magazines, services |
Monthly | 1 (Once every month) | Most common for SaaS, utilities |
Bi-monthly | Twice every month | Specialized billing cycles |
Quarterly | Once every quarter | Business services, insurance |
Half yearly | Once every six months | Insurance, domain renewals |
Yearly | 1 (Once every year) | Annual memberships, licenses |
AS | As-Presented (anytime) | Variable billing amounts |
OT | One-Time (once only) | Single payments with mandate |
Trail Period
A trial period is a promotional offer that allows your users to access the complete or partial content library for free, usually for 7, 14, or 30 days. The purpose of the trial period is to give users the opportunity to evaluate the platform's value before committing to a paid subscription.
During the trial period, only the initial_debit_amount will be deducted if it is provided by the merchant. Any additional subscription-related billing will occur only after the trial period has ended.
Pine Labs Online Plan APIs can be used for the following actions:
Use this API to create a Plan.
/api/v1/public/plans
Use this API to get the list of available plans.
/api/v1/public/plans
Use this API to get the specific plan among the plans available.
/api/v1/public/plans/{plan_id}
Use this API to update a plan.
/api/v1/public/plans/{plan_id}
Use this API to delete a plan.
/api/v1/public/plans/{plan_id}