Create a plan for a product

curl --request POST \
  --url https://api.example.com/v1/sdk/products/{productRef}/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingStrategy": {
    "type": "<string>"
  },
  "features": {},
  "fulfillment": {
    "deliveryMethod": "<string>",
    "estimatedDelivery": "<string>",
    "type": "<string>"
  },
  "limits": {},
  "metadata": {},
  "name": "<string>",
  "overagePolicy": {
    "allowOverage": true,
    "maxOverage": 123
  },
  "prorationPolicy": {
    "enabled": true
  },
  "returnPolicy": {
    "allowed": true,
    "conditions": "<string>",
    "period": 123
  },
  "usageTracking": {},
  "warranty": {
    "duration": 123,
    "terms": "<string>",
    "unit": "<string>"
  },
  "accessExpiryDays": 1,
  "autoRenew": true,
  "basePrice": 1,
  "cancellationNoticeDays": 1,
  "creditsPerUnit": 2,
  "currency": "<string>",
  "default": true,
  "description": "<string>",
  "freeUnits": 1,
  "hidden": true,
  "limit": 1,
  "maxActiveUsers": 1,
  "price": 5000000,
  "pricingOptions": [
    {
      "currency": "<string>",
      "price": 1,
      "basePrice": 1,
      "default": true,
      "setupFee": 1
    }
  ],
  "rolloverUnusedUnits": true,
  "setupFee": 1,
  "trialDays": 1
}
'

import requests

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

