Skip to main content
POST
Create Plan

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Body

application/json
name
string
required

The name of the subscription plan.

Example:

"Basic Monthly Instant"

amount
number
required

The amount to charge on each billing cycle. Must be greater than or equal to zero.

Example:

100

currency
string
required

The 3-letter ISO currency code for the billing.

Example:

"NGN"

interval
string
required

Billing frequency. Supported values are DAILY, WEEKLY, MONTHLY, QUARTERLY, and ANNUAL.

Example:

"MONTHLY"

trialPeriodDays
integer
required

Number of free trial days before billing begins. Defaults to 0.

Example:

2

description
string

A brief overview or summary explaining what the plan offer entails.

Example:

"Basic tier billed monthly"

billingLimit
integer

The maximum number of billing cycles. Leave empty for unlimited billing.

Example:

1

Response

Funding Successful

success
boolean

Indicates if the request was successful.

Example:

true

message
string

Descriptive message regarding the plan creation operation.

Example:

"Plan created"

data
object

The payload containing the details of the created plan.