Skip to main content
GET
/
api
/
subscription
List subscriptions
curl --request GET \
  --url https://api.suby.fi/api/subscription \
  --header 'X-Suby-Api-Key: <api-key>'
{
  "success": true,
  "data": {
    "data": [
      {
        "id": "sub_abc123",
        "productId": "<string>",
        "productName": "<string>",
        "customerEmail": "jsmith@example.com",
        "createdAt": "2023-11-07T05:31:56Z",
        "expiresAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 25,
      "total": 42,
      "totalPages": 2
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://documentation.suby.fi/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Suby-Api-Key
string
header
required

API key authentication

Query Parameters

​
status
enum<string>

Filter by subscription status:

  • ACTIVE — customer has access
  • INACTIVE — access removed (expired)
  • PENDING — renewal payment due (within 24h of expiry, no payment received). Customer still has access until expiresAt
  • CANCELLED — cancelled by customer or merchant
  • NOT_PAID — subscription created but no successful payment yet (e.g. checkout not completed)
Available options:
ACTIVE,
INACTIVE,
PENDING,
CANCELLED,
NOT_PAID
​
customerEmail
string<email>
​
page
integer
default:1

Page number (starts at 1)

Required range: x >= 1
​
limit
integer
default:25

Results per page (max 25)

Required range: 1 <= x <= 25

Response

Subscriptions retrieved

​
success
boolean
Example:

true

​
data
object