Api

Payments

Subscriptions

Plans

Plans

Know about Plans, list of endpoints and entity parameters.

A plan is a foundation on which a Subscription is built. It acts as a reusable template and contains details of the goods or services offered, the amount to be charged and the frequency at which the customer should be charged (billing cycle). Depending upon your business, you can create multiple plans with different billing cycles and pricing.

You should create a plan using the Checkout or Subscription link before creating a Subscription.

List of Endpoints

API EndpointDescription

Create a Plan

Creates a plan.

Fetch all Plans

Retrieves all the created plans.

Fetch a Plan by ID

Retrieves a plan by its unique identifier.

Plan Entity

The plan entity has the following fields:

id

string The unique identifier linked to a plan. This is used when creating a Subscription for customers.

entity

string The entity being created. Here, it is plan.

interval

integer This, combined with period, defines the frequency. If the billing cycle is 2 months, the value should be 2.

Handy Tips

For daily plans, the minimum value should be 7.

period

string This, combined with interval, defines the frequency. Possible values:

  • daily
  • weekly
  • monthly
  • quarterly
  • yearly

If the billing cycle is 2 months, the value should be monthly.

Handy Tips

We allow custom frequencies while creating a plan (for example, once in 3 weeks).

  • For UPI, all undefined frequencies except daily, weekly, monthly, quarterly and yearly are considered as-presented.
  • For domestic cards, all undefined frequencies except weekly, monthly and yearly are considered as-presented while registering the mandate with banks.

item

object Details of the plan.

id

string The unique identifier linked to an item. For example, item_00000000000001.

name

string Name of the plan. For example, Test Plan.

amount

integer Amount for the plan. When you use this plan to create a Subscription, the customer will be charged this amount periodically.

currency

string Currency for the payment. Defaults to MYR.

description

string Description of the plan. For example, Description of the test plan.

notes

object Notes you can enter for the contact for future reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Monthly Gym”.

created_at

integer The Unix timestamp at which the plan was created.

ON THIS PAGE