Skip to main content
POST
Create plan template

Path Parameters

organisationId
string
required

Body

application/json
currency
string
required

The currency of the plan template

Required string length: 3
Example:

"aud"

billingType
enum<string>
required

Whether the plan is intended to be billed as a one-off or on a recurring basis.

Available options:
one_off,
recurring
Example:

"recurring"

name
string
required
Maximum string length: 500
description
string

The description of the plan template

Maximum string length: 500
Example:

"This is a plan template for a plan"

discountRate
number

The discount rate applied to the plan, as a fraction between 0 and 1.

Required range: 0 <= x <= 1
Example:

0.1

discountAmount
number

The discount amount applied to the plan, in cents.

Required range: 0 <= x <= 5000000
Example:

10000

items
object[]

Response

201 - application/json
discountRate
number
required

The discount rate applied to the plan, as a fraction between 0 and 1.

Example:

0.1

discountAmount
number
required

The discount amount applied to the plan, in cents.

Example:

10000

billingType
enum<string>
required

Whether the plan is intended to be billed as a one-off or on a recurring basis.

Available options:
one_off,
recurring
Example:

"recurring"

popularityRank
number
required

Based on the number of subscriptions created from this plan template. Used for ranking plans by popularity.

id
string
required
createdAt
string
required
name
string
required
price
number
required
currency
string
required
deleted
boolean
required
items
object[]
required
description
string