Create a subscription plan

post

https://api.confirmo.com/api/v3/subscriptions/plans

Create a plan your subscribers can subscribe to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A FIXED plan carries a price (every subscription bills it) and must omit
asset. A VARIABLE plan carries only an asset — the amount is supplied
per subscription at creation — and must omit price.

name

string

required

length between 1 and 256

type

string

enum

required

How a plan's billed amount is determined.
FIXED — the plan carries a fixed price; every subscription bills it.
VARIABLE — the plan carries only an asset; the amount is set per
subscription at creation.

Allowed:

price

object

Required for FIXED plans; must be omitted for VARIABLE plans.

asset

string

^[A-Z0-9]{3,16}$

Billing asset for a VARIABLE plan (the amount is supplied per
subscription). Required when type is VARIABLE; ignored for FIXED
(asset is taken from price.asset).

billingInterval

string

enum

required

How often the subscription is billed.

Allowed:

termCycles

integer | null

≥ 1

Number of billing cycles before the subscription term ends. Unit follows billingInterval. Null or omitted means the subscription renews indefinitely.

gracePeriod

string

required

^P(\d+Y)?(\d+M)?(\d+W)?(\d+D)?$

How long failed payments are retried while the subscription is PAST_DUE before it reaches a terminal state. Must be a whole number of days between 1 and 7 (P1D–P7D).

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Plan created.

400Request is malformed or violates a validation rule.

401Caller is unauthenticated.

403Caller is authenticated but not authorized for this resource.

422Request parsed but violates a business rule or invariant.

500Unexpected server error.