List Subscription Plans

Returns all subscription plans existing under the merchant's company account, with pagination.

GET/api/subscriptionsAuth: Required

Query Parameters

pagenumber

Page number. Default 1.

perPagenumber

Items per page. Default 10.

Response

pagenumber

Current page number.

perPagenumber

Items per page.

totalItemsnumber

Total number of plans matching the filter.

totalPagesnumber

Total pages available.

dataarray

List of plan objects. Each plan contains the same fields as the Create Plan response.

GET/api/subscriptions

curl -G 'https://my.shotpay.io/api/subscriptions' \
  -H 'Authorization: Bearer YOUR_PUBLIC_TOKEN' \
  --data-urlencode 'page=1' \
  --data-urlencode 'perPage=10' \
  --data-urlencode 'status=active'

EXAMPLE RESPONSE

{
  "page": 1,
  "perPage": 10,
  "totalItems": 1,
  "totalPages": 1,
  "data": [
    {
      "id": "plan-uuid",
      "status": "active",
      "name": "Monthly plan",
      "createdAt": "2026-05-29T10:00:00.000Z",
      "expiresAt": "2026-06-05T10:00:00.000Z",
      "nextBillingAt": null,
      "billing": { "intervalCount": 1, "intervalUnit": "month" },
      "invoiceContent": {
        "invoiceCurrency": "eur",
        "items": [{ "name": "Subscription", "price": "100.00" }],
        "paymentCurrency": null,
        "isMerchantPaysFee": false,
        "invoiceAmount": "100.00"
      },
      "revenue": "500.00",
      "redirectURL": "https://example.com/thanks"
    }
  ]
}