Update a charge
curl --request PATCH \
--url https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-admin-api-key: <x-admin-api-key>' \
--data '
{
"name": "Extra Storage",
"code": "extra_storage",
"description": "Additional storage space for your account",
"amount": 1000,
"currency": "USD",
"entitlementCode": "EXTRA_STORAGE_ENTITLEMENT",
"billableMetricOverrides": {
"fieldName": "storage_gb",
"aggregatorType": "sum",
"description": "Total storage used in GB"
}
}
'import requests
url = "https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}"
payload = {
"name": "Extra Storage",
"code": "extra_storage",
"description": "Additional storage space for your account",
"amount": 1000,
"currency": "USD",
"entitlementCode": "EXTRA_STORAGE_ENTITLEMENT",
"billableMetricOverrides": {
"fieldName": "storage_gb",
"aggregatorType": "sum",
"description": "Total storage used in GB"
}
}
headers = {
"x-admin-api-key": "<x-admin-api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-admin-api-key': '<x-admin-api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Extra Storage',
code: 'extra_storage',
description: 'Additional storage space for your account',
amount: 1000,
currency: 'USD',
entitlementCode: 'EXTRA_STORAGE_ENTITLEMENT',
billableMetricOverrides: {
fieldName: 'storage_gb',
aggregatorType: 'sum',
description: 'Total storage used in GB'
}
})
};
fetch('https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{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://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{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' => 'Extra Storage',
'code' => 'extra_storage',
'description' => 'Additional storage space for your account',
'amount' => 1000,
'currency' => 'USD',
'entitlementCode' => 'EXTRA_STORAGE_ENTITLEMENT',
'billableMetricOverrides' => [
'fieldName' => 'storage_gb',
'aggregatorType' => 'sum',
'description' => 'Total storage used in GB'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-admin-api-key: <x-admin-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://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}"
payload := strings.NewReader("{\n \"name\": \"Extra Storage\",\n \"code\": \"extra_storage\",\n \"description\": \"Additional storage space for your account\",\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"entitlementCode\": \"EXTRA_STORAGE_ENTITLEMENT\",\n \"billableMetricOverrides\": {\n \"fieldName\": \"storage_gb\",\n \"aggregatorType\": \"sum\",\n \"description\": \"Total storage used in GB\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-admin-api-key", "<x-admin-api-key>")
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://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}")
.header("x-admin-api-key", "<x-admin-api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Extra Storage\",\n \"code\": \"extra_storage\",\n \"description\": \"Additional storage space for your account\",\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"entitlementCode\": \"EXTRA_STORAGE_ENTITLEMENT\",\n \"billableMetricOverrides\": {\n \"fieldName\": \"storage_gb\",\n \"aggregatorType\": \"sum\",\n \"description\": \"Total storage used in GB\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-admin-api-key"] = '<x-admin-api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Extra Storage\",\n \"code\": \"extra_storage\",\n \"description\": \"Additional storage space for your account\",\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"entitlementCode\": \"EXTRA_STORAGE_ENTITLEMENT\",\n \"billableMetricOverrides\": {\n \"fieldName\": \"storage_gb\",\n \"aggregatorType\": \"sum\",\n \"description\": \"Total storage used in GB\"\n }\n}"
response = http.request(request)
puts response.read_bodycharges
Update a charge
PATCH
/
api
/
v1
/
charges
/
{id}
Update a charge
curl --request PATCH \
--url https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-admin-api-key: <x-admin-api-key>' \
--data '
{
"name": "Extra Storage",
"code": "extra_storage",
"description": "Additional storage space for your account",
"amount": 1000,
"currency": "USD",
"entitlementCode": "EXTRA_STORAGE_ENTITLEMENT",
"billableMetricOverrides": {
"fieldName": "storage_gb",
"aggregatorType": "sum",
"description": "Total storage used in GB"
}
}
'import requests
url = "https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}"
payload = {
"name": "Extra Storage",
"code": "extra_storage",
"description": "Additional storage space for your account",
"amount": 1000,
"currency": "USD",
"entitlementCode": "EXTRA_STORAGE_ENTITLEMENT",
"billableMetricOverrides": {
"fieldName": "storage_gb",
"aggregatorType": "sum",
"description": "Total storage used in GB"
}
}
headers = {
"x-admin-api-key": "<x-admin-api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-admin-api-key': '<x-admin-api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Extra Storage',
code: 'extra_storage',
description: 'Additional storage space for your account',
amount: 1000,
currency: 'USD',
entitlementCode: 'EXTRA_STORAGE_ENTITLEMENT',
billableMetricOverrides: {
fieldName: 'storage_gb',
aggregatorType: 'sum',
description: 'Total storage used in GB'
}
})
};
fetch('https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{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://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{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' => 'Extra Storage',
'code' => 'extra_storage',
'description' => 'Additional storage space for your account',
'amount' => 1000,
'currency' => 'USD',
'entitlementCode' => 'EXTRA_STORAGE_ENTITLEMENT',
'billableMetricOverrides' => [
'fieldName' => 'storage_gb',
'aggregatorType' => 'sum',
'description' => 'Total storage used in GB'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-admin-api-key: <x-admin-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://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}"
payload := strings.NewReader("{\n \"name\": \"Extra Storage\",\n \"code\": \"extra_storage\",\n \"description\": \"Additional storage space for your account\",\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"entitlementCode\": \"EXTRA_STORAGE_ENTITLEMENT\",\n \"billableMetricOverrides\": {\n \"fieldName\": \"storage_gb\",\n \"aggregatorType\": \"sum\",\n \"description\": \"Total storage used in GB\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-admin-api-key", "<x-admin-api-key>")
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://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}")
.header("x-admin-api-key", "<x-admin-api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Extra Storage\",\n \"code\": \"extra_storage\",\n \"description\": \"Additional storage space for your account\",\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"entitlementCode\": \"EXTRA_STORAGE_ENTITLEMENT\",\n \"billableMetricOverrides\": {\n \"fieldName\": \"storage_gb\",\n \"aggregatorType\": \"sum\",\n \"description\": \"Total storage used in GB\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-billing-api.iqraa.ai/api/v1/api/v1/charges/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-admin-api-key"] = '<x-admin-api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Extra Storage\",\n \"code\": \"extra_storage\",\n \"description\": \"Additional storage space for your account\",\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"entitlementCode\": \"EXTRA_STORAGE_ENTITLEMENT\",\n \"billableMetricOverrides\": {\n \"fieldName\": \"storage_gb\",\n \"aggregatorType\": \"sum\",\n \"description\": \"Total storage used in GB\"\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The API key to access the admin API
Path Parameters
Body
application/json
The name of the charge
Example:
"Extra Storage"
Unique code identifier for the charge
Example:
"extra_storage"
Description of the charge
Example:
"Additional storage space for your account"
The price of the charge
Required range:
x >= 0Example:
1000
The currency for the charge
Example:
"USD"
The entitlement code this charge is associated with
Example:
"EXTRA_STORAGE_ENTITLEMENT"
Optional overrides for billable metric configuration
Example:
{
"fieldName": "storage_gb",
"aggregatorType": "sum",
"description": "Total storage used in GB"
}
Response
Charge updated successfully
⌘I