Update

PATCH /v0/prices/{id}

Update

cURL

curl --request PATCH \
  --url https://api.paygentic.io/v0/prices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billableMetricId": "<string>",
  "pricingUnitId": "<string>",
  "invoiceDisplayName": "<string>",
  "model": "standard",
  "properties": {
    "unitPrice": "<string>"
  },
  "billingCadence": "<string>",
  "feature": {
    "featureId": "<string>",
    "entitlementTemplate": {}
  },
  "grantDiscountEnabled": true,
  "quantity": 1
}
'

import requests

url = "https://api.paygentic.io/v0/prices/{id}"

payload = {
    "billableMetricId": "<string>",
    "pricingUnitId": "<string>",
    "invoiceDisplayName": "<string>",
    "model": "standard",
    "properties": { "unitPrice": "<string>" },
    "billingCadence": "<string>",
    "feature": {
        "featureId": "<string>",
        "entitlementTemplate": {}
    },
    "grantDiscountEnabled": True,
    "quantity": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billableMetricId: '<string>',
    pricingUnitId: '<string>',
    invoiceDisplayName: '<string>',
    model: 'standard',
    properties: {unitPrice: '<string>'},
    billingCadence: '<string>',
    feature: {featureId: '<string>', entitlementTemplate: {}},
    grantDiscountEnabled: true,
    quantity: 1
  })
};

fetch('https://api.paygentic.io/v0/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://api.paygentic.io/v0/prices/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'billableMetricId' => '<string>',
    'pricingUnitId' => '<string>',
    'invoiceDisplayName' => '<string>',
    'model' => 'standard',
    'properties' => [
        'unitPrice' => '<string>'
    ],
    'billingCadence' => '<string>',
    'feature' => [
        'featureId' => '<string>',
        'entitlementTemplate' => [
                
        ]
    ],
    'grantDiscountEnabled' => true,
    'quantity' => 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.paygentic.io/v0/prices/{id}"

	payload := strings.NewReader("{\n  \"billableMetricId\": \"<string>\",\n  \"pricingUnitId\": \"<string>\",\n  \"invoiceDisplayName\": \"<string>\",\n  \"model\": \"standard\",\n  \"properties\": {\n    \"unitPrice\": \"<string>\"\n  },\n  \"billingCadence\": \"<string>\",\n  \"feature\": {\n    \"featureId\": \"<string>\",\n    \"entitlementTemplate\": {}\n  },\n  \"grantDiscountEnabled\": true,\n  \"quantity\": 1\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.paygentic.io/v0/prices/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billableMetricId\": \"<string>\",\n  \"pricingUnitId\": \"<string>\",\n  \"invoiceDisplayName\": \"<string>\",\n  \"model\": \"standard\",\n  \"properties\": {\n    \"unitPrice\": \"<string>\"\n  },\n  \"billingCadence\": \"<string>\",\n  \"feature\": {\n    \"featureId\": \"<string>\",\n    \"entitlementTemplate\": {}\n  },\n  \"grantDiscountEnabled\": true,\n  \"quantity\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/prices/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billableMetricId\": \"<string>\",\n  \"pricingUnitId\": \"<string>\",\n  \"invoiceDisplayName\": \"<string>\",\n  \"model\": \"standard\",\n  \"properties\": {\n    \"unitPrice\": \"<string>\"\n  },\n  \"billingCadence\": \"<string>\",\n  \"feature\": {\n    \"featureId\": \"<string>\",\n    \"entitlementTemplate\": {}\n  },\n  \"grantDiscountEnabled\": true,\n  \"quantity\": 1\n}"

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

200

{
  "id": "price_r7s8t9u0v1w2x3y4",
  "object": "price",
  "billableMetricId": "bm_z5a6b7c8d9e0f1g2",
  "createdAt": "2024-01-25T10:00:00Z",
  "currency": "USD",
  "description": "Per-call pricing for ML inference",
  "invoiceDisplayName": "Inference API Calls",
  "model": "standard",
  "paymentTerm": "in_arrears",
  "properties": {
    "unitPrice": "0.05"
  },
  "unitAmount": "50000000",
  "updatedAt": "2024-03-05T14:20:00Z"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization · string · header · required

API key authentication

Path Parameters

id · string · required

The unique identifier of the price Unique identifier for a price

Pattern: ^price_[a-zA-Z0-9]+$

Body

application/json

billableMetricId · string

The unique identifier for the billable metric referred to by this price.

Pattern: ^bm_[a-zA-Z0-9]+$

pricingUnitId · string | null

Denominate this metered price in a pricing unit (credits). Set to a pricing unit ID to draw down a credit pool, null to revert to real currency, or omit to leave unchanged.

Pattern: ^pu_[a-zA-Z0-9]+$

invoiceDisplayName · string

Updated invoice line item label. Sample values: 'LLM Token Usage', 'Storage Charges', 'API Call Fees'

model · enum<string>

The pricing model to set. Only 'standard' is accepted. Legacy 'dynamic'/'volume'/'percentage' prices can still be edited (other fields) but cannot be switched to those models. Percentage/revenue-share is expressed via 'standard' with a unit-price multiplier.

Available options: standard

properties · object

Standard pricing model

Option 1

Option 2

Option 3

Option 4

Show child attributes

paymentTerm · enum<string>

Billing timing preference: 'in_advance' (prepaid — charged upfront or drawn from a prepaid commitment) or 'in_arrears' (charged at period end).

Available options: in_arrears, in_advance

billingCadence · string | null

ISO 8601 duration for recurring fees (e.g., 'P1M' for monthly, 'P1Y' for yearly, or 'P0D' for one-time)

feature · object | null

Feature to associate. Set to null to remove existing feature. Omit to leave unchanged.

Show child attributes

grantDiscountEnabled · boolean

When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.

quantity · integer

Quantity for invoice line items. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.

Required range: x >= 0

Response

200

application/json

Price updated successfully

id · string · required

Unique identifier for a price

Pattern: ^price_[a-zA-Z0-9]+$

object · enum<string> · default: price · required

Available options: price

merchantId · string · required

The merchant organization that owns this price, derived from the associated fee or billable metric. Present on single-price reads.

Pattern: ^org_[a-zA-Z0-9]+$

createdAt · string<date-time> · required

invoiceDisplayName · string · required

paymentTerm · enum<string> · required

Available options: in_arrears, in_advance

properties · object · required

Standard pricing model

Option 1

Option 2

Option 3

Option 4

Show child attributes

updatedAt · string<date-time> · required

quantity · integer · required

Quantity for invoice line items. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.

Required range: x >= 0

billableMetricId · string

Unique identifier for a billable metric

Pattern: ^bm_[a-zA-Z0-9]+$

feeId · string

The unique identifier for the fee referred to by this price. Present when price is linked to a fee.

Pattern: ^fee_[a-zA-Z0-9]+$

pricingUnitId · string

The pricing unit this price is denominated in (credits). Present when the price draws down a credit pool instead of charging real currency.

Pattern: ^pu_[a-zA-Z0-9]+$

billingCadence · string | null

ISO 8601 duration. 'P0D' for one-time, 'P1M' for monthly, 'P1Y' for yearly. Required for fees, optional for billable metrics. Defaults to plan's billingCadence if not specified.

model · enum<string>

Pricing model of a price as returned by the API. Includes legacy models ('dynamic', 'volume', 'percentage') retained for existing prices; only 'standard' can be created (see PriceModelInput).

Available options: standard, dynamic, volume, percentage

features · object[]

Features associated with this price

Show child attributes

grantDiscountEnabled · boolean · default: false

When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.