Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Headers

x-broker-id
string<uuid>

Query Parameters

customerId
string<uuid>
status
enum<string>
Available options:
DRAFT,
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED
externalCode
string
activatedAtFrom
string<date-time>
activatedAtTo
string<date-time>
endDateFrom
string<date-time>
endDateTo
string<date-time>
productId
string<uuid>
brokerId
string<uuid>
page
integer
default:1
pageSize
integer
default:20
Required range: x <= 100

Response

Default Response

id
string
required
name
string
required
customer
object
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED
activatedAt
null | string
required
createdAt
string
required
endDate
null | string
externalCode
null | string
metadata
object | null
billingCycle
object | null