payload = {
    "billingStrategy": { "type": "<string>" },
    "features": {},
    "fulfillment": {
        "deliveryMethod": "<string>",
        "estimatedDelivery": "<string>",
        "type": "<string>"
    },
    "limits": {},
    "metadata": {},
    "name": "<string>",
    "overagePolicy": {
        "allowOverage": True,
        "maxOverage": 123
    },
    "prorationPolicy": { "enabled": True },
    "returnPolicy": {
        "allowed": True,
        "conditions": "<string>",
        "period": 123
    },
    "usageTracking": {},
    "warranty": {
        "duration": 123,
        "terms": "<string>",
        "unit": "<string>"
    },
    "accessExpiryDays": 1,
    "autoRenew": True,
    "basePrice": 1,
    "cancellationNoticeDays": 1,
    "creditsPerUnit": 2,
    "currency": "<string>",
    "default": True,
    "description": "<string>",
    "freeUnits": 1,
    "hidden": True,
    "limit": 1,
    "maxActiveUsers": 1,
    "price": 5000000,
    "pricingOptions": [
        {
            "currency": "<string>",
            "price": 1,
            "basePrice": 1,
            "default": True,
            "setupFee": 1
        }
    ],
    "rolloverUnusedUnits": True,
    "setupFee": 1,
    "trialDays": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billingStrategy: {type: '<string>'},
    features: {},
    fulfillment: {deliveryMethod: '<string>', estimatedDelivery: '<string>', type: '<string>'},
    limits: {},
    metadata: {},
    name: '<string>',
    overagePolicy: {allowOverage: true, maxOverage: 123},
    prorationPolicy: {enabled: true},
    returnPolicy: {allowed: true, conditions: '<string>', period: 123},
    usageTracking: {},
    warranty: {duration: 123, terms: '<string>', unit: '<string>'},
    accessExpiryDays: 1,
    autoRenew: true,
    basePrice: 1,
    cancellationNoticeDays: 1,
    creditsPerUnit: 2,
    currency: '<string>',
    default: true,
    description: '<string>',
    freeUnits: 1,
    hidden: true,
    limit: 1,
    maxActiveUsers: 1,
    price: 5000000,
    pricingOptions: [{currency: '<string>', price: 1, basePrice: 1, default: true, setupFee: 1}],
    rolloverUnusedUnits: true,
    setupFee: 1,
    trialDays: 1
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billingStrategy' => [
        'type' => '<string>'
    ],
    'features' => [
        
    ],
    'fulfillment' => [
        'deliveryMethod' => '<string>',
        'estimatedDelivery' => '<string>',
        'type' => '<string>'
    ],
    'limits' => [
        
    ],
    'metadata' => [
        
    ],
    'name' => '<string>',
    'overagePolicy' => [
        'allowOverage' => true,
        'maxOverage' => 123
    ],
    'prorationPolicy' => [
        'enabled' => true
    ],
    'returnPolicy' => [
        'allowed' => true,
        'conditions' => '<string>',
        'period' => 123
    ],
    'usageTracking' => [
        
    ],
    'warranty' => [
        'duration' => 123,
        'terms' => '<string>',
        'unit' => '<string>'
    ],
    'accessExpiryDays' => 1,
    'autoRenew' => true,
    'basePrice' => 1,
    'cancellationNoticeDays' => 1,
    'creditsPerUnit' => 2,
    'currency' => '<string>',
    'default' => true,
    'description' => '<string>',
    'freeUnits' => 1,
    'hidden' => true,
    'limit' => 1,
    'maxActiveUsers' => 1,
    'price' => 5000000,
    'pricingOptions' => [
        [
                'currency' => '<string>',
                'price' => 1,
                'basePrice' => 1,
                'default' => true,
                'setupFee' => 1
        ]
    ],
    'rolloverUnusedUnits' => true,
    'setupFee' => 1,
    'trialDays' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"billingStrategy\": {\n    \"type\": \"<string>\"\n  },\n  \"features\": {},\n  \"fulfillment\": {\n    \"deliveryMethod\": \"<string>\",\n    \"estimatedDelivery\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"limits\": {},\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"overagePolicy\": {\n    \"allowOverage\": true,\n    \"maxOverage\": 123\n  },\n  \"prorationPolicy\": {\n    \"enabled\": true\n  },\n  \"returnPolicy\": {\n    \"allowed\": true,\n    \"conditions\": \"<string>\",\n    \"period\": 123\n  },\n  \"usageTracking\": {},\n  \"warranty\": {\n    \"duration\": 123,\n    \"terms\": \"<string>\",\n    \"unit\": \"<string>\"\n  },\n  \"accessExpiryDays\": 1,\n  \"autoRenew\": true,\n  \"basePrice\": 1,\n  \"cancellationNoticeDays\": 1,\n  \"creditsPerUnit\": 2,\n  \"currency\": \"<string>\",\n  \"default\": true,\n  \"description\": \"<string>\",\n  \"freeUnits\": 1,\n  \"hidden\": true,\n  \"limit\": 1,\n  \"maxActiveUsers\": 1,\n  \"price\": 5000000,\n  \"pricingOptions\": [\n    {\n      \"currency\": \"<string>\",\n      \"price\": 1,\n      \"basePrice\": 1,\n      \"default\": true,\n      \"setupFee\": 1\n    }\n  ],\n  \"rolloverUnusedUnits\": true,\n  \"setupFee\": 1,\n  \"trialDays\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/sdk/products/{productRef}/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingStrategy\": {\n    \"type\": \"<string>\"\n  },\n  \"features\": {},\n  \"fulfillment\": {\n    \"deliveryMethod\": \"<string>\",\n    \"estimatedDelivery\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"limits\": {},\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"overagePolicy\": {\n    \"allowOverage\": true,\n    \"maxOverage\": 123\n  },\n  \"prorationPolicy\": {\n    \"enabled\": true\n  },\n  \"returnPolicy\": {\n    \"allowed\": true,\n    \"conditions\": \"<string>\",\n    \"period\": 123\n  },\n  \"usageTracking\": {},\n  \"warranty\": {\n    \"duration\": 123,\n    \"terms\": \"<string>\",\n    \"unit\": \"<string>\"\n  },\n  \"accessExpiryDays\": 1,\n  \"autoRenew\": true,\n  \"basePrice\": 1,\n  \"cancellationNoticeDays\": 1,\n  \"creditsPerUnit\": 2,\n  \"currency\": \"<string>\",\n  \"default\": true,\n  \"description\": \"<string>\",\n  \"freeUnits\": 1,\n  \"hidden\": true,\n  \"limit\": 1,\n  \"maxActiveUsers\": 1,\n  \"price\": 5000000,\n  \"pricingOptions\": [\n    {\n      \"currency\": \"<string>\",\n      \"price\": 1,\n      \"basePrice\": 1,\n      \"default\": true,\n      \"setupFee\": 1\n    }\n  ],\n  \"rolloverUnusedUnits\": true,\n  \"setupFee\": 1,\n  \"trialDays\": 1\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billingStrategy\": {\n    \"type\": \"<string>\"\n  },\n  \"features\": {},\n  \"fulfillment\": {\n    \"deliveryMethod\": \"<string>\",\n    \"estimatedDelivery\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"limits\": {},\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"overagePolicy\": {\n    \"allowOverage\": true,\n    \"maxOverage\": 123\n  },\n  \"prorationPolicy\": {\n    \"enabled\": true\n  },\n  \"returnPolicy\": {\n    \"allowed\": true,\n    \"conditions\": \"<string>\",\n    \"period\": 123\n  },\n  \"usageTracking\": {},\n  \"warranty\": {\n    \"duration\": 123,\n    \"terms\": \"<string>\",\n    \"unit\": \"<string>\"\n  },\n  \"accessExpiryDays\": 1,\n  \"autoRenew\": true,\n  \"basePrice\": 1,\n  \"cancellationNoticeDays\": 1,\n  \"creditsPerUnit\": 2,\n  \"currency\": \"<string>\",\n  \"default\": true,\n  \"description\": \"<string>\",\n  \"freeUnits\": 1,\n  \"hidden\": true,\n  \"limit\": 1,\n  \"maxActiveUsers\": 1,\n  \"price\": 5000000,\n  \"pricingOptions\": [\n    {\n      \"currency\": \"<string>\",\n      \"price\": 1,\n      \"basePrice\": 1,\n      \"default\": true,\n      \"setupFee\": 1\n    }\n  ],\n  \"rolloverUnusedUnits\": true,\n  \"setupFee\": 1,\n  \"trialDays\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "<string>",
  "currency": "USD",
  "hidden": false,
  "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",
  "pricingOptions": [
    {
      "currency": "USD",
      "price": 2999,
      "basePrice": 1999,
      "default": true,
      "setupFee": 500
    }
  ],
  "rolloverUnusedUnits": false,
  "setupFee": 500,
  "trialDays": 14
}

