Skip to main content
GET
/
v1
/
sdk
/
products
/
{productRef}
/
plans
List plans for a product
curl --request GET \
  --url https://api.example.com/v1/sdk/products/{productRef}/plans
import requests

url = "https://api.example.com/v1/sdk/products/{productRef}/plans"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v1/sdk/products/{productRef}/plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/sdk/products/{productRef}/plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.example.com/v1/sdk/products/{productRef}/plans"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v1/sdk/products/{productRef}/plans")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/sdk/products/{productRef}/plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "limit": 123,
  "offset": 123,
  "plans": [
    {
      "createdAt": "<string>",
      "currency": "USD",
      "isActive": true,
      "price": 2999,
      "reference": "pln_1A2B3C4D",
      "requiresPayment": true,
      "status": "active",
      "type": "recurring",
      "updatedAt": "<string>",
      "accessExpiryDays": 123,
      "billingCycle": "monthly",
      "billingModel": "pre-paid",
      "creditsPerUnit": 1,
      "currencySymbol": "$",
      "description": "Best for teams getting started",
      "features": {},
      "freeUnits": 100,
      "limit": 10000,
      "limits": {},
      "maxActiveUsers": 123,
      "measures": "requests",
      "meterRef": "mtr_1A2B3C4D",
      "name": "Starter",
      "rolloverUnusedUnits": false,
      "setupFee": 500,
      "trialDays": 14
    }
  ],
  "total": 123
}

Path Parameters

productRef
string
required

Product reference or ID

Query Parameters

limit
number
offset
number

Response

Plans retrieved successfully

limit
number
offset
number
plans
object[]
total
number

Total number of plans for the product