Get list of add-ons

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Time range from (inclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Default from if no interval is given depends on the query. If the query limits on relation e.g. customer and/or subscription, the default from will be epoch 1970-01-01, otherwise one month before to

string

Time range to (exclusive). Local date and time (according to account timezone) on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS. Defaults to now.

string

Limit from to and interval back in time. E.g. one week. Will take precedence over from. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations

int32
10 to 100
Defaults to 20

Page size between 10 and 100 (default 20)

string

Next page token from previous response to get next page

string
enum
Defaults to created

Time and date attribute to time limit. Can be created or deleted

Allowed:
string

Add-on exact handle

string

Add-on handle prefix

string
enum
Defaults to active

Add-on state. Accepted values active or deleted

Allowed:
string
enum

Type of add-on. Accepted values: on_off or quantity. An on_off type cannot be given a quantity when attached to subscription. For quantity type it is possible.`

Allowed:
string

Name of add-on. Used as order line text.

string

Optional description of add-on

string

Add-on amount interval. See documentation of intervals.

string

Amount incl vat flag. Values: true or false

string

Filter by whether add-on is eligible for all plans. Values: true or false

string

Plan handle filter. Returns add-ons eligible for the given plan or all plans.

currency
array of strings

Add-on currency in ISO 4217 three letter alpha code. Multiple can be defined.

currency
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json