Skip to main content
GET
/
plans
/
{plan_id}
Fetch Plan
curl --request GET \
  --url https://sandbox.cashfree.com/pg/plans/{plan_id} \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "plan_currency": "INR",
  "plan_id": "144436-03471-JD_TEST",
  "plan_interval_type": "WEEK",
  "plan_intervals": 1,
  "plan_max_amount": 1,
  "plan_max_cycles": 4,
  "plan_name": "abscede",
  "plan_note": "lsdkdn",
  "plan_recurring_amount": 1,
  "plan_status": "ACTIVE",
  "plan_type": "PERIODIC"
}

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD. API version to be used

​
x-request-id
string

Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

​
x-idempotency-key
string<UUID>

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

​
plan_id
string
required

Provide the plan ID for which the details have to be fetched.

Response

Success response for fetching a plan.

​
plan_currency
string

Currency for the plan.

​
plan_id
string

Plan ID provided by merchant.

​
plan_interval_type
string

Interval type for the plan.

​
plan_intervals
integer

Number of intervals for the plan.

​
plan_max_amount
number<float64>

Maximum amount for the plan.

​
plan_max_cycles
integer

Maximum number of payment cycles for the plan.

​
plan_name
string

Name of the plan.

​
plan_note
string

Note for the plan.

​
plan_recurring_amount
number<float64>

Recurring amount for the plan.

​
plan_status
string

Status of the plan.

​
plan_type
string

Type of the plan.