Update a plan for a product
curl --request PUT \
--url https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"billingStrategy": {
"type": "<string>"
},
"features": {},
"fulfillment": {
"deliveryMethod": "<string>",
"estimatedDelivery": "<string>",
"type": "<string>"
},
"limits": {},
"metadata": {},
"overagePolicy": {
"allowOverage": true,
"maxOverage": 123
},
"prorationPolicy": {
"enabled": true
},
"returnPolicy": {
"allowed": true,
"conditions": "<string>",
"period": 123
},
"warranty": {
"duration": 123,
"terms": "<string>",
"unit": "<string>"
},
"accessExpiryDays": 1,
"autoRenew": true,
"cancellationNoticeDays": 1,
"creditsPerUnit": 2,
"currency": "<string>",
"default": true,
"description": "<string>",
"freeUnits": 1,
"hidden": true,
"limit": 1,
"maxActiveUsers": 1,
"name": "<string>",
"price": 5000000,
"pricingOptions": [
{
"currency": "<string>",
"price": 1,
"basePrice": 1,
"default": true,
"setupFee": 1
}
],
"rolloverUnusedUnits": true
}
'import requests
url = "https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}"
payload = {
"billingStrategy": { "type": "<string>" },
"features": {},
"fulfillment": {
"deliveryMethod": "<string>",
"estimatedDelivery": "<string>",
"type": "<string>"
},
"limits": {},
"metadata": {},
"overagePolicy": {
"allowOverage": True,
"maxOverage": 123
},
"prorationPolicy": { "enabled": True },
"returnPolicy": {
"allowed": True,
"conditions": "<string>",
"period": 123
},
"warranty": {
"duration": 123,
"terms": "<string>",
"unit": "<string>"
},
"accessExpiryDays": 1,
"autoRenew": True,
"cancellationNoticeDays": 1,
"creditsPerUnit": 2,
"currency": "<string>",
"default": True,
"description": "<string>",
"freeUnits": 1,
"hidden": True,
"limit": 1,
"maxActiveUsers": 1,
"name": "<string>",
"price": 5000000,
"pricingOptions": [
{
"currency": "<string>",
"price": 1,
"basePrice": 1,
"default": True,
"setupFee": 1
}
],
"rolloverUnusedUnits": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billingStrategy: {type: '<string>'},
features: {},
fulfillment: {deliveryMethod: '<string>', estimatedDelivery: '<string>', type: '<string>'},
limits: {},
metadata: {},
overagePolicy: {allowOverage: true, maxOverage: 123},
prorationPolicy: {enabled: true},
returnPolicy: {allowed: true, conditions: '<string>', period: 123},
warranty: {duration: 123, terms: '<string>', unit: '<string>'},
accessExpiryDays: 1,
autoRenew: true,
cancellationNoticeDays: 1,
creditsPerUnit: 2,
currency: '<string>',
default: true,
description: '<string>',
freeUnits: 1,
hidden: true,
limit: 1,
maxActiveUsers: 1,
name: '<string>',
price: 5000000,
pricingOptions: [{currency: '<string>', price: 1, basePrice: 1, default: true, setupFee: 1}],
rolloverUnusedUnits: true
})
};
fetch('https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}', 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/{planRef}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'billingStrategy' => [
'type' => '<string>'
],
'features' => [
],
'fulfillment' => [
'deliveryMethod' => '<string>',
'estimatedDelivery' => '<string>',
'type' => '<string>'
],
'limits' => [
],
'metadata' => [
],
'overagePolicy' => [
'allowOverage' => true,
'maxOverage' => 123
],
'prorationPolicy' => [
'enabled' => true
],
'returnPolicy' => [
'allowed' => true,
'conditions' => '<string>',
'period' => 123
],
'warranty' => [
'duration' => 123,
'terms' => '<string>',
'unit' => '<string>'
],
'accessExpiryDays' => 1,
'autoRenew' => true,
'cancellationNoticeDays' => 1,
'creditsPerUnit' => 2,
'currency' => '<string>',
'default' => true,
'description' => '<string>',
'freeUnits' => 1,
'hidden' => true,
'limit' => 1,
'maxActiveUsers' => 1,
'name' => '<string>',
'price' => 5000000,
'pricingOptions' => [
[
'currency' => '<string>',
'price' => 1,
'basePrice' => 1,
'default' => true,
'setupFee' => 1
]
],
'rolloverUnusedUnits' => true
]),
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/{planRef}"
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 \"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 \"warranty\": {\n \"duration\": 123,\n \"terms\": \"<string>\",\n \"unit\": \"<string>\"\n },\n \"accessExpiryDays\": 1,\n \"autoRenew\": true,\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 \"name\": \"<string>\",\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}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}")
.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 \"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 \"warranty\": {\n \"duration\": 123,\n \"terms\": \"<string>\",\n \"unit\": \"<string>\"\n },\n \"accessExpiryDays\": 1,\n \"autoRenew\": true,\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 \"name\": \"<string>\",\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.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 \"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 \"warranty\": {\n \"duration\": 123,\n \"terms\": \"<string>\",\n \"unit\": \"<string>\"\n },\n \"accessExpiryDays\": 1,\n \"autoRenew\": true,\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 \"name\": \"<string>\",\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}"
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
}Plans
Update a plan for a product
Updates a plan under the product. Unfinished pricing fields are stripped from SDK input, and unsupported plan types fall back to “recurring”.
PUT
/
v1
/
sdk
/
products
/
{productRef}
/
plans
/
{planRef}
Update a plan for a product
curl --request PUT \
--url https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"billingStrategy": {
"type": "<string>"
},
"features": {},
"fulfillment": {
"deliveryMethod": "<string>",
"estimatedDelivery": "<string>",
"type": "<string>"
},
"limits": {},
"metadata": {},
"overagePolicy": {
"allowOverage": true,
"maxOverage": 123
},
"prorationPolicy": {
"enabled": true
},
"returnPolicy": {
"allowed": true,
"conditions": "<string>",
"period": 123
},
"warranty": {
"duration": 123,
"terms": "<string>",
"unit": "<string>"
},
"accessExpiryDays": 1,
"autoRenew": true,
"cancellationNoticeDays": 1,
"creditsPerUnit": 2,
"currency": "<string>",
"default": true,
"description": "<string>",
"freeUnits": 1,
"hidden": true,
"limit": 1,
"maxActiveUsers": 1,
"name": "<string>",
"price": 5000000,
"pricingOptions": [
{
"currency": "<string>",
"price": 1,
"basePrice": 1,
"default": true,
"setupFee": 1
}
],
"rolloverUnusedUnits": true
}
'import requests
url = "https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}"
payload = {
"billingStrategy": { "type": "<string>" },
"features": {},
"fulfillment": {
"deliveryMethod": "<string>",
"estimatedDelivery": "<string>",
"type": "<string>"
},
"limits": {},
"metadata": {},
"overagePolicy": {
"allowOverage": True,
"maxOverage": 123
},
"prorationPolicy": { "enabled": True },
"returnPolicy": {
"allowed": True,
"conditions": "<string>",
"period": 123
},
"warranty": {
"duration": 123,
"terms": "<string>",
"unit": "<string>"
},
"accessExpiryDays": 1,
"autoRenew": True,
"cancellationNoticeDays": 1,
"creditsPerUnit": 2,
"currency": "<string>",
"default": True,
"description": "<string>",
"freeUnits": 1,
"hidden": True,
"limit": 1,
"maxActiveUsers": 1,
"name": "<string>",
"price": 5000000,
"pricingOptions": [
{
"currency": "<string>",
"price": 1,
"basePrice": 1,
"default": True,
"setupFee": 1
}
],
"rolloverUnusedUnits": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
billingStrategy: {type: '<string>'},
features: {},
fulfillment: {deliveryMethod: '<string>', estimatedDelivery: '<string>', type: '<string>'},
limits: {},
metadata: {},
overagePolicy: {allowOverage: true, maxOverage: 123},
prorationPolicy: {enabled: true},
returnPolicy: {allowed: true, conditions: '<string>', period: 123},
warranty: {duration: 123, terms: '<string>', unit: '<string>'},
accessExpiryDays: 1,
autoRenew: true,
cancellationNoticeDays: 1,
creditsPerUnit: 2,
currency: '<string>',
default: true,
description: '<string>',
freeUnits: 1,
hidden: true,
limit: 1,
maxActiveUsers: 1,
name: '<string>',
price: 5000000,
pricingOptions: [{currency: '<string>', price: 1, basePrice: 1, default: true, setupFee: 1}],
rolloverUnusedUnits: true
})
};
fetch('https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}', 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/{planRef}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'billingStrategy' => [
'type' => '<string>'
],
'features' => [
],
'fulfillment' => [
'deliveryMethod' => '<string>',
'estimatedDelivery' => '<string>',
'type' => '<string>'
],
'limits' => [
],
'metadata' => [
],
'overagePolicy' => [
'allowOverage' => true,
'maxOverage' => 123
],
'prorationPolicy' => [
'enabled' => true
],
'returnPolicy' => [
'allowed' => true,
'conditions' => '<string>',
'period' => 123
],
'warranty' => [
'duration' => 123,
'terms' => '<string>',
'unit' => '<string>'
],
'accessExpiryDays' => 1,
'autoRenew' => true,
'cancellationNoticeDays' => 1,
'creditsPerUnit' => 2,
'currency' => '<string>',
'default' => true,
'description' => '<string>',
'freeUnits' => 1,
'hidden' => true,
'limit' => 1,
'maxActiveUsers' => 1,
'name' => '<string>',
'price' => 5000000,
'pricingOptions' => [
[
'currency' => '<string>',
'price' => 1,
'basePrice' => 1,
'default' => true,
'setupFee' => 1
]
],
'rolloverUnusedUnits' => true
]),
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/{planRef}"
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 \"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 \"warranty\": {\n \"duration\": 123,\n \"terms\": \"<string>\",\n \"unit\": \"<string>\"\n },\n \"accessExpiryDays\": 1,\n \"autoRenew\": true,\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 \"name\": \"<string>\",\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}")
req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}")
.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 \"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 \"warranty\": {\n \"duration\": 123,\n \"terms\": \"<string>\",\n \"unit\": \"<string>\"\n },\n \"accessExpiryDays\": 1,\n \"autoRenew\": true,\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 \"name\": \"<string>\",\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sdk/products/{productRef}/plans/{planRef}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.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 \"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 \"warranty\": {\n \"duration\": 123,\n \"terms\": \"<string>\",\n \"unit\": \"<string>\"\n },\n \"accessExpiryDays\": 1,\n \"autoRenew\": true,\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 \"name\": \"<string>\",\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}"
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
Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.
Path Parameters
Product reference or ID
Example:
"prd_1A2B3C4D"
Plan reference or ID
Example:
"pln_1A2B3C4D"
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
x > 0Available options:
weekly, monthly, quarterly, yearly, custom Available options:
pre-paid, post-paid Required range:
x > 0Required range:
x > 1Maximum string length:
500Pattern:
^[\p{L}\p{N}\s.,'"&\/()+:%;?!@#_[\]\-]*$Required range:
x > 0Required range:
x > 0Required range:
x > 0Required string length:
2 - 200Pattern:
^[\p{L}\p{N} .,'"&\/()+:\-]*$Required range:
0 < x < 10000000Show child attributes
Show child attributes
Available options:
active, inactive, archived Available options:
auto, inclusive, exclusive Response
Plan updated successfully
Creation timestamp
Currency code (ISO 4217)
Example:
"USD"
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
Whether the plan is active (derived from status)
Example:
true
Plan price in cents
Example:
2999
Plan reference
Example:
"pln_1A2B3C4D"
Whether payment is required
Example:
true
Plan status
Example:
"active"
Plan type exposed in SDK
Available options:
recurring, one-time, usage-based, hybrid Example:
"recurring"
Last update timestamp
Access expiry in days
Billing cycle
Example:
"monthly"
Billing model
Available options:
pre-paid, post-paid Example:
"pre-paid"
Credits per usage unit (integer, >= 1)
Example:
1
Currency symbol (derived from currency)
Example:
"$"
Plan description
Example:
"Best for teams getting started"
Plan features
Number of free units included
Example:
100
Usage limit for the meter
Example:
10000
Usage limits
Maximum number of active users
What the plan measures for usage tracking
Example:
"requests"
Meter reference for usage-based plans
Example:
"mtr_1A2B3C4D"
Plan name
Example:
"Starter"
Per-currency price options for this plan
Show child attributes
Show child attributes
Whether unused units roll over to next period
Example:
false
One-time setup fee
Example:
500
Tax inclusion behavior for business checkout
Available options:
auto, inclusive, exclusive Free trial period in days
Example:
14
⌘I