Fetch All Plans

GET /v1/plans

Use this endpoint to fetch details of all plans.

Request

Curl

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

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject params = new JSONObject();
params.put("count","1");

List plans =  razorpay.plans.fetchAll(params);

```php: PHP
$api = new Api($key_id, $secret);

$api->plan->all($options);

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.plans.all(options)

```python: Python
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.plan.all(options)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

options = {"count": 2}

Razorpay::Plan.all(options)

```go: Go
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

options:= map[string]interface{}{
  "count": 1,
  "skip": 1,
}
body, err := client.Plan.All(options, nil)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

Dictionary paramRequest = new Dictionary();
paramRequest.Add("count","1");

List plan = client.Plan.All(paramRequest);

Response

Success

{
  "entity":"collection",
  "count":2,
  "items":[
    {
      "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
    },
    {
      "id":"plan_00000000000002",
      "entity":"plan",
      "interval":1,
      "period":"monthly",
      "item":{
        "id":"item_00000000000002",
        "active":true,
        "name":"Test plan - Monthly",
        "description":null,
        "amount":79900,
        "unit_amount":79900,
        "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":1580220483,
        "updated_at":1580220483
      },
      "notes":[],
      "created_at":1580220483
    }
  ]
}
```json: Failure
{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

Parameters

from optional : integer The Unix timestamp from when plans are to be fetched.

to optional : integer The Unix timestamp till when plans are to be fetched.

count optional : integer The number of plans to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination in combination with skip.

skip optional : integer The number of plans to be skipped. Default value is 0. This can be used for pagination in combination with count.

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

The API key/secret provided is invalid.

• code: 4xx
• description: This error occurs due to a mismatch between the API credentials passed in the API call and those generated on the Dashboard.
• solution: Ensure that the API keys are active and correctly entered, with no whitespaces before or after the keys.