Create billing config
curl --request POST \
--url https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-admin-api-key: <x-admin-api-key>' \
--data '
{
"configKey": "timing_policy",
"configCategory": "upgrade",
"status": "active",
"description": "Immediate Upgrade"
}
'import requests
url = "https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs"
payload = {
"configKey": "timing_policy",
"configCategory": "upgrade",
"status": "active",
"description": "Immediate Upgrade"
}
headers = {
"x-admin-api-key": "<x-admin-api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-admin-api-key': '<x-admin-api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
configKey: 'timing_policy',
configCategory: 'upgrade',
status: 'active',
description: 'Immediate Upgrade'
})
};
fetch('https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs', 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/billing-configs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'configKey' => 'timing_policy',
'configCategory' => 'upgrade',
'status' => 'active',
'description' => 'Immediate Upgrade'
]),
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/billing-configs"
payload := strings.NewReader("{\n \"configKey\": \"timing_policy\",\n \"configCategory\": \"upgrade\",\n \"status\": \"active\",\n \"description\": \"Immediate Upgrade\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs")
.header("x-admin-api-key", "<x-admin-api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"configKey\": \"timing_policy\",\n \"configCategory\": \"upgrade\",\n \"status\": \"active\",\n \"description\": \"Immediate Upgrade\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-admin-api-key"] = '<x-admin-api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configKey\": \"timing_policy\",\n \"configCategory\": \"upgrade\",\n \"status\": \"active\",\n \"description\": \"Immediate Upgrade\"\n}"
response = http.request(request)
puts response.read_body{
"configKey": "timing_policy",
"configValue": "immediate",
"configCategory": "upgrade",
"status": "active",
"description": "Immediate Upgrade"
}Billing Configs
Create billing config
Create a new billing config with the provided details. Note: This endpoint is restricted for internal use only.
POST
/
api
/
v1
/
billing-configs
Create billing config
curl --request POST \
--url https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-admin-api-key: <x-admin-api-key>' \
--data '
{
"configKey": "timing_policy",
"configCategory": "upgrade",
"status": "active",
"description": "Immediate Upgrade"
}
'import requests
url = "https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs"
payload = {
"configKey": "timing_policy",
"configCategory": "upgrade",
"status": "active",
"description": "Immediate Upgrade"
}
headers = {
"x-admin-api-key": "<x-admin-api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-admin-api-key': '<x-admin-api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
configKey: 'timing_policy',
configCategory: 'upgrade',
status: 'active',
description: 'Immediate Upgrade'
})
};
fetch('https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs', 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/billing-configs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'configKey' => 'timing_policy',
'configCategory' => 'upgrade',
'status' => 'active',
'description' => 'Immediate Upgrade'
]),
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/billing-configs"
payload := strings.NewReader("{\n \"configKey\": \"timing_policy\",\n \"configCategory\": \"upgrade\",\n \"status\": \"active\",\n \"description\": \"Immediate Upgrade\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs")
.header("x-admin-api-key", "<x-admin-api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"configKey\": \"timing_policy\",\n \"configCategory\": \"upgrade\",\n \"status\": \"active\",\n \"description\": \"Immediate Upgrade\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-billing-api.iqraa.ai/api/v1/api/v1/billing-configs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-admin-api-key"] = '<x-admin-api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configKey\": \"timing_policy\",\n \"configCategory\": \"upgrade\",\n \"status\": \"active\",\n \"description\": \"Immediate Upgrade\"\n}"
response = http.request(request)
puts response.read_body{
"configKey": "timing_policy",
"configValue": "immediate",
"configCategory": "upgrade",
"status": "active",
"description": "Immediate Upgrade"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The API key to access the admin API
Body
application/json
Config key - either a type or plan code
Available options:
timing_policy Config value - either a type or grace period days
Available options:
immediate, next_cycle Config key type (e.g. upgrade, downgrade, terminate)
Example:
"upgrade"
Status Type (e.g. active)
Example:
"active"
Description of the billing config
Example:
"Immediate Upgrade"
Response
Billing config created successfully
Config key - either a type or plan code
Available options:
timing_policy Config value - either a type or grace period days
Available options:
immediate, next_cycle Config key type (e.g. upgrade, downgrade, terminate)
Example:
"upgrade"
Status Type (e.g. active)
Example:
"active"
Description of the billing config
Example:
"Immediate Upgrade"