Create a plan

post https://api.piriod.com/plans/

Creates a new Plan object.

Body Params

amount

float

required

A positive number representing the amount of the plan. Required if plans does not have tiers.

currency

string

required

Three-letter ISO code for the currency of the plan.

description

string

required

A description for the plan. This is used to show to your customer the billing reason.

exempt

boolean

Defaults to false

True or false if the plan amount is to be charged with taxes.

frequency

string

Defaults to monthly

A frequency type for the plan. One of monthly, annual, weekly, biannual or quarterly.

name

string

required

A human identifier for the plan with a 56 characters as max length. This is used to help you manage plans in your account.

product

string

required

ID of related Product object.

tiers

string

A list of Tier objects with prices.

tiers_mode

string

The tiers mode of the plan pricing model. One of unit range.

sku

string

A simple identifier for the plan with a 32 characters as max length.

usage_aggregation

string

Defaults to sum

Specifies a usage aggregation scheme for plans with usage_scheme=metered. Allowed values are sum to summing up all usages records reported within a period, max which uses the usage records with the maximum usage record reported within a period or last_record for using the last record reported within a period.

usage_scheme

string

Defaults to licensed

Can be either licensed or metered. Licensed automatically bills the quantity set when adding it to a subscription. Metered aggregates the total usage based on usage records.

Responses

Language

Credentials


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.piriod.com/plans/ \
3
     --header 'Authorization: Token YOUR_USER_API_KEY' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --header 'x-simple-workspace: YOUR_ORGANIZATION_ID' \
7
     --data '
8
{
9
  "exempt": false,
10
  "frequency": "monthly",
11
  "usage_aggregation": "sum",
12
  "usage_scheme": "licensed"
13
}
14
'

Choose an example:

application/json

201201

400400