Update price
curl --request PUT \
--url https://us.api.flexprice.io/v1/prices/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": "<string>",
"description": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"group_id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"price_unit_amount": "<string>",
"price_unit_tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123
}
}
'import requests
url = "https://us.api.flexprice.io/v1/prices/{id}"
payload = {
"amount": "<string>",
"description": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"group_id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"price_unit_amount": "<string>",
"price_unit_tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": { "divide_by": 123 }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
description: '<string>',
display_name: '<string>',
effective_from: '<string>',
group_id: '<string>',
lookup_key: '<string>',
metadata: {},
price_unit_amount: '<string>',
price_unit_tiers: [{unit_amount: '<string>', flat_amount: '<string>', up_to: 123}],
tiers: [{unit_amount: '<string>', flat_amount: '<string>', up_to: 123}],
transform_quantity: {divide_by: 123}
})
};
fetch('https://us.api.flexprice.io/v1/prices/{id}', 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://us.api.flexprice.io/v1/prices/{id}",
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([
'amount' => '<string>',
'description' => '<string>',
'display_name' => '<string>',
'effective_from' => '<string>',
'group_id' => '<string>',
'lookup_key' => '<string>',
'metadata' => [
],
'price_unit_amount' => '<string>',
'price_unit_tiers' => [
[
'unit_amount' => '<string>',
'flat_amount' => '<string>',
'up_to' => 123
]
],
'tiers' => [
[
'unit_amount' => '<string>',
'flat_amount' => '<string>',
'up_to' => 123
]
],
'transform_quantity' => [
'divide_by' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://us.api.flexprice.io/v1/prices/{id}"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"effective_from\": \"<string>\",\n \"group_id\": \"<string>\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"price_unit_amount\": \"<string>\",\n \"price_unit_tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"transform_quantity\": {\n \"divide_by\": 123\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/prices/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"effective_from\": \"<string>\",\n \"group_id\": \"<string>\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"price_unit_amount\": \"<string>\",\n \"price_unit_tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"transform_quantity\": {\n \"divide_by\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/prices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"effective_from\": \"<string>\",\n \"group_id\": \"<string>\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"price_unit_amount\": \"<string>\",\n \"price_unit_tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"transform_quantity\": {\n \"divide_by\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"addon": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grants": [
{
"addon_id": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"expiration_duration": 123,
"id": "<string>",
"metadata": {},
"name": "<string>",
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
],
"description": "<string>",
"entitlements": [
{
"addon": "<unknown>",
"config_value": {},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"display_order": 123,
"end_date": "2023-11-07T05:31:56Z",
"entity_id": "<string>",
"environment_id": "<string>",
"feature": {
"alert_settings": {
"alert_enabled": true,
"critical": {
"threshold": "<string>"
},
"info": {
"threshold": "<string>"
},
"warning": {
"threshold": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"description": "<string>",
"environment_id": "<string>",
"group": {
"created_at": "2023-11-07T05:31:56Z",
"entity_ids": [
"<string>"
],
"entity_type": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"group_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"meter": {
"aggregation": {
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>"
},
"created_at": "2024-03-20T15:04:05Z",
"event_name": "api_request",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API Usage Meter",
"status": "published",
"tenant_id": "tenant123",
"updated_at": "2024-03-20T15:04:05Z"
},
"meter_id": "<string>",
"name": "<string>",
"reporting_unit": {
"conversion_rate": 123,
"unit_plural": "<string>",
"unit_singular": "<string>"
},
"tenant_id": "<string>",
"unit_plural": "<string>",
"unit_singular": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"feature_id": "<string>",
"id": "<string>",
"is_enabled": true,
"is_soft_limit": true,
"parent_entitlement_id": "<string>",
"plan": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grants": [
{
"addon_id": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"expiration_duration": 123,
"id": "<string>",
"metadata": {},
"name": "<string>",
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
],
"description": "<string>",
"display_order": 123,
"entitlements": "<array>",
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"prices": "<array>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"plan_id": "<string>",
"start_date": "2023-11-07T05:31:56Z",
"static_value": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"usage_limit": 123
}
],
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"prices": "<array>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_period_count": 123,
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"currency": "<string>",
"description": "<string>",
"display_amount": "<string>",
"display_name": "<string>",
"display_price_unit_amount": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"entity_id": "<string>",
"environment_id": "<string>",
"group": {
"created_at": "2023-11-07T05:31:56Z",
"entity_ids": [
"<string>"
],
"entity_type": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"group_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"meter": {
"aggregation": {
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>"
},
"created_at": "2024-03-20T15:04:05Z",
"event_name": "api_request",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API Usage Meter",
"status": "published",
"tenant_id": "tenant123",
"updated_at": "2024-03-20T15:04:05Z"
},
"meter_id": "<string>",
"min_quantity": "<string>",
"parent_price_id": "<string>",
"plan": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grants": [
{
"addon_id": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"expiration_duration": 123,
"id": "<string>",
"metadata": {},
"name": "<string>",
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
],
"description": "<string>",
"display_order": 123,
"entitlements": "<array>",
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"prices": "<array>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"price_unit": "<string>",
"price_unit_amount": "<string>",
"price_unit_id": "<string>",
"price_unit_tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"pricing_unit": {
"base_currency": "<string>",
"code": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"environment_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"symbol": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"sequence": 123,
"start_date": "2023-11-07T05:31:56Z",
"tenant_id": "<string>",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123
},
"trial_period_days": 123,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}Prices
Update price
Use when changing price configuration (e.g. amount, billing scheme, or metadata).
PUT
/
prices
/
{id}
Update price
curl --request PUT \
--url https://us.api.flexprice.io/v1/prices/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": "<string>",
"description": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"group_id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"price_unit_amount": "<string>",
"price_unit_tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123
}
}
'import requests
url = "https://us.api.flexprice.io/v1/prices/{id}"
payload = {
"amount": "<string>",
"description": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"group_id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"price_unit_amount": "<string>",
"price_unit_tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"tiers": [
{
"unit_amount": "<string>",
"flat_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": { "divide_by": 123 }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
description: '<string>',
display_name: '<string>',
effective_from: '<string>',
group_id: '<string>',
lookup_key: '<string>',
metadata: {},
price_unit_amount: '<string>',
price_unit_tiers: [{unit_amount: '<string>', flat_amount: '<string>', up_to: 123}],
tiers: [{unit_amount: '<string>', flat_amount: '<string>', up_to: 123}],
transform_quantity: {divide_by: 123}
})
};
fetch('https://us.api.flexprice.io/v1/prices/{id}', 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://us.api.flexprice.io/v1/prices/{id}",
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([
'amount' => '<string>',
'description' => '<string>',
'display_name' => '<string>',
'effective_from' => '<string>',
'group_id' => '<string>',
'lookup_key' => '<string>',
'metadata' => [
],
'price_unit_amount' => '<string>',
'price_unit_tiers' => [
[
'unit_amount' => '<string>',
'flat_amount' => '<string>',
'up_to' => 123
]
],
'tiers' => [
[
'unit_amount' => '<string>',
'flat_amount' => '<string>',
'up_to' => 123
]
],
'transform_quantity' => [
'divide_by' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://us.api.flexprice.io/v1/prices/{id}"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"effective_from\": \"<string>\",\n \"group_id\": \"<string>\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"price_unit_amount\": \"<string>\",\n \"price_unit_tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"transform_quantity\": {\n \"divide_by\": 123\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://us.api.flexprice.io/v1/prices/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"effective_from\": \"<string>\",\n \"group_id\": \"<string>\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"price_unit_amount\": \"<string>\",\n \"price_unit_tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"transform_quantity\": {\n \"divide_by\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/prices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"effective_from\": \"<string>\",\n \"group_id\": \"<string>\",\n \"lookup_key\": \"<string>\",\n \"metadata\": {},\n \"price_unit_amount\": \"<string>\",\n \"price_unit_tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"tiers\": [\n {\n \"unit_amount\": \"<string>\",\n \"flat_amount\": \"<string>\",\n \"up_to\": 123\n }\n ],\n \"transform_quantity\": {\n \"divide_by\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"addon": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grants": [
{
"addon_id": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"expiration_duration": 123,
"id": "<string>",
"metadata": {},
"name": "<string>",
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
],
"description": "<string>",
"entitlements": [
{
"addon": "<unknown>",
"config_value": {},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"display_order": 123,
"end_date": "2023-11-07T05:31:56Z",
"entity_id": "<string>",
"environment_id": "<string>",
"feature": {
"alert_settings": {
"alert_enabled": true,
"critical": {
"threshold": "<string>"
},
"info": {
"threshold": "<string>"
},
"warning": {
"threshold": "<string>"
}
},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"description": "<string>",
"environment_id": "<string>",
"group": {
"created_at": "2023-11-07T05:31:56Z",
"entity_ids": [
"<string>"
],
"entity_type": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"group_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"meter": {
"aggregation": {
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>"
},
"created_at": "2024-03-20T15:04:05Z",
"event_name": "api_request",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API Usage Meter",
"status": "published",
"tenant_id": "tenant123",
"updated_at": "2024-03-20T15:04:05Z"
},
"meter_id": "<string>",
"name": "<string>",
"reporting_unit": {
"conversion_rate": 123,
"unit_plural": "<string>",
"unit_singular": "<string>"
},
"tenant_id": "<string>",
"unit_plural": "<string>",
"unit_singular": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"feature_id": "<string>",
"id": "<string>",
"is_enabled": true,
"is_soft_limit": true,
"parent_entitlement_id": "<string>",
"plan": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grants": [
{
"addon_id": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"expiration_duration": 123,
"id": "<string>",
"metadata": {},
"name": "<string>",
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
],
"description": "<string>",
"display_order": 123,
"entitlements": "<array>",
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"prices": "<array>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"plan_id": "<string>",
"start_date": "2023-11-07T05:31:56Z",
"static_value": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"usage_limit": 123
}
],
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"prices": "<array>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_period_count": 123,
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"currency": "<string>",
"description": "<string>",
"display_amount": "<string>",
"display_name": "<string>",
"display_price_unit_amount": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"entity_id": "<string>",
"environment_id": "<string>",
"group": {
"created_at": "2023-11-07T05:31:56Z",
"entity_ids": [
"<string>"
],
"entity_type": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"group_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"meter": {
"aggregation": {
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>"
},
"created_at": "2024-03-20T15:04:05Z",
"event_name": "api_request",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API Usage Meter",
"status": "published",
"tenant_id": "tenant123",
"updated_at": "2024-03-20T15:04:05Z"
},
"meter_id": "<string>",
"min_quantity": "<string>",
"parent_price_id": "<string>",
"plan": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grants": [
{
"addon_id": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"expiration_duration": 123,
"id": "<string>",
"metadata": {},
"name": "<string>",
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
],
"description": "<string>",
"display_order": 123,
"entitlements": "<array>",
"environment_id": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"prices": "<array>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"price_unit": "<string>",
"price_unit_amount": "<string>",
"price_unit_id": "<string>",
"price_unit_tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"pricing_unit": {
"base_currency": "<string>",
"code": "<string>",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"environment_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"symbol": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"sequence": 123,
"start_date": "2023-11-07T05:31:56Z",
"tenant_id": "<string>",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123
},
"trial_period_days": 123,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}{
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Price ID
Body
application/json
Price configuration
Amount is the new price amount that overrides the original price (optional)
Available options:
FLAT_FEE, PACKAGE, TIERED GroupID is the id of the group to update the price in. If not provided (nil), the group will not be changed If provided as empty string (""), the group will be removed (price will be ungrouped) If provided as a group ID, the price will be assigned to that group (must exist and be published)
All price fields that can be updated Non-critical fields (can be updated directly)
Show child attributes
Show child attributes
PriceUnitAmount is the price unit amount (for CUSTOM price unit type, FLAT_FEE/PACKAGE billing models)
PriceUnitTiers are the price unit tiers (for CUSTOM price unit type, TIERED billing model)
Show child attributes
Show child attributes
Available options:
VOLUME, SLAB Tiers determines the pricing tiers for this line item
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
Show child attributes
Show child attributes
Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50
Available options:
RECURRING Available options:
FLAT_FEE, PACKAGE, TIERED Available options:
MONTHLY, ANNUAL, WEEKLY, DAILY, QUARTERLY, HALF_YEARLY, ONETIME BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12
ConversionRate is the conversion rate of the price unit to the fiat currency
Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp
Description of the price
DisplayAmount is the formatted amount with currency symbol For USD: $12.50
DisplayName is the name of the price
DisplayPriceUnitAmount is the formatted amount of the price unit
EndDate is the end date of the price
EntityID holds the value of the "entity_id" field.
Available options:
PLAN, SUBSCRIPTION, ADDON, PRICE, COSTSHEET EnvironmentID is the environment identifier for the price
Show child attributes
Show child attributes
GroupID references the group this price belongs to
ID uuid identifier for the price
Available options:
ARREAR, ADVANCE LookupKey used for looking up the price in the database
Show child attributes
Show child attributes
Show child attributes
Show child attributes
MeterID is the id of the meter for usage based pricing
MinQuantity is the minimum quantity of the price
ParentPriceID references the root price (always set for price lineage tracking)
Show child attributes
Show child attributes
PriceUnit is the code of the price unit (e.g., 'btc', 'eth')
PriceUnitAmount is the amount of the price unit
PriceUnitID is the id of the price unit (for CUSTOM type)
PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED
Show child attributes
Show child attributes
Available options:
FIAT, CUSTOM Show child attributes
Show child attributes
Sequence is the monotonic stamp bumped on every state change that subscription line items need to react to. Read by the plan-price sync; set by the database (DEFAULT nextval) on create and by the price repository on termination / compatibility-affecting edits.
StartDate is the start date of the price
Available options:
published, deleted, archived Available options:
VOLUME, SLAB Show child attributes
Show child attributes
Show child attributes
Show child attributes
TrialPeriodDays is the number of days for the trial period Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)
Available options:
USAGE, FIXED ⌘I