List Subscriptions

GET

/api/Subscriptions

curl --request GET \
  --url 'https://example.com/api/Subscriptions?Status=Trial' \
  --header 'Authorization: Bearer <token>'

Returns a paginated list of subscriptions for a merchant. Supports filtering by member, plan, and status.

GET /api/subscriptions?merchantId=...&status=Active&page=1

Authorizations

• Bearer

Parameters

Query Parameters

MerchantId

string format: uuid

MemberId

string format: uuid

PlanId

string format: uuid

Status

string

Allowed values: Trial Active PastDue Paused Cancelled

Page

integer format: int32

PageSize

integer format: int32

Responses

200

Paginated list of subscriptions.

Media type application/json

object

items

Array<object>

nullable

object

id

string format: uuid

memberId

string format: uuid

memberName

string

nullable

memberEmail

string

nullable

planId

string format: uuid

planName

string

nullable

planPrice

number format: double

planFrequency

string

Allowed values: OneOff Daily Weekly Fortnightly Monthly Quarterly Yearly

status

string

Allowed values: Trial Active PastDue Paused Cancelled

nextBillingDate

string format: date-time

nullable

nextBillingAmount

number format: double

nullable

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

totalPages

integer format: int32

hasNextPage

boolean

hasPreviousPage

boolean

Example

{
  "items": [
    {
      "planFrequency": "OneOff",
      "status": "Trial"
    }
  ]
}