Create an addon

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

Creates a new Addon object.

Body Params

amount

float

required

A positive number representing the amount of the add-on.

apply_scheme

string

Defaults to one_time

Can be recurring or one_time. Recurring allow set a duration_times. One time is applied in the first subscription billing after add the add-on to a subscription and support prorate amount in multiple fees.

currency

string

required

Three-letter ISO code for the currency of the add-on.

description

string

required

A description for the add-on. This is used to show to your customer the billing reason.

duration_times

int32

A number representing a duration of add-on to apply_scheme=recurring.

name

string

required

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

sku

string

A simple identifier for the add-on with a 32 characters as max length.

Response

Language

Credentials


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.piriod.com/addons/ \
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
  "apply_scheme": "one_time"
10
}
11
'

Choose an example:

application/json

200200