Update

Update

curl --request PATCH \
  --url https://api.paygentic.io/v0/costs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "unitCost": 1,
  "currency": "<string>",
  "unit": "<string>",
  "eventType": "<string>",
  "valueProperty": "<string>",
  "groupBy": {}
}
'

import requests

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

payload = {
    "name": "<string>",
    "unitCost": 1,
    "currency": "<string>",
    "unit": "<string>",
    "eventType": "<string>",
    "valueProperty": "<string>",
    "groupBy": {}
}
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({
    name: '<string>',
    unitCost: 1,
    currency: '<string>',
    unit: '<string>',
    eventType: '<string>',
    valueProperty: '<string>',
    groupBy: {}
  })
};

fetch('https://api.paygentic.io/v0/costs/{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/costs/{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([
    'name' => '<string>',
    'unitCost' => 1,
    'currency' => '<string>',
    'unit' => '<string>',
    'eventType' => '<string>',
    'valueProperty' => '<string>',
    'groupBy' => [
        
    ]
  ]),
  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/costs/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"unitCost\": 1,\n  \"currency\": \"<string>\",\n  \"unit\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"valueProperty\": \"<string>\",\n  \"groupBy\": {}\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/costs/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"unitCost\": 1,\n  \"currency\": \"<string>\",\n  \"unit\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"valueProperty\": \"<string>\",\n  \"groupBy\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/costs/{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  \"name\": \"<string>\",\n  \"unitCost\": 1,\n  \"currency\": \"<string>\",\n  \"unit\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"valueProperty\": \"<string>\",\n  \"groupBy\": {}\n}"

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

{
  "id": "<string>",
  "object": "cost",
  "type": "metered",
  "name": "<string>",
  "currency": "<string>",
  "unitCost": "<string>",
  "productId": "<string>",
  "merchantId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "unit": "<string>",
  "aggregation": "SUM",
  "eventType": "<string>",
  "valueProperty": "<string>",
  "groupBy": {},
  "deletedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
}

PATCH

costs

{id}

Update

curl --request PATCH \
  --url https://api.paygentic.io/v0/costs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "unitCost": 1,
  "currency": "<string>",
  "unit": "<string>",
  "eventType": "<string>",
  "valueProperty": "<string>",
  "groupBy": {}
}
'

import requests

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

payload = {
    "name": "<string>",
    "unitCost": 1,
    "currency": "<string>",
    "unit": "<string>",
    "eventType": "<string>",
    "valueProperty": "<string>",
    "groupBy": {}
}
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({
    name: '<string>',
    unitCost: 1,
    currency: '<string>',
    unit: '<string>',
    eventType: '<string>',
    valueProperty: '<string>',
    groupBy: {}
  })
};

fetch('https://api.paygentic.io/v0/costs/{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/costs/{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([
    'name' => '<string>',
    'unitCost' => 1,
    'currency' => '<string>',
    'unit' => '<string>',
    'eventType' => '<string>',
    'valueProperty' => '<string>',
    'groupBy' => [
        
    ]
  ]),
  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/costs/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"unitCost\": 1,\n  \"currency\": \"<string>\",\n  \"unit\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"valueProperty\": \"<string>\",\n  \"groupBy\": {}\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/costs/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"unitCost\": 1,\n  \"currency\": \"<string>\",\n  \"unit\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"valueProperty\": \"<string>\",\n  \"groupBy\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/costs/{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  \"name\": \"<string>\",\n  \"unitCost\": 1,\n  \"currency\": \"<string>\",\n  \"unit\": \"<string>\",\n  \"eventType\": \"<string>\",\n  \"valueProperty\": \"<string>\",\n  \"groupBy\": {}\n}"

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

{
  "id": "<string>",
  "object": "cost",
  "type": "metered",
  "name": "<string>",
  "currency": "<string>",
  "unitCost": "<string>",
  "productId": "<string>",
  "merchantId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "unit": "<string>",
  "aggregation": "SUM",
  "eventType": "<string>",
  "valueProperty": "<string>",
  "groupBy": {},
  "deletedAt": "2023-11-07T05:31:56Z"
}

{
  "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

string

required

The unique identifier of the cost Unique identifier for a cost

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

Body

application/json

name

string

Updated name for the cost.

unitCost

number

Updated unit cost.

Required range: x >= 0

currency

string

Updated ISO 4217 currency code.

unit

string | null

Updated unit label (metered costs only).

aggregation

enum<string> | null

Updated aggregation method (metered costs only).

Available options:

SUM,

COUNT,

AVG,

MIN,

MAX,

UNIQUE_COUNT,

LATEST

eventType

string | null

Updated CloudEvents type (metered costs only).

valueProperty

string | null

Updated JSONPath for value extraction. Must start with $. (example: $.amount or $.payload.bytes). Metered costs only.

Pattern: ^\$\.[a-zA-Z0-9_]+(\.[a-zA-Z0-9_]+)*$

groupBy

object | null

Updated group-by dimension map. Each value must start with $. (example: $.region). Metered costs only.

Show child attributes

Response

Cost updated successfully

string

required

Unique identifier for a cost

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

object

enum<string>

default:cost

required

Available options:

cost

type

enum<string>

required

Available options:

metered

name

string

required

currency

string

required

unitCost

string

required

Decimal as string to avoid floating point precision loss.

productId

string

required

Unique identifier for a product

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

merchantId

string

required

Unique identifier for an organization

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

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

unit

string | null

aggregation

enum<string> | null

Available options:

SUM,

COUNT,

AVG,

MIN,

MAX,

UNIQUE_COUNT,

LATEST

eventType

string | null

valueProperty

string | null

groupBy

object | null

Show child attributes

deletedAt

string<date-time> | null

Soft-delete timestamp. Always null for active costs returned by the API.

Billable Metrics

Customers

Entitlements

Grants

Features

Fees

Plans

Prices

Products

Sources

Subscriptions

Users

Invoices V2

Payments

Payment Sessions

Events

Costs

Revenue

Profitability

Test Clocks

ExternalReferences

Items

Orders

Billing Schedules

Salesforce

MerchantIntegrations

Approvals

Authorizations

Path Parameters

Body

Response