Skip to main content
Call GET /api/invoices/{id} to fetch the complete invoice record. The response includes all merchant and vendor details captured at creation time, the full line-item breakdown with computed totals, current payment status, and a derived overdue field that tells you whether the due date has passed without full payment.

Request

GET https://pay.kibble.sh/api/invoices/{id}

Path parameters

id
string
required
The invoice UUID returned as invoice_id when you created the invoice.

Example request

cURL
curl --request GET \
  --url https://pay.kibble.sh/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890

Response

A successful request returns 200 OK with the following fields.
id
string
required
The invoice UUID.
invoice_number
string
required
The human-readable invoice identifier (e.g. "INV-0001").
slug
string
required
The short identifier used in the hosted invoice URL.
merchant_name_snapshot
string
required
Your business name as it was recorded at invoice creation time.
merchant_address_snapshot
string
required
Your business address as it was recorded at invoice creation time. This value is immutable after creation.
vendor_name
string
required
The vendor’s name.
vendor_email
string
required
The vendor’s email address.
issue_date
string
required
The invoice issue date in YYYY-MM-DD format.
due_date
string
required
The payment due date in YYYY-MM-DD format.
total_amount
string
required
The sum of all line item totals, in USDC (e.g. "1500.00").
status
string
required
The current invoice status. Possible values are draft, sent, paid, partial, and excess. See Invoice status for definitions.
notes
string
Free-text notes shown on the invoice, if any were provided at creation.
line_items
object[]
required
The array of line items on this invoice.
overdue
boolean
required
true if today’s date is past due_date and the invoice has not reached paid status.
sent_at
string
ISO 8601 timestamp of when the vendor email was sent. null if the invoice is in draft status.

Example response

200
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "invoice_number": "INV-0001",
  "slug": "abc12345",
  "merchant_name_snapshot": "Acme SaaS",
  "merchant_address_snapshot": "123 Main St, San Francisco, CA 94105",
  "vendor_name": "Vendor Co",
  "vendor_email": "vendor@example.com",
  "issue_date": "2026-04-28",
  "due_date": "2026-05-28",
  "total_amount": "1500.00",
  "status": "sent",
  "notes": "Net 30",
  "line_items": [
    {
      "description": "Consulting — April",
      "quantity": 10,
      "unit_price": "150.00",
      "line_total": "1500.00"
    }
  ],
  "overdue": false,
  "sent_at": "2026-04-28T12:00:00Z"
}