POST

sdk

products

{productRef}

plans

Create a plan for a product

curl --request POST \
  --url https://api.example.com/v1/sdk/products/{productRef}/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingStrategy": {
    "type": "<string>"
  },
  "features": {},
  "fulfillment": {
    "deliveryMethod": "<string>",
    "estimatedDelivery": "<string>",
    "type": "<string>"
  },
  "limits": {},
  "metadata": {},
  "name": "<string>",
  "overagePolicy": {
    "allowOverage": true,
    "maxOverage": 123
  },
  "prorationPolicy": {
    "enabled": true
  },
  "returnPolicy": {
    "allowed": true,
    "conditions": "<string>",
    "period": 123
  },
  "usageTracking": {},
  "warranty": {
    "duration": 123,
    "terms": "<string>",
    "unit": "<string>"
  },
  "accessExpiryDays": 1,
  "autoRenew": true,
  "basePrice": 1,
  "cancellationNoticeDays": 1,
  "creditsPerUnit": 2,
  "currency": "<string>",
  "default": true,
  "description": "<string>",
  "freeUnits": 1,
  "hidden": true,
  "limit": 1,
  "maxActiveUsers": 1,
  "price": 5000000,
  "pricingOptions": [
    {
      "currency": "<string>",
      "price": 1,
      "basePrice": 1,
      "default": true,
      "setupFee": 1
    }
  ],
  "rolloverUnusedUnits": true,
  "setupFee": 1,
  "trialDays": 1
}
'

import requests

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

