Skip to main content
GET
List custom property definitions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

entity_type
enum<string>

Filter to a single entity type.

Available options:
CUSTOMER,
SUBSCRIPTION,
INVOICE,
CREDIT_NOTE
include_archived
boolean

Include archived (soft-deleted) definitions. Defaults to false.

page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of custom property definitions

data
object[]
required
pagination_meta
object
required