---
title: "List validated subscriptions"
method: GET
path: "/v2/console/subscription"
tags: ["Console"]
---

# List validated subscriptions

`GET /v2/console/subscription`

## Request

- Base URL: `http://127.0.0.1:7351`
- URL: `http://127.0.0.1:7351/v2/console/subscription`
- Auth: API key in header `Authorization`

## Query parameters

- `user_id` string
- `limit` integer
- `cursor` string
- `after` string, date-time
- `before` string, date-time
- `filter` string

## Response `200`

A successful response.

- SubscriptionList: A list of validated subscriptions stored by Nakama.
  - `validated_subscriptions` ValidatedSubscription[]: Stored validated subscriptions.
    - `user_id` string: Subscription User ID.
    - `product_id` string: Purchase Product ID.
    - `original_transaction_id` string: Purchase Original transaction ID (we only keep track of the original subscription, not subsequent renewals).
    - `store` 'APPLE_APP_STORE' | 'GOOGLE_PLAY_STORE' | 'HUAWEI_APP_GALLERY' | 'FACEBOOK_INSTANT_STORE' | 'SAMSUNG_GALAXY_STORE': - APPLE_APP_STORE: Apple App Store - GOOGLE_PLAY_STORE: Google Play Store - HUAWEI_APP_GALLERY: Huawei App Gallery - FACEBOOK_INSTANT_STORE: Facebook Instant Store - SAMSUNG_GALAXY_STORE: Samsung Galaxy Store
    - `purchase_time` string, date-time: UNIX Timestamp when the purchase was done.
    - `create_time` string, date-time: UNIX Timestamp when the receipt validation was stored in DB.
    - `update_time` string, date-time: UNIX Timestamp when the receipt validation was updated in DB.
    - `environment` 'UNKNOWN' | 'SANDBOX' | 'PRODUCTION': - UNKNOWN: Unknown environment. - SANDBOX: Sandbox/test environment. - PRODUCTION: Production environment.
    - `expiry_time` string, date-time: Subscription expiration time. The subscription can still be auto-renewed to extend the expiration time further.
    - `refund_time` string, date-time: Subscription refund time. If this time is set, the subscription was refunded.
    - `provider_response` string: Raw provider validation response body.
    - `provider_notification` string: Raw provider notification body.
    - `active` boolean: Whether the subscription is currently active or not.
  - `cursor` string: The cursor to send when retrieving the next page, if any.
  - `prev_cursor` string: The cursor to send when retrieving the previous page, if any.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2.md) - [All operations](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/revisions/fbde2e3c5ead?raw)