Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

active_from
string

ActiveFrom/ActiveTo select commitments whose term overlaps [ActiveFrom, ActiveTo).

active_to
string
customer_ids
string[]
end_time
string<date-time>
expand
string
filters
object[]
ids
string[]
limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
scope_entity_ids
string[]
scope_entity_type
enum<string>
Available options:
subscription,
group,
meter,
price
sort
object[]
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
statuses
enum<string>[]
Available options:
active,
ended,
terminated
subscription_ids
string[]

Response

OK

items
object[]
pagination
object