GET
/
plans
/
{plan_id}

Authorizations

x-client-id
string
headerrequired

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

x-client-secret
string
headerrequired

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

Headers

x-api-version
string
default: 2023-08-01required

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

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

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 PlanId for which the details have to be fetched.

Response

200 - application/json

The response returned for Get, Create and Manage Plan APIs

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

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

Recurring amount for the plan.

plan_status
string

Status of the plan.

plan_type
string

Type of the plan.