Skip to main content

Billing API

The Billing API lets you fetch invoices and payment status for an organization.

Get Billing Data

Get billing data for an organization. The response includes a list of subscription invoices with their payment status.
GET /api/v2/platform/organisation/billing/

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number (default: 1)
page_sizeintegerNoNumber of invoices per page (default: 20)

Headers

HeaderTypeRequiredDescription
Org-HandlestringYesOrganization domain handle
Product-IdstringNoProduct identifier (default: unpod.dev)
AuthorizationstringYesjwt <token>

Example Request

curl -X GET \
  'http://127.0.0.1:8000/api/v2/platform/organisation/billing/?page=1&page_size=10' \
  -H 'accept: application/json' \
  -H 'Org-Handle: recalll.co' \
  -H 'Product-Id: unpod.dev' \
  -H 'Authorization: jwt <token>'

Response

{
  "count": 17,
  "status_code": 200,
  "message": "Billing data fetched successfully",
  "data": [
    {
      "invoice_number": "INV-00118",
      "amount": "1357.35",
      "tax_amount": "207.05",
      "currency": "INR",
      "status": "pending",
      "charge_type": "subscription",
      "invoice_date": "2026-01-04T00:00:15.045893Z",
      "due_date": "2026-01-11T00:00:15.045893Z",
      "payment_at": null
    }
  ]
}

Response Fields

FieldTypeDescription
messagestringStatus message
status_codeintegerHTTP-like status code
countintegerTotal number of invoices
dataarrayList of invoice objects
Each invoice object includes:
FieldTypeDescription
invoice_numberstringInvoice identifier
amountstring or numberInvoice amount
tax_amountstring or numberTax amount
currencystringCurrency code
statusstringPayment status
charge_typestringCharge type
invoice_datestring (ISO 8601)Invoice date
due_datestring (ISO 8601)Due date
payment_atstring (ISO 8601)Payment timestamp or null

Error Responses

400 Bad request - missing required headers. 401 Unauthorized
{
  "status_code": 401,
  "message": "Authentication credentials were not provided."
}
404 Organization not found.