---
title: "List plans"
method: GET
path: "/billing/plans"
---

# List plans

`GET /billing/plans`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/plans`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

The get list PLANs allow integrators to retrieve all PLANs created for the merchant. PLANs are used as a package option for pricing tiers to accommodate all merchants products and services. 

PLANs cannot be deleted and will be filtered from the latest to the oldest created.
All PLANs listed will be associated to a Merchant.

## Query parameters

- `limit` integer
- `cursor` integer
- `name` string
- `status` string

## Headers

- `merchant` string, required

## Response `200`

200

- object
  - `data` object[]
    - `id` string
    - `status` string
    - `name` string
    - `memo` unknown
    - `accountingCode` string
    - `amount` object
      - `currency` string
      - `value` integer
      - `type` unknown
    - `tax` object
      - `rate` integer
    - `setupPayments` unknown
    - `intervalUnit` string
    - `interval` integer
    - `billingStart` string
    - `billingStartValue` string
    - `billingEnd` string
    - `billingEndValue` unknown
    - `firstBilling` string
    - `recurringBillingDay` unknown
    - `failedPaymentHandling` object
      - `initialAction` string
      - `autoRetry` boolean
      - `retryInDays` integer
      - `maximumFailedAttempts` integer
    - `metadata` unknown
    - `createdOn` string
  - `paging` object
    - `nextUrl` unknown
    - `nextCursor` integer
    - `limit` integer
    - `totalCount` integer

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/plans/get.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)