Raw schema
{
"type": "object",
"properties": {
"customer": {
"description": "Only these customer ids.",
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"membership": {
"description": "Only these membership (plan) ids.",
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"ids": {
"description": "Only these customer membership ids.",
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"status": {
"description": "Customer membership status.",
"type": "array",
"items": {
"type": "string",
"enum": [
"active",
"hold",
"complete",
"cancelled"
]
}
},
"membership_type": {
"description": "Membership type.",
"type": "array",
"items": {
"type": "string",
"enum": [
"pack",
"recurring",
"prepaid"
]
}
},
"has_active_hold": {
"description": "Only memberships with (true) or without (false) a current or upcoming hold.",
"type": "boolean"
},
"start_date_gte": {
"description": "Start date on or after (date, YYYY-MM-DD).",
"type": "string"
},
"start_date_lte": {
"description": "Start date on or before (date, YYYY-MM-DD).",
"type": "string"
},
"expiration_date_gte": {
"description": "Expiration date on or after (date, YYYY-MM-DD).",
"type": "string"
},
"expiration_date_lte": {
"description": "Expiration date on or before (date, YYYY-MM-DD).",
"type": "string"
},
"sort": {
"description": "Ordering; '-' for descending.",
"type": "string",
"enum": [
"start_date",
"-start_date",
"expiration_date",
"-expiration_date",
"status",
"-status",
"membership.name",
"-membership.name",
"membership.type",
"-membership.type"
]
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"page_size": {
"description": "Results per page, 1-100 (default 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"expand": {
"description": "Comma-separated related fields to expand into full objects (dot-nested, max depth 4), e.g. customer,event.instructors.",
"type": "string"
},
"fields": {
"description": "Comma-separated fields to return (dot notation for nested), e.g. id,name,starts_at.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}