Skip to main content
POST

Authentication

This endpoint requires a Bearer token in the Authorization header.

Body Parameters

string
required
A human-readable name for the subscription plan (e.g., Pro Monthly, Enterprise Yearly).
number
required
The recurring payment amount per billing interval.
string
required
The fiat currency for the plan. Supported values: USD, LKR.
string
required
The billing interval. Accepted values: daily, weekly, monthly, yearly.
integer
Number of free trial days before the first billing cycle begins. Defaults to 0.
string
A description of what the plan includes. Displayed to customers on the checkout page.

Response

string
Unique identifier for the subscription plan.
string
The plan name.
number
The recurring amount.
string
The plan currency.
string
The billing interval.
integer
Number of trial days.
string
The plan description.
boolean
Whether the plan is currently active and accepting new subscribers.
string
ISO 8601 timestamp of when the plan was created.