Create a plan

post

https://api.app.subskribe.com/plans

Creates a plan. On success the id of the new plan is returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

json of the plan details

A plan is a collection of charges that dictates how a product is priced.

entityIds

array of strings, unique

Array of entity IDs associated with this plan

entityIds

name

string

required

Unique name of the plan

displayName

string

Display name of the plan shown to customers

description

string

Detailed description of the plan

status

string

enum

required

Status of the plan: DRAFT, ACTIVE, GRANDFATHERED, ARCHIVED, or DEPRECATED. Set the status to DRAFT when creating a new plan.

Allowed:

productId

string

required

ID of the product this plan is associated with

charges

array of objects

required

Array of charges associated with this plan

charges*

currency

string

Currency code for this plan (defaults to system default if not specified)

externalId

string

External identifier for the plan, used for integration with other systems

templateIds

array of strings

List of template IDs associated with this plan

templateIds

replacementPlanIds

array of strings

IDs of plans that can replace this plan during upgrades/downgrades

replacementPlanIds

customFields

object

Map of custom fields associated with this plan

updatedOn

int64

Timestamp of when the plan was last updated (in seconds since epoch)

eventObjectId

string

Response

200successful operation