Skip to main content
GET
List subscriptions for external contact

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:20

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

id
integer
id[]
integer[]
productOption
string
productOption[]
string[]
productPrice
string
productPrice[]
string[]
product.uuid
string
product.uuid[]
string[]
status
string
status[]
string[]
member
string
member[]
string[]
member.lastName
string
contact.name
string
contact
string
contact[]
string[]
order[createdAt]
enum<string>
default:asc
Available options:
asc,
desc
order[productOption.id]
enum<string>
default:asc
Available options:
asc,
desc
order[currentPeriodEnd]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
currentPeriodEnd[before]
string
currentPeriodEnd[strictly_before]
string
currentPeriodEnd[after]
string
currentPeriodEnd[strictly_after]
string
exists[isSubscriptionInactive]
boolean
exists[isSubscriptionCanceled]
boolean
exists[member]
boolean
exists[contact]
boolean

Response

200 - application/json

SubscriptionProfile collection

id
integer
read-only
member
object | null
productPrice
object | null
currency
string | null
currentPeriodEnd
string<date-time> | null
stripeCustomerId
string | null
stripeSubscriptionId
string | null
isSubscriptionInactive
boolean | null
product
object
createdAt
string<date-time>
isSubscriptionCanceled
boolean | null
customPriceValue
integer | null
contact
object | null
status
string | null
uid
string | null
isPublic
boolean | null
identity
object | null
identityReminderSent
boolean | null
localCenterOption
object | null
identityReminder2Sent
boolean | null
identityReminder3Sent
boolean | null