Fetch a Plan With ID

Fetch a plan using the unique identifier

GET /v1/plans/:id

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/plans/plan_00000000000001 \

Success

{
  "id":"plan_00000000000001",
  "entity":"plan",
  "interval":1,
  "period":"weekly",
  "item":{
    "id":"item_00000000000001",
    "active":true,
    "name":"Test plan - Weekly",
    "description":"Description for the test plan - Weekly",
    "amount":69900,
    "unit_amount":69900,
    "currency":"INR",
    "type":"plan",
    "unit":null,
    "tax_inclusive":false,
    "hsn_code":null,
    "sac_code":null,
    "tax_rate":null,
    "tax_id":null,
    "tax_group_id":null,
    "created_at":1580220492,
    "updated_at":1580220492
  },
  "notes":{
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  },
  "created_at":1580220492
}

Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States

Use this endpoint to retrieve the details of a plan using its unique identifier.

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/plans/plan_00000000000001 \

Success

{
  "id":"plan_00000000000001",
  "entity":"plan",
  "interval":1,
  "period":"weekly",
  "item":{
    "id":"item_00000000000001",
    "active":true,
    "name":"Test plan - Weekly",
    "description":"Description for the test plan - Weekly",
    "amount":69900,
    "unit_amount":69900,
    "currency":"INR",
    "type":"plan",
    "unit":null,
    "tax_inclusive":false,
    "hsn_code":null,
    "sac_code":null,
    "tax_rate":null,
    "tax_id":null,
    "tax_group_id":null,
    "created_at":1580220492,
    "updated_at":1580220492
  },
  "notes":{
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  },
  "created_at":1580220492
}

Path Parameters

id · string · required

The unique identifier of the plan. For example, plan_00000000000001.

Response Parameters

id · string

The unique identifier linked to a plan. For example, plan_00000000000001. This ID is used when creating a subscription for a customer.

entity · string

The entity being created. Here, it is plan.

interval · integer

Used together with period to define how often the customer should be charged.

period · string

Used together with interval to define how often the customer should be charged. Possible values:

• daily
• weekly
• monthly
• yearly

item · array

Details of the plan.

id · string

The unique identifier linked to an item. For example, item_00000000000001.

name · string

Name of the plan. For example, Test Plan.

amount · integer

Amount for the plan. When you use this plan to create a subscription, the customer will be charged this amount periodically.

currency · string

Currency for the payment. You can accept payment in any of the supported currencies.

description · string

Description for the plan. For example, Description for the test plan.

notes · object

Notes you can enter of the contact for future reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Monthly Gym".

created_at · integer

The Unix timestamp at which the plan was created.

Errors

an_id%7D is not a valid id

Code: 400

This error occurs when you are not passing the plan_id in the API endpoint to fetch a plan based on the id.

Solution: Ensure that you are passing the plan_id in the API endpoint.
For example, https://api.razorpay.com/v1/plans/plan_K8lVuxetc2OGR8.

The API key/secret provided is invalid.

Code: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution: The API keys must be active and entered correctly with no whitespace before or after.

The ID provided is invalid or could not be found.

Code: 400

The plan_id passed in the URL is well-formed but does not exist or does not belong to the requesting merchant.

Solution: Use a valid plan_id returned from POST /v1/plans. Confirm by fetching the plans list before retrying.