---
title: "Get user subscriptions"
method: GET
path: "/subscription"
tags: ["Subscription"]
---

# Get user subscriptions

`GET /subscription`

Retrieves a paginated list of subscriptions for the authenticated user

## Query parameters

- `status` 'INITIATION' | 'ACTIVE' | 'TRIAL' | 'PAST_DUE' | 'UNPAID' | 'INACTIVE' | 'PENDING_CANCELLATION' | 'CANCELED'
- `currency` string
- `interval` 'day' | 'week' | 'month' | 'year'
- `merchantId` string
- `subscriptionOfferId` string
- `waitlistStatus` 'pending_waitlist' | 'approved' | 'failed_capture' | 'active' | 'declined'
- `includeAllWaitlistStatuses` boolean
- `page` number
- `limit` number

## Response `200`

- object
  - `data` ApiSubscriptionDto[]
    - `id` string, required — The unique identifier of the subscription
    - `name` string, required — The name of the subscription
    - `description` string, required — The description of the subscription
    - `amountInCents` number, required — The amount in cents for the subscription
    - `currency` string, required — The currency of the subscription
    - `interval` 'day' | 'week' | 'month' | 'year', required — The billing interval
    - `intervalCount` number, required — The billing interval count
    - `cycleCount` number — The cycle count
    - `trialPeriodDays` number, nullable — Trial period length in days. If present and >0, subscription is currently in free trial until creation date + trialPeriodDays.
    - `status` 'INITIATION' | 'ACTIVE' | 'TRIAL' | 'PAST_DUE' | 'UNPAID' | 'INACTIVE' | 'PENDING_CANCELLATION' | 'CANCELED', required — The status of the subscription
    - `userId` string, required — The user ID who owns the subscription
    - `subscriptionOfferId` string, nullable, required — The subscription offer ID
    - `metadatas` object — Optional custom metadata for the subscription
    - `successUrl` string, nullable — The success URL for subscription first payment
    - `cancelUrl` string, nullable — The cancel URL for subscription first payment
    - `unsubscribeToken` string, nullable — Token to unsubscribe from the subscription
    - `trialEndDate` string, date-time, nullable — Date of the end of the free trial period
    - `createdAt` string, date-time, required — The creation date
    - `updatedAt` string, date-time, required — The last update date
  - `meta` object
    - `total` number
    - `lastPage` number
    - `currentPage` number
    - `perPage` number
    - `prev` number
    - `next` number

## Other responses

- `401` — Unauthorized - Invalid API key

---

[API](https://skmtc.dev/inflowpay/apis/inflow-api.md) · [All operations](https://skmtc.dev/inflowpay/apis/inflow-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inflowpay/inflow-api/revisions/3012dd3dd14a/schema)