payload = {
    "billingStrategy": { "type": "<string>" },
    "features": {},
    "fulfillment": {
        "deliveryMethod": "<string>",
        "estimatedDelivery": "<string>",
        "type": "<string>"
    },
    "limits": {},
    "metadata": {},
    "name": "<string>",
    "overagePolicy": {
        "allowOverage": True,
        "maxOverage": 123
    },
    "prorationPolicy": { "enabled": True },
    "returnPolicy": {
        "allowed": True,
        "conditions": "<string>",
        "period": 123
    },
    "usageTracking": {},
    "warranty": {
        "duration": 123,
        "terms": "<string>",
        "unit": "<string>"
    },
    "accessExpiryDays": 1,
    "autoRenew": True,
    "basePrice": 1,
    "cancellationNoticeDays": 1,
    "creditsPerUnit": 2,
    "currency": "<string>",
    "default": True,
    "description": "<string>",
    "freeUnits": 1,
    "hidden": True,
    "limit": 1,
    "maxActiveUsers": 1,
    "price": 5000000,
    "pricingOptions": [
        {
            "currency": "<string>",
            "price": 1,
            "basePrice": 1,
            "default": True,
            "setupFee": 1
        }
    ],
    "rolloverUnusedUnits": True,
    "setupFee": 1,
    "trialDays": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billingStrategy: {type: '<string>'},
    features: {},
    fulfillment: {deliveryMethod: '<string>', estimatedDelivery: '<string>', type: '<string>'},
    limits: {},
    metadata: {},
    name: '<string>',
    overagePolicy: {allowOverage: true, maxOverage: 123},
    prorationPolicy: {enabled: true},
    returnPolicy: {allowed: true, conditions: '<string>', period: 123},
    usageTracking: {},
    warranty: {duration: 123, terms: '<string>', unit: '<string>'},
    accessExpiryDays: 1,
    autoRenew: true,
    basePrice: 1,
    cancellationNoticeDays: 1,
    creditsPerUnit: 2,
    currency: '<string>',
    default: true,
    description: '<string>',
    freeUnits: 1,
    hidden: true,
    limit: 1,
    maxActiveUsers: 1,
    price: 5000000,
    pricingOptions: [{currency: '<string>', price: 1, basePrice: 1, default: true, setupFee: 1}],
    rolloverUnusedUnits: true,
    setupFee: 1,
    trialDays: 1
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billingStrategy' => [
        'type' => '<string>'
    ],
    'features' => [
        
    ],
    'fulfillment' => [
        'deliveryMethod' => '<string>',
        'estimatedDelivery' => '<string>',
        'type' => '<string>'
    ],
    'limits' => [
        
    ],
    'metadata' => [
        
    ],
    'name' => '<string>',
    'overagePolicy' => [
        'allowOverage' => true,
        'maxOverage' => 123
    ],
    'prorationPolicy' => [
        'enabled' => true
    ],
    'returnPolicy' => [
        'allowed' => true,
        'conditions' => '<string>',
        'period' => 123
    ],
    'usageTracking' => [
        
    ],
    'warranty' => [
        'duration' => 123,
        'terms' => '<string>',
        'unit' => '<string>'
    ],
    'accessExpiryDays' => 1,
    'autoRenew' => true,
    'basePrice' => 1,
    'cancellationNoticeDays' => 1,
    'creditsPerUnit' => 2,
    'currency' => '<string>',
    'default' => true,
    'description' => '<string>',
    'freeUnits' => 1,
    'hidden' => true,
    'limit' => 1,
    'maxActiveUsers' => 1,
    'price' => 5000000,
    'pricingOptions' => [
        [
                'currency' => '<string>',
                'price' => 1,
                'basePrice' => 1,
                'default' => true,
                'setupFee' => 1
        ]
    ],
    'rolloverUnusedUnits' => true,
    'setupFee' => 1,
    'trialDays' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"billingStrategy\": {\n    \"type\": \"<string>\"\n  },\n  \"features\": {},\n  \"fulfillment\": {\n    \"deliveryMethod\": \"<string>\",\n    \"estimatedDelivery\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"limits\": {},\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"overagePolicy\": {\n    \"allowOverage\": true,\n    \"maxOverage\": 123\n  },\n  \"prorationPolicy\": {\n    \"enabled\": true\n  },\n  \"returnPolicy\": {\n    \"allowed\": true,\n    \"conditions\": \"<string>\",\n    \"period\": 123\n  },\n  \"usageTracking\": {},\n  \"warranty\": {\n    \"duration\": 123,\n    \"terms\": \"<string>\",\n    \"unit\": \"<string>\"\n  },\n  \"accessExpiryDays\": 1,\n  \"autoRenew\": true,\n  \"basePrice\": 1,\n  \"cancellationNoticeDays\": 1,\n  \"creditsPerUnit\": 2,\n  \"currency\": \"<string>\",\n  \"default\": true,\n  \"description\": \"<string>\",\n  \"freeUnits\": 1,\n  \"hidden\": true,\n  \"limit\": 1,\n  \"maxActiveUsers\": 1,\n  \"price\": 5000000,\n  \"pricingOptions\": [\n    {\n      \"currency\": \"<string>\",\n      \"price\": 1,\n      \"basePrice\": 1,\n      \"default\": true,\n      \"setupFee\": 1\n    }\n  ],\n  \"rolloverUnusedUnits\": true,\n  \"setupFee\": 1,\n  \"trialDays\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/sdk/products/{productRef}/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingStrategy\": {\n    \"type\": \"<string>\"\n  },\n  \"features\": {},\n  \"fulfillment\": {\n    \"deliveryMethod\": \"<string>\",\n    \"estimatedDelivery\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"limits\": {},\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"overagePolicy\": {\n    \"allowOverage\": true,\n    \"maxOverage\": 123\n  },\n  \"prorationPolicy\": {\n    \"enabled\": true\n  },\n  \"returnPolicy\": {\n    \"allowed\": true,\n    \"conditions\": \"<string>\",\n    \"period\": 123\n  },\n  \"usageTracking\": {},\n  \"warranty\": {\n    \"duration\": 123,\n    \"terms\": \"<string>\",\n    \"unit\": \"<string>\"\n  },\n  \"accessExpiryDays\": 1,\n  \"autoRenew\": true,\n  \"basePrice\": 1,\n  \"cancellationNoticeDays\": 1,\n  \"creditsPerUnit\": 2,\n  \"currency\": \"<string>\",\n  \"default\": true,\n  \"description\": \"<string>\",\n  \"freeUnits\": 1,\n  \"hidden\": true,\n  \"limit\": 1,\n  \"maxActiveUsers\": 1,\n  \"price\": 5000000,\n  \"pricingOptions\": [\n    {\n      \"currency\": \"<string>\",\n      \"price\": 1,\n      \"basePrice\": 1,\n      \"default\": true,\n      \"setupFee\": 1\n    }\n  ],\n  \"rolloverUnusedUnits\": true,\n  \"setupFee\": 1,\n  \"trialDays\": 1\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billingStrategy\": {\n    \"type\": \"<string>\"\n  },\n  \"features\": {},\n  \"fulfillment\": {\n    \"deliveryMethod\": \"<string>\",\n    \"estimatedDelivery\": \"<string>\",\n    \"type\": \"<string>\"\n  },\n  \"limits\": {},\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"overagePolicy\": {\n    \"allowOverage\": true,\n    \"maxOverage\": 123\n  },\n  \"prorationPolicy\": {\n    \"enabled\": true\n  },\n  \"returnPolicy\": {\n    \"allowed\": true,\n    \"conditions\": \"<string>\",\n    \"period\": 123\n  },\n  \"usageTracking\": {},\n  \"warranty\": {\n    \"duration\": 123,\n    \"terms\": \"<string>\",\n    \"unit\": \"<string>\"\n  },\n  \"accessExpiryDays\": 1,\n  \"autoRenew\": true,\n  \"basePrice\": 1,\n  \"cancellationNoticeDays\": 1,\n  \"creditsPerUnit\": 2,\n  \"currency\": \"<string>\",\n  \"default\": true,\n  \"description\": \"<string>\",\n  \"freeUnits\": 1,\n  \"hidden\": true,\n  \"limit\": 1,\n  \"maxActiveUsers\": 1,\n  \"price\": 5000000,\n  \"pricingOptions\": [\n    {\n      \"currency\": \"<string>\",\n      \"price\": 1,\n      \"basePrice\": 1,\n      \"default\": true,\n      \"setupFee\": 1\n    }\n  ],\n  \"rolloverUnusedUnits\": true,\n  \"setupFee\": 1,\n  \"trialDays\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "<string>",
  "currency": "USD",
  "hidden": false,
  "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",
  "pricingOptions": [
    {
      "currency": "USD",
      "price": 2999,
      "basePrice": 1999,
      "default": true,
      "setupFee": 500
    }
  ],
  "rolloverUnusedUnits": false,
  "setupFee": 500,
  "trialDays": 14
}

Authorizations

Authorization

string

header

required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Path Parameters

productRef

string

required

Product reference or ID

Example:

"prd_1A2B3C4D"

Body

application/json

billingStrategy

object

required

Show child attributes

features

object

required

fulfillment

object

required

Show child attributes

limits

object

required

metadata

object

required

name

string

required

Required string length: 2 - 200

Pattern: ^[\p{L}\p{N} .,'"&\/()+:\-]*$

overagePolicy

object

required

Show child attributes

prorationPolicy

object

required

Show child attributes

returnPolicy

object

required

Show child attributes

usageTracking

object

required

Show child attributes

warranty

object

required

Show child attributes

accessExpiryDays

integer

Required range: x > 0

autoRenew

boolean

basePrice

number

Required range: x > 0

billingCycle

enum<string>

Available options:

weekly,

monthly,

quarterly,

yearly,

custom

billingModel

enum<string>

Available options:

pre-paid,

post-paid

cancellationNoticeDays

integer

Required range: x > 0

creditsPerUnit

integer

Required range: x > 1

currency

string

default

boolean

description

string

Maximum string length: 500

Pattern: ^[\p{L}\p{N}\s.,'"&\/()+:%;?!@#_[\]\-]*$

freeUnits

integer

Required range: x > 0

hidden

boolean

limit

integer

Required range: x > 0

maxActiveUsers

integer

Required range: x > 0

price

number

Required range: 0 < x < 10000000

pricingOptions

object[]

Show child attributes

rolloverUnusedUnits

boolean

setupFee

number

Required range: x > 0

status

enum<string>

Available options:

active,

inactive,

archived

taxBehavior

enum<string>

Available options:

auto,

inclusive,

exclusive

trialDays

integer

Required range: x > 0

type

enum<string>

Available options:

recurring,

usage-based,

one-time,

hybrid

Response

Plan created successfully

createdAt

string

required

Creation timestamp

currency

string

required

Currency code (ISO 4217)

Example:

"USD"

hidden

boolean

required

Whether the plan is hidden from customer-facing surfaces. When true, the plan does not appear in checkout or the SDK catalog and can only be granted via direct assignment (enterprise plans).

Example:

false

isActive

boolean

required

Whether the plan is active (derived from status)

Example:

true

price

number

required

Plan price in cents

Example:

2999

reference

string

required

Plan reference

Example:

"pln_1A2B3C4D"

requiresPayment

boolean

required

Whether payment is required

Example:

true

status

string

required

Plan status

Example:

"active"

type

enum<string>

required

Plan type exposed in SDK

Available options:

recurring,

one-time,

usage-based,

hybrid

Example:

"recurring"

updatedAt

string

required

Last update timestamp

accessExpiryDays

number

Access expiry in days

billingCycle

string

Billing cycle

Example:

"monthly"

billingModel

enum<string>

Billing model

Available options:

pre-paid,

post-paid

Example:

"pre-paid"

creditsPerUnit

number

Credits per usage unit (integer, >= 1)

Example:

1

currencySymbol

string

Currency symbol (derived from currency)

Example:

"$"

description

string

Plan description

Example:

"Best for teams getting started"

features

object

Plan features

freeUnits

number

Number of free units included

Example:

100

limit

number

Usage limit for the meter

Example:

10000

limits

object

Usage limits

maxActiveUsers

number

Maximum number of active users

measures

string

What the plan measures for usage tracking

Example:

"requests"

meterRef

string

Meter reference for usage-based plans

Example:

"mtr_1A2B3C4D"

name

string

Plan name

Example:

"Starter"

pricingOptions

object[]

Per-currency price options for this plan

Show child attributes

rolloverUnusedUnits

boolean

Whether unused units roll over to next period

Example:

false

setupFee

number

One-time setup fee

Example:

500

taxBehavior

enum<string>

Tax inclusion behavior for business checkout

Available options:

auto,

inclusive,

exclusive

trialDays

number

Free trial period in days

Example:

14

List plans for a product

Get a plan for a product

⌘I

Activation

Auto Recharge

Checkout Sessions

Customers

Limits

Merchant

Meter Events

Payment Intents

Payment Methods

Platform Config

Products

Plans

Purchases

Usage

User Info

Webhooks

Create a plan for a product

Authorizations

Path Parameters

Body

Response