---
title: "Search Plans"
method: GET
path: "/client/plans/v1/search"
---

# Search Plans

`GET /client/plans/v1/search`

## Request

- Base URL: `https://api.sandbox.safepay.com`
- URL: `https://api.sandbox.safepay.com/client/plans/v1/search`
- Auth: none declared
- TypeScript: <https://skmtc.dev/draco1js/apis/safepay/docs/client/plans/v1/search/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `plan_ids` string
- `intervals` string
- `products` string
- `currencies` string
- `limit` string
- `page` string
- `sort_by` string
- `direction` string

## Response `200`

200

- object
  - `data` object
    - `plans` object[]
      - `token` string
      - `merchant_api_key` string
      - `name` string
      - `amount` string, color
      - `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, color
    - `count` integer
    - `sort_by` string
    - `direction` string
  - `status` Status
    - `errors` unknown[]
      - unknown
    - `message` string

## Other responses

- `400`: 400
- `401`: 401

---

[API](https://skmtc.dev/draco1js/apis/safepay.md) - [All operations](https://skmtc.dev/draco1js/apis/safepay/llms.txt) - [OpenAPI document](https://skmtc.dev/draco1js/apis/safepay/revisions/e3227ddbe82a?raw)