---
title: "Get subscription collection"
method: GET
path: "/subscriptions"
tags: ["Subscriptions"]
---

# Get subscription collection

`GET /subscriptions`

Query all subscriptions filtered by the provided parameters

## Query parameters

- `id` integer
- `dateActivated` string
- `dateBilling` string
- `status` 'active' | 'paused' | 'cancelled' | 'term_ending' | 'term_ended'
- `paymentPlanId` integer
- `customerCode` string
- `timesBilled` integer
- `setupAmount` number, float
- `recurringAmount` number, float
- `freeTrialPeriod` integer
- `maxCycles` integer
- `hasFailedPayments` 'false' | 'true'
- `addOnId` integer
- `sortBy` 'asc' | 'desc'
- `limit` integer
- `offset` integer

## Headers

- `api-token` string, required

## Response `200`

Successful subscription collection query. The response body contains the data representation of all queried  subscriptions matching the provided parameters.

- SubscriptionCollectionRes
  - `data` BaseSubscription[]
    - `id` integer
    - `dateCreated` string, date-time
    - `dateUpdated` string, date-time
    - `dateActivated` string, date
    - `dateBilling` string, date
    - `status` string
    - `paymentPlanId` integer
    - `customerCode` string
    - `timesBilled` integer
    - `setupAmount` number, float
    - `recurringAmount` number, float
    - `freeTrialPeriod` integer
    - `maxCycles` integer
    - `hasFailedPayments` string
    - `addOnIds` integer[]

## Other responses

- `204` — No subscriptions found matching the provided parameters.
- `400` — You are initiating a request with invalid parameter and/or body values.
- `401` — You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the `api-token` header
- `403` — You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.
- `500` — Helcim internal server error encountered.

---

[API](https://skmtc.net/helcim/apis/the-helcim-api.md) · [All operations](https://skmtc.net/helcim/apis/the-helcim-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helcim/the-helcim-api/versions/345052ca6578/schema)