---
title: "Get Plan"
method: GET
path: "/api/subscription/plan/{orderRef}"
tags: ["Plan APIs"]
---

# Get Plan

`GET /api/subscription/plan/{orderRef}`

Use this API for fetching Plan.

## Path parameters

- `orderRef` string, required

## Headers

- `Content-Type` string
- `X-Portone-Client-Key` string
- `Authorization` string

## Response `200`

Successful response

- object
  - `content` PlanContent — The meta details of the plan
    - `amount` number, double — The amount of the plan, can be a floating-point number
    - `portone_key` string — The unique PortOne key for merchant
    - `currency` string — The currency of the plan
    - `description` string — The description of the plan
    - `environment` string — The environment of plan either live OR sandbox
    - `frequency` integer — The frequency of the plan (must be greater than 0)
    - `name` string — The name of the plan
    - `merchant_order_ref` string — The unique merchant order reference generated by the merchant
    - `notes` object[] — Additional Notes
      - `key` string — Title
      - `value` string — Description
    - `plan_type` string — The type of plan
    - `order_ref` string — The unique Order reference generated by PortOne
    - `period` string — The period of the plan
    - `is_active` boolean — The boolean flag denoting active status of Plan
  - `status_code` string — The status_code for API request execution result
  - `status_reason` string — The status_reason for API request execution result

## Other responses

- `400` — Failure response

---

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