Invoice Status Timeline

GET

invoices

{id}

status-history

Invoice status timeline

curl --request GET \
  --url https://billing.example.com/v1/invoices/{id}/status-history \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/invoices/{id}/status-history"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/invoices/{id}/status-history', 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://billing.example.com/v1/invoices/{id}/status-history",
  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: Bearer <token>"
  ],
]);

$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://billing.example.com/v1/invoices/{id}/status-history"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/invoices/{id}/status-history")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "history": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "from_status": "<string>",
        "to_status": "<string>",
        "changed_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Returns the invoice’s status timeline — every transition of its status (draft → open → paid / past_due / uncollectible / void), oldest first. Transitions are captured by a database trigger at the source of truth, so no transition is missed, including automatic ones (a dunning worker marking an invoice past_due, say). The first row is the creation state, so its from_status is null.

Example Response

{
  "data": {
    "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
    "history": [
      {
        "id": "2b3c4d5e-6f70-4a81-9b2c-3d4e5f6a7b8c",
        "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
        "from_status": null,
        "to_status": "draft",
        "changed_at": "2026-07-01T00:00:00Z"
      },
      {
        "id": "4d5e6f70-8a91-4b2c-9d3e-4f5a6b7c8d9e",
        "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
        "from_status": "draft",
        "to_status": "open",
        "changed_at": "2026-07-01T00:05:00Z"
      },
      {
        "id": "6f708a91-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
        "invoice_id": "06c151de-8d3a-4b21-9c77-2f0e5a9b4d12",
        "from_status": "open",
        "to_status": "paid",
        "changed_at": "2026-07-03T14:22:10Z"
      }
    ]
  }
}

Read-only, and derived from a trigger — the timeline fills in as the invoice’s status actually changes. An existing invoice with no recorded transitions returns an empty history list; a missing or cross-tenant id returns 404.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

string<uuid>

required

Response

The invoice's status timeline.

data

object

Show child attributes

Invoice status timeline

curl --request GET \
  --url https://billing.example.com/v1/invoices/{id}/status-history \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/invoices/{id}/status-history"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/invoices/{id}/status-history', 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://billing.example.com/v1/invoices/{id}/status-history",
  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: Bearer <token>"
  ],
]);

$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://billing.example.com/v1/invoices/{id}/status-history"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/invoices/{id}/status-history")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "history": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "from_status": "<string>",
        "to_status": "<string>",
        "changed_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Invoice Status Timeline

Example Response

Authorizations

Path Parameters

Response

​Example Response

Authorizations

Path Parameters

Response

Example Response