---
title: "Retrieve a plan"
method: GET
path: "/billing/plans/{planId}"
---

# Retrieve a plan

`GET /billing/plans/{planId}`

## Request

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

Integrators has the flexibility to retrieve a specific plan using the retrieve plan API. The full details  of that specific plan will be return using this API endpoint.

## Path parameters

- `planId` string, required

## Headers

- `merchant` string, required

## Response `200`

200

- 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

## Other responses

- `400`: 400

## Changes

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

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/plans/:planId/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)