Skip to main content
POST
Create addon

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Body

application/json
name
string
required
Maximum string length: 56
description
string
required
Maximum string length: 256
currency
string
required
amount
number
required
sku
string | null
Maximum string length: 32
apply_scheme
enum<string>
default:one_time
Available options:
one_time,
recurring
duration_times
integer | null
unit_label
string | null
Maximum string length: 4
status
enum<string>
default:active
Available options:
active,
archived

Response

Addon created.

name
string
required
Maximum string length: 56
description
string
required
Maximum string length: 256
currency
string
required
amount
number
required
id
string
read-only
sku
string | null
Maximum string length: 32
apply_scheme
enum<string>
default:one_time
Available options:
one_time,
recurring
duration_times
integer | null
unit_label
string | null
Maximum string length: 4
status
enum<string>
default:active
Available options:
active,
archived
archived
string<date-time> | null
read-only
created
string<date-time>
read-only
updated
string<date-time>
read-only