Create plan
curl --request POST \
--url https://api.piriod.com/plans/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"product": "<string>",
"name": "<string>",
"description": "<string>",
"frequency": "<string>",
"currency": "<string>",
"amount": 123,
"sku": "<string>",
"exempt": false,
"usage_scheme": "licensed",
"tiers": [
{
"amount": 123,
"quantity_from": 123,
"amount_scheme": "flat",
"quantity_to": 123
}
],
"unit_label": "<string>",
"status": "active"
}
'import requests
url = "https://api.piriod.com/plans/"
payload = {
"product": "<string>",
"name": "<string>",
"description": "<string>",
"frequency": "<string>",
"currency": "<string>",
"amount": 123,
"sku": "<string>",
"exempt": False,
"usage_scheme": "licensed",
"tiers": [
{
"amount": 123,
"quantity_from": 123,
"amount_scheme": "flat",
"quantity_to": 123
}
],
"unit_label": "<string>",
"status": "active"
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
product: '<string>',
name: '<string>',
description: '<string>',
frequency: '<string>',
currency: '<string>',
amount: 123,
sku: '<string>',
exempt: false,
usage_scheme: 'licensed',
tiers: [{amount: 123, quantity_from: 123, amount_scheme: 'flat', quantity_to: 123}],
unit_label: '<string>',
status: 'active'
})
};
fetch('https://api.piriod.com/plans/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.piriod.com/plans/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'product' => '<string>',
'name' => '<string>',
'description' => '<string>',
'frequency' => '<string>',
'currency' => '<string>',
'amount' => 123,
'sku' => '<string>',
'exempt' => false,
'usage_scheme' => 'licensed',
'tiers' => [
[
'amount' => 123,
'quantity_from' => 123,
'amount_scheme' => 'flat',
'quantity_to' => 123
]
],
'unit_label' => '<string>',
'status' => 'active'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.piriod.com/plans/"
payload := strings.NewReader("{\n \"product\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"frequency\": \"<string>\",\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"sku\": \"<string>\",\n \"exempt\": false,\n \"usage_scheme\": \"licensed\",\n \"tiers\": [\n {\n \"amount\": 123,\n \"quantity_from\": 123,\n \"amount_scheme\": \"flat\",\n \"quantity_to\": 123\n }\n ],\n \"unit_label\": \"<string>\",\n \"status\": \"active\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.piriod.com/plans/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"product\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"frequency\": \"<string>\",\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"sku\": \"<string>\",\n \"exempt\": false,\n \"usage_scheme\": \"licensed\",\n \"tiers\": [\n {\n \"amount\": 123,\n \"quantity_from\": 123,\n \"amount_scheme\": \"flat\",\n \"quantity_to\": 123\n }\n ],\n \"unit_label\": \"<string>\",\n \"status\": \"active\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/plans/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"frequency\": \"<string>\",\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"sku\": \"<string>\",\n \"exempt\": false,\n \"usage_scheme\": \"licensed\",\n \"tiers\": [\n {\n \"amount\": 123,\n \"quantity_from\": 123,\n \"amount_scheme\": \"flat\",\n \"quantity_to\": 123\n }\n ],\n \"unit_label\": \"<string>\",\n \"status\": \"active\"\n}"
response = http.request(request)
puts response.read_body{
"product": "<string>",
"name": "<string>",
"description": "<string>",
"frequency": "<string>",
"currency": "<string>",
"amount": 123,
"id": "<string>",
"sku": "<string>",
"exempt": false,
"usage_scheme": "licensed",
"usage_aggregation": "last_record",
"tiers_mode": "package",
"tiers": [
{
"amount": 123,
"quantity_from": 123,
"amount_scheme": "flat",
"quantity_to": 123,
"unit_scheme": "all_units"
}
],
"unit_label": "<string>",
"status": "active",
"archived": "2023-11-07T05:31:56Z",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Plans
Create plan
POST
/
plans
/
Create plan
curl --request POST \
--url https://api.piriod.com/plans/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"product": "<string>",
"name": "<string>",
"description": "<string>",
"frequency": "<string>",
"currency": "<string>",
"amount": 123,
"sku": "<string>",
"exempt": false,
"usage_scheme": "licensed",
"tiers": [
{
"amount": 123,
"quantity_from": 123,
"amount_scheme": "flat",
"quantity_to": 123
}
],
"unit_label": "<string>",
"status": "active"
}
'import requests
url = "https://api.piriod.com/plans/"
payload = {
"product": "<string>",
"name": "<string>",
"description": "<string>",
"frequency": "<string>",
"currency": "<string>",
"amount": 123,
"sku": "<string>",
"exempt": False,
"usage_scheme": "licensed",
"tiers": [
{
"amount": 123,
"quantity_from": 123,
"amount_scheme": "flat",
"quantity_to": 123
}
],
"unit_label": "<string>",
"status": "active"
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
product: '<string>',
name: '<string>',
description: '<string>',
frequency: '<string>',
currency: '<string>',
amount: 123,
sku: '<string>',
exempt: false,
usage_scheme: 'licensed',
tiers: [{amount: 123, quantity_from: 123, amount_scheme: 'flat', quantity_to: 123}],
unit_label: '<string>',
status: 'active'
})
};
fetch('https://api.piriod.com/plans/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.piriod.com/plans/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'product' => '<string>',
'name' => '<string>',
'description' => '<string>',
'frequency' => '<string>',
'currency' => '<string>',
'amount' => 123,
'sku' => '<string>',
'exempt' => false,
'usage_scheme' => 'licensed',
'tiers' => [
[
'amount' => 123,
'quantity_from' => 123,
'amount_scheme' => 'flat',
'quantity_to' => 123
]
],
'unit_label' => '<string>',
'status' => 'active'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.piriod.com/plans/"
payload := strings.NewReader("{\n \"product\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"frequency\": \"<string>\",\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"sku\": \"<string>\",\n \"exempt\": false,\n \"usage_scheme\": \"licensed\",\n \"tiers\": [\n {\n \"amount\": 123,\n \"quantity_from\": 123,\n \"amount_scheme\": \"flat\",\n \"quantity_to\": 123\n }\n ],\n \"unit_label\": \"<string>\",\n \"status\": \"active\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.piriod.com/plans/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"product\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"frequency\": \"<string>\",\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"sku\": \"<string>\",\n \"exempt\": false,\n \"usage_scheme\": \"licensed\",\n \"tiers\": [\n {\n \"amount\": 123,\n \"quantity_from\": 123,\n \"amount_scheme\": \"flat\",\n \"quantity_to\": 123\n }\n ],\n \"unit_label\": \"<string>\",\n \"status\": \"active\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/plans/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"frequency\": \"<string>\",\n \"currency\": \"<string>\",\n \"amount\": 123,\n \"sku\": \"<string>\",\n \"exempt\": false,\n \"usage_scheme\": \"licensed\",\n \"tiers\": [\n {\n \"amount\": 123,\n \"quantity_from\": 123,\n \"amount_scheme\": \"flat\",\n \"quantity_to\": 123\n }\n ],\n \"unit_label\": \"<string>\",\n \"status\": \"active\"\n}"
response = http.request(request)
puts response.read_body{
"product": "<string>",
"name": "<string>",
"description": "<string>",
"frequency": "<string>",
"currency": "<string>",
"amount": 123,
"id": "<string>",
"sku": "<string>",
"exempt": false,
"usage_scheme": "licensed",
"usage_aggregation": "last_record",
"tiers_mode": "package",
"tiers": [
{
"amount": 123,
"quantity_from": 123,
"amount_scheme": "flat",
"quantity_to": 123,
"unit_scheme": "all_units"
}
],
"unit_label": "<string>",
"status": "active",
"archived": "2023-11-07T05:31:56Z",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Authorizations
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Headers
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Body
application/json
Product ID.
Maximum string length:
56Maximum string length:
200Frequency ID (e.g. monthly).
ISO currency code.
Maximum string length:
32Available options:
licensed, metered Available options:
last_record, max, sum Pricing mode for tiered plans. unit and range are deprecated
aliases of volume and package respectively.
Available options:
package, volume, graduated, package_overage, unit, range Show child attributes
Show child attributes
Maximum string length:
4Available options:
active, archived Response
Plan created.
Product ID.
Maximum string length:
56Maximum string length:
200Frequency ID (e.g. monthly).
ISO currency code.
Maximum string length:
32Available options:
licensed, metered Available options:
last_record, max, sum Pricing mode for tiered plans. unit and range are deprecated
aliases of volume and package respectively.
Available options:
package, volume, graduated, package_overage, unit, range Show child attributes
Show child attributes
Maximum string length:
4Available options:
active, archived 