GET

api

platform

organisation

billing

Get Billing Data

curl --request GET \
  --url https://unpod.ai/api/v2/platform/organisation/billing/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/organisation/billing/"

headers = {
    "Org-Handle": "<org-handle>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};

fetch('https://unpod.ai/api/v2/platform/organisation/billing/', 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://unpod.ai/api/v2/platform/organisation/billing/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Org-Handle: <org-handle>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://unpod.ai/api/v2/platform/organisation/billing/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Org-Handle", "<org-handle>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/organisation/billing/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/organisation/billing/")

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

request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'

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

{
  "count": 12,
  "status_code": 200,
  "message": "Billing data fetched successfully",
  "results": [
    {
      "id": 101,
      "amount": "299.00",
      "currency": "USD",
      "status": "paid",
      "invoice_date": "2026-02-01T00:00:00Z"
    }
  ]
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

{
  "count": 12,
  "status_code": 200,
  "message": "Billing data fetched successfully",
  "results": [
    {
      "id": 101,
      "amount": "299.00",
      "currency": "USD",
      "status": "paid",
      "invoice_date": "2026-02-01T00:00:00Z"
    }
  ]
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

Get Billing Data

Retrieve invoices and payment history for your organization with pagination support. This endpoint returns billing records including invoice amounts, currency, payment status, and invoice dates.

Prerequisites: Make sure you have your API Token and Org-Handle ready. See Authentication for details.

Headers

Name	Type	Required	Description
Authorization	string	Yes	API Key format: `Token <token>`
Org-Handle	string	Yes	Organization domain handle

You can get the Org-Handle by hitting the Get All Organizations API. The domain_handle field in the response is your Org-Handle.

Query Parameters

Name	Type	Required	Description
page	integer	No	Page number for pagination (default = 1)
page_size	integer	No	Number of records per page (default = 20)

Response Fields

Field	Type	Description
count	integer	Total number of billing records
status_code	integer	HTTP status code
message	string	Response message
results	array	Array of invoice/billing objects

Invoice Object Fields

Field	Type	Description
id	integer	Unique invoice identifier
amount	string	Invoice amount as decimal string
currency	string	Currency code (e.g., `USD`, `INR`)
status	string	Payment status: `paid`, `pending`, `failed`
invoice_date	string	Invoice creation date (ISO 8601)

Common Error Codes

Status Code	Description
200	Success - Billing data fetched successfully
400	Bad Request - Invalid parameters provided
401	Unauthorized - Invalid or missing API token
403	Forbidden - Invalid organization handle
404	Not Found - Organization not found
500	Internal Server Error - Server-side error

Code Examples

const axios = require('axios');

const headers = {
  'Authorization': 'Token your-api-token',
  'Org-Handle': 'your-org-handle'
};

// Get billing data with pagination
const getBillingData = async (page = 1, pageSize = 20) => {
  const response = await axios.get(
    'https://unpod.ai/api/v2/platform/organisation/billing/',
    {
      headers,
      params: { page, page_size: pageSize }
    }
  );
  console.log(`Total invoices: ${response.data.count}`);
  response.data.results.forEach(invoice => {
    console.log(`Invoice #${invoice.id}: ${invoice.currency} ${invoice.amount} - ${invoice.status}`);
  });
  return response.data.results;
};

// Example usage
getBillingData(1, 20);

import requests

headers = {
    'Authorization': 'Token your-api-token',
    'Org-Handle': 'your-org-handle'
}

def get_billing_data(page: int = 1, page_size: int = 20):
    """Get billing invoices with pagination"""
    url = 'https://unpod.ai/api/v2/platform/organisation/billing/'
    params = {'page': page, 'page_size': page_size}
    response = requests.get(url, headers=headers, params=params)
    data = response.json()
    print(f"Total invoices: {data['count']}")
    for invoice in data['results']:
        print(f"Invoice #{invoice['id']}: {invoice['currency']} {invoice['amount']} - {invoice['status']}")
    return data['results']

# Example usage
get_billing_data(page=1, page_size=20)

# Get billing data
curl -X GET "https://unpod.ai/api/v2/platform/organisation/billing/?page=1&page_size=20" \
  -H "Authorization: Token your-api-token" \
  -H "Org-Handle: your-org-handle"

Best Practices

Pagination: Use page and page_size to retrieve billing records in manageable chunks
Status Monitoring: Watch for pending or failed invoice statuses that may require action
Currency Handling: Always check the currency field before displaying amounts to users
Org-Handle: Ensure the correct organization handle is used for accurate billing records
Reconciliation: Use invoice_date alongside id for billing reconciliation workflows
Security: Keep API tokens secure and rotate them regularly

Authorizations

Authorization

string

header

required

Format: Token

Headers

Org-Handle

string

required

Organization domain handle

Example:

"unpod.tv"

Query Parameters

page

integer

Example:

1

page_size

integer

Example:

20

Response

Billing data

OverviewIntroduction to the Billing API

Get Billing Data

curl --request GET \
  --url https://unpod.ai/api/v2/platform/organisation/billing/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/organisation/billing/"

headers = {
    "Org-Handle": "<org-handle>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};

fetch('https://unpod.ai/api/v2/platform/organisation/billing/', 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://unpod.ai/api/v2/platform/organisation/billing/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Org-Handle: <org-handle>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://unpod.ai/api/v2/platform/organisation/billing/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Org-Handle", "<org-handle>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/organisation/billing/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/organisation/billing/")

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

request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'

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

{
  "count": 12,
  "status_code": 200,
  "message": "Billing data fetched successfully",
  "results": [
    {
      "id": 101,
      "amount": "299.00",
      "currency": "USD",
      "status": "paid",
      "invoice_date": "2026-02-01T00:00:00Z"
    }
  ]
}

{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}

Getting Started

API Lists

Get Billing Data

Get Billing Data

Headers

Query Parameters

Response Fields

Invoice Object Fields

Common Error Codes

Code Examples

Best Practices

Authorizations

Headers

Query Parameters

Response

​Get Billing Data

​Headers

​Query Parameters

​Response Fields

​Invoice Object Fields

​Common Error Codes

​Code Examples

​Best Practices

Authorizations

Headers

Query Parameters

Response

Get Billing Data

Headers

Query Parameters

Response Fields

Invoice Object Fields

Common Error Codes

Code Examples

Best Practices