# GET /multiplans — List All Multiplans

> Product: **Pabbly Subscription Billing** (v1)
> Base URL: `https://payments.pabbly.com/api/v1`
> Auth: Basic via `Authorization` header
> Canonical: `/subscription-billing/multiplan/list-all-multiplans`

This API is used to retrieve a list of all the available multiplans.

**Query parameters:**

| Name | Type | Required | Description |
|------|------|----------|-------------|
| limit | string | No | Integer, default=10, min=1, max=100 The number of resources to be returned. |
| page | string | No | By default first page will be listed. For navigating through pages, use the page parameter. |
| product_id | string | No | Uniquely identifies the product. It is the api identifier for the product. |

**Response (200)** — List All Multiplans:

```json
{
    "status": "success",
    "message": "Multi plans",
    "data": [
        {
            "product_id": "5ff696ec57b2331ca3011f96",
            "multiplan_list": "radio",
            "page_title": "Checkout page",
            "preferred_plan_id": "60012f1553dc266105c2ca0c",
            "createdAt": "2021-06-18T13:04:54.345Z",
            "updatedAt": "2021-06-18T13:04:54.345Z",
            "id": "60cc99f6d7dcbf7e9acddab0",
            "plans": [
                {
                    "plan_active": "true",
                    "failed_payment_gateway": "",
                    "failed_payment_gateway_array": [],
                    "plan_type": "per_unit",
                    "setup_fee_type": "",
                    "trial_type": "day",
                    "createdAt": "2021-01-09T06:46:57.634Z",
                    "updatedAt": "2021-11-29T11:23:13.339Z",
                    "id": "5ff95161f863294e0d7df8e4",
                    "product_id": "5ff696ec57b2331ca3011f96",
                    "plan_name": "Test",
                    "plan_code": "test",
                    "price": 1000,
                    "billing_period": "",
                    "billing_period_num": "",
                    "billing_cycle": "onetime",
                    "billing_cycle_num": "",
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": ""
                },
                {
                    "plan_active": "true",
                    "failed_payment_gateway": "",
                    "failed_payment_gateway_array": [],
                    "plan_type": "per_unit",
                    "setup_fee_type": "",
                    "trial_type": "day",
                    "createdAt": "2021-01-15T05:58:45.035Z",
                    "updatedAt": "2022-02-01T10:39:20.309Z",
                    "id": "60012f1553dc266105c2ca0c",
                    "product_id": "5ff696ec57b2331ca3011f96",
                    "plan_name": "Lower PLan",
                    "plan_code": "lower-plan",
                    "price": 100,
                    "billing_period": "m",
                    "billing_period_num": "1",
                    "billing_cycle": "lifetime",
                    "billing_cycle_num": "",
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": "<ol><li>hellow</li><li>world</li></ol>"
                },
                {
                    "plan_active": "true",
                    "failed_payment_gateway": "",
                    "failed_payment_gateway_array": [],
                    "createdAt": "2021-01-15T05:58:17.366Z",
                    "updatedAt": "2021-06-08T05:35:50.275Z",
                    "id": "60012ef953dc266105c2ca0b",
                    "product_id": "5ff696ec57b2331ca3011f96",
                    "plan_name": "Higher Plan",
                    "plan_code": "higher-plan",
                    "price": 1000,
                    "billing_period": "m",
                    "billing_period_num": "1",
                    "billing_cycle": "lifetime",
                    "billing_cycle_num": "",
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": ""
                }
            ],
            "checkout_page": "https://payments.pabbly.com/checkout/60cc99f6d7dcbf7e9acddab0"
        },
        {
            "product_id": "600148ec53dc266105c2d567",
            "multiplan_list": "select",
            "page_title": "Multiplan Test",
            "createdAt": "2021-06-18T13:05:56.231Z",
            "updatedAt": "2022-02-18T06:32:00.483Z",
            "id": "60cc9a34d7dcbf7e9acddab4",
            "plans": [
                {
                    "plan_active": "true",
                    "createdAt": "2021-01-25T06:39:24.744Z",
                    "updatedAt": "2021-03-08T05:13:30.034Z",
                    "id": "600e679ce72183578f82f713",
                    "product_id": "600148ec53dc266105c2d567",
                    "plan_name": "renew test",
                    "plan_code": "renew-test",
                    "price": 20,
                    "billing_period": "m",
                    "billing_period_num": "1",
                    "billing_cycle": "lifetime",
                    "billing_cycle_num": "",
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": ""
                },
                {
                    "plan_active": "true",
                    "failed_payment_gateway": "",
                    "failed_payment_gateway_array": [],
                    "plan_type": "per_unit",
                    "setup_fee_type": "",
                    "trial_type": "day",
                    "createdAt": "2021-01-25T05:44:10.686Z",
                    "updatedAt": "2022-02-23T10:02:53.524Z",
                    "id": "600e5aaae72183578f82f665",
                    "product_id": "600148ec53dc266105c2d567",
                    "plan_name": "renew plan",
                    "plan_code": "renew-plan",
                    "price": 20,
                    "billing_period": "m",
                    "billing_period_num": "1",
                    "billing_cycle": "lifetime",
                    "billing_cycle_num": "",
                    "trial_period": 1,
                    "setup_fee": 0,
                    "plan_description": ""
                },
                {
                    "plan_active": "true",
                    "createdAt": "2021-01-15T08:00:36.502Z",
                    "updatedAt": "2021-01-15T08:00:36.502Z",
                    "id": "60014ba453dc266105c2d69f",
                    "product_id": "600148ec53dc266105c2d567",
                    "plan_name": "plan1",
                    "plan_code": "plan1",
                    "price": 10,
                    "billing_period": "",
                    "billing_period_num": "",
                    "billing_cycle": "onetime",
                    "billing_cycle_num": null,
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": ""
                }
            ],
            "checkout_page": "https://payments.pabbly.com/checkout/60cc9a34d7dcbf7e9acddab4"
        },
        {
            "product_id": "61a21b098c4b5732e5a3437d",
            "multiplan_list": "radio",
            "page_title": "Multiplan",
            "createdAt": "2022-05-12T11:11:01.224Z",
            "updatedAt": "2022-05-12T11:11:01.224Z",
            "id": "627ceb4584f5271bd9cf30c1",
            "plans": [
                {
                    "plan_type": "per_unit",
                    "plan_active": "true",
                    "failed_payment_gateway": "",
                    "failed_payment_gateway_array": [],
                    "setup_fee_type": "",
                    "trial_type": "day",
                    "createdAt": "2022-03-09T05:23:03.077Z",
                    "updatedAt": "2022-05-27T11:29:29.653Z",
                    "id": "622839b7afb3423000003b03",
                    "product_id": "61a21b098c4b5732e5a3437d",
                    "plan_name": "Test (Inclusive Tax)",
                    "plan_code": "test",
                    "price": 156,
                    "billing_period": "y",
                    "billing_period_num": "1",
                    "billing_cycle": "lifetime",
                    "billing_cycle_num": "",
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": "<p>This is the test plan description.</p><p><br></p><p><img src=\"https://s3-us-west-2.amazonaws.com/pabbly/product/images/2022/2/Y9fZRFgdHKIR-1643959680-PlandescriptionImage.png\"></p><p><br></p><p>From the checkout customizer,</p><p><br></p><ul><li>You can change the bullet type.</li><li>You can change list style.</li><li>You can change text size</li><li>You can change the bullet color.</li><li>Image size should be 400W x 250H, Max Size - 100kb.</li></ul>"
                },
                {
                    "plan_type": "flat_fee",
                    "plan_active": "true",
                    "createdAt": "2022-01-13T05:59:04.929Z",
                    "updatedAt": "2022-01-13T05:59:04.929Z",
                    "id": "61dfbfa8fa581f51d7549b37",
                    "product_id": "61a21b098c4b5732e5a3437d",
                    "plan_name": "Euro",
                    "plan_code": "euro",
                    "price": 1,
                    "billing_period": "",
                    "billing_period_num": "",
                    "billing_cycle": "onetime",
                    "billing_cycle_num": null,
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": "<p>This is the test plan description.</p><p><br></p><p><img src=\"https://s3-us-west-2.amazonaws.com/pabbly/product/images/2022/1/vALD37H8p2Da-1641474041-chair.png\"></p><p><br></p><p>From the checkout customizer,</p><p><br></p><ul><li>You can change the bullet type.</li><li>You can change list style.</li><li>You can change text size</li><li>You can change the bullet color.</li></ul><p><br></p>"
                },
                {
                    "plan_type": "donation",
                    "plan_active": "true",
                    "failed_payment_gateway": "",
                    "failed_payment_gateway_array": [],
                    "setup_fee_type": "",
                    "trial_type": "day",
                    "createdAt": "2021-12-10T12:24:23.935Z",
                    "updatedAt": "2022-05-04T13:10:32.903Z",
                    "id": "61b346f7e5dc2f756b928943",
                    "product_id": "61a21b098c4b5732e5a3437d",
                    "plan_name": "custom field test",
                    "plan_code": "custom-field-test",
                    "price": 10,
                    "billing_period": "",
                    "billing_period_num": "",
                    "billing_cycle": "onetime",
                    "billing_cycle_num": "",
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": ""
                },
                {
                    "plan_type": "per_unit",
                    "plan_active": "true",
                    "failed_payment_gateway": "",
                    "failed_payment_gateway_array": [],
                    "setup_fee_type": "",
                    "trial_type": "day",
                    "createdAt": "2021-11-27T11:48:46.257Z",
                    "updatedAt": "2022-05-27T11:32:50.477Z",
                    "id": "61a21b1e8c4b5732e5a3437e",
                    "product_id": "61a21b098c4b5732e5a3437d",
                    "plan_name": "update",
                    "plan_code": "testing-plan-",
                    "price": 264,
                    "billing_period": "y",
                    "billing_period_num": "2",
                    "billing_cycle": "lifetime",
                    "billing_cycle_num": "",
                    "trial_period": 0,
                    "setup_fee": 0,
                    "plan_description": ""
                }
            ],
            "checkout_page": "https://payments.pabbly.com/checkout/627ceb4584f5271bd9cf30c1"
        }
    ]
}
```

**Code examples:**

_cURL_

```curl
curl https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}
```

_Ruby_

```ruby
require 'net/http'
require 'json'

uri = URI('https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}}')
request = Net::HTTP::Get.new(uri)
request.basic_auth '{{YOUR_API_KEY}}', '{{YOUR_SECRET_KEY}}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

data = JSON.parse(response.body)
```

_Python_

```python
import requests
from requests.auth import HTTPBasicAuth

response = requests.get(
    'https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}}',
    auth=HTTPBasicAuth('{{YOUR_API_KEY}}', '{{YOUR_SECRET_KEY}}'),
)

data = response.json()
```

_PHP_

```php
<?php
$ch = curl_init('https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, '{{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}');

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
```

_Java_

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

String credentials = Base64.getEncoder().encodeToString("{{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}".getBytes());

HttpClient client = HttpClient.newHttpClient();
HttpRequest.Builder builder = HttpRequest.newBuilder()
    .uri(URI.create("https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}}"))
    .header("Authorization", "Basic " + credentials)
    .GET();

HttpRequest request = builder.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

_Node.js_

```node
const credentials = Buffer.from('{{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}').toString('base64');

const response = await fetch('https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}}', {
  method: 'GET',
  headers: {
    'Authorization': `Basic ${credentials}`,
  },
});

const data = await response.json();
```

_Go_

```go
package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}}", nil)
    req.SetBasicAuth("{{YOUR_API_KEY}}", "{{YOUR_SECRET_KEY}}")

    res, _ := http.DefaultClient.Do(req)
    defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)
    fmt.Println(string(body))
}
```

_.NET_

```dotnet
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

var credentials = Convert.ToBase64String(Encoding.ASCII.GetBytes("{{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}"));

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://payments.pabbly.com/api/v1/multiplans?limit={{limit}}&page={{page}}&product_id={{product_id}}");
request.Headers.TryAddWithoutValidation("Authorization", $"Basic {credentials}");

var response = await client.SendAsync(request);
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);
```

---

**Other endpoints in Multiplan:**

- [GET /multiplans/{{multiplan_id}} — Get Multiplan Details](/subscription-billing/multiplan/get-multiplan-details)
- [POST /multiplans — Create Multiplan](/subscription-billing/multiplan/create-multiplan)
- [PUT /multiplans/{{id}} — Update Multiplan](/subscription-billing/multiplan/update-multiplan)
- [DELETE /multiplans/{{id}} — Delete Multiplan](/subscription-billing/multiplan/delete-multiplan)