Plans

Create a plan

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

Creates a new Plan object.

Request Body

Name	Type	Description
product	string	ID of related Product object.
sku	string	A simple identifier for the plan with a 32 characters as max length.
name	string	A human identifier for the plan with a 56 characters as max length. This is used to help you manage plans in your account.
description	string	A description for the plan. This is used to show to your customer the billing reason.
frequency	string	A frequency type for the plan. One of monthly, annual, weekly, biannual or quarterly.
currency	string	Three-letter ISO code for the currency of the plan.
amount	string	A positive number representing the amount of the plan.
tiers	array	A list of Tier objects with prices.
tiers_mode	string	The tiers mode of the plan pricing model. One of unit range.
exempt	boolean	True or false if the plan amount is to be charged with taxes.
usage_scheme	string	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. Default is licensed.
usage_aggregation	string	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. Default is sum.

201 A newly created Plan.