Subscriptions

List subscriptions

Request

Retrieve subscriptions for the location using cursor pagination. Optional filters: order ID, status, patient ID, item ID.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query

orderIdinteger, (int64)

Filter by purchase order ID linked to the subscription

Example:orderId=1234

Filter by subscription status

Enum:"DRAFT""ACTIVE""PENDING""PAUSED""CANCELLED""COMPLETED""FAILED""VOID"

Example:status=ACTIVE

patientIdinteger, (int64)

Filter by patient ID

Example:patientId=1234

itemIdinteger, (int64)

Filter by item ID

Example:itemId=10

sortBystring(?i)CREATED_DATE|START_DATE|NEXT_BILLING_DATE

Sort by field

Default:"CREATED_DATE"

Enum:"CREATED_DATE""START_DATE""NEXT_BILLING_DATE"

sortDirstring(?i)ASC|DESC

Sort direction

Default:"DESC"

Enum:"ASC""DESC"

cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20

Example:limit=20

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/subscription?orderId=1234&status=ACTIVE&patientId=1234&itemId=10&sortBy=CREATED_DATE&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Subscriptions retrieved successfully

Bodyapplication/json

nextCursorstring

Opaque cursor for fetching the next page

subscriptionsArray of objects(SubscriptionDTO)

List of subscriptions

Response