Create a Subscription Plan

A subscription plan consists of basic information like plan name, amount, and frequency. An example of a subscription plan could be “Spotify Premium Membership” which is SGD 9.90 monthly.

Headers

X-BUSINESS-API-KEY

string

required

Body

application/json

name

string

required

Plan name. It's required field

cycle

enum<string>

default: monthlyrequired

Billing frequency (weekly / monthly / yearly / custom / save_card). If cycle = custom then the user has to send the fields cycle_repeat and cycle_frequency

Available options:

weekly,

monthly,

yearly,

custom,

save_card

amount

integer

required

Min: 1, Max: 999999.99. It's required field

Required range: 1 < x < 999999.99

description

string

The description of subscription plan

cycle_frequency

enum<string>

[This field is only applicable when cycle = custom] It's the frequency of the cycle [day / week / month / year]

Available options:

day,

week,

month,

year

cycle_repeat

integer

[This field is only applicable when cycle = custom] It's the number of times the cycle will repeat.

currency

string

reference

string

Arbitrary reference number that you can map to your internal reference number. This value cannot be edited by the customer

Maximum length: 255

redirect_url

string

The redirected URL after the payment

start_date_method

enum<string>

Available options:

sign_up_date,

customer_select_date,

fixed_date

fixed_date

number

it's required if start_date_method = fixed_date

Required range: 1 < x < 28

times_to_be_charged

number

Required range: 1 < x < 100

Response

200 - application/json

id

string

name

string

description

string

cycle

string

cycle_repeat

any

cycle_frequency

any

currency

string

amount

number

default: 0

reference

string

created_at

string

updated_at

string