GET /v1/subscriptions

Returns a paginated list of subscriptions for your storefront. Requires authentication.

Request

GET /v1/subscriptions

Query Parameters

Parameter	Type	Description
status	string	Filter by status: active, paused, cancelled, expired
subscription_plan_id	number	Filter by plan ID
is_active	string	Filter by active state: true or false
limit	number	Results per page (max 500, default 10)
offset	number	Number of results to skip (default 0)

Example

curl "https://api.nearpayments.io/v1/subscriptions?status=active&limit=10" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "count": 1,
  "result": [
    {
      "id": 1,
      "subscription_plan_id": 1,
      "status": "ACTIVE",
      "is_active": true,
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z",
      "expire_date": "2025-02-15T10:30:00.000Z",
      "subscriber": {
        "email": "buyer@example.com"
      }
    }
  ]
}