---
title: "Search Subscriptions"
method: GET
path: "/client/subscriptions/v1/search"
---

# Search Subscriptions

`GET /client/subscriptions/v1/search`

## Query parameters

- `tokens` string
- `plan_ids` string
- `user_ids` string
- `statuses` string
- `limit` string
- `page` string
- `sort_by` string
- `direction` string

## Response `200`

200

- object
  - `data` object
    - `subscriptions` object[]
      - `token` string
      - `plan_id` string
      - `user_id` string
      - `instrument_id` string
      - `status` string
      - `billing_cycle_anchor` string, date-time
      - `price_amount` string, utc-millisec
      - `price_currency` string
      - `balance` string, utc-millisec
      - `start_date` string, date-time
      - `trial_start_date` string, date-time
      - `trial_end_date` string, date-time
      - `cancel_at_period_end` boolean
      - `canceled_at` string, date-time
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `plan` object
        - `token` string
        - `merchant_api_key` string
        - `name` string
        - `amount` string, utc-millisec
        - `currency` string
        - `interval_count` integer
        - `interval` string
        - `product` string
        - `type` string
        - `trial_period_days` integer
        - `description` string
        - `created_at` string, date-time
        - `updated_at` string, date-time
        - `active` boolean
        - `archived` boolean
        - `number_of_billing_cycles` integer
        - `apply_amount_change_on_existing_subscriptions` boolean
        - `price_money` object
          - `currency` string
          - `amount` string, utc-millisec
      - `current_period_start_date` string, date-time
      - `current_period_end_date` string, date-time
      - `never_expires` boolean
      - `number_of_billing_cycles` integer
      - `merchant_api_key` string
      - `price_money` object
        - `currency` string
        - `amount` string, utc-millisec
    - `count` string, utc-millisec
    - `direction` string
    - `sort_by` string
  - `status` Status
    - `errors` unknown[]
      - unknown
    - `message` string

## Other responses

- `401` — 401

---

[API](https://skmtc.net/draco1js/apis/safepay.md) · [All operations](https://skmtc.net/draco1js/apis/safepay/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/draco1js/safepay/versions/e3227ddbe82a/schema)