GET/v1/billing/statements/{month}

The usage statement of a month

Usage per product, finish, destination and run plus fees and adjustments for YYYY-MM; add format=csv for a CSV body (text/csv) with the lines.

Scope billing.readRate limit class export

Path parameters

monthstringrequired

Returns

9 fields of the 200 answer

organisationIdstringrequired

monthstringrequired

periodFromdaterequired

periodTodaterequired

billingModeenumrequired

PREPAIDTRIALINVOICE

currencystringrequired

linesarray of objectsrequired

8 fields

positionintegerrequired

kindenumrequired

TOP_UPUSAGESUBSCRIPTION_FEEADJUSTMENTCREDIT

descriptionstringrequired

quantityintegerrequired

unitPriceCentsintegerrequired

amountCentsintegerrequired

referenceTypestring or nullrequired

referenceIdstring or nullrequired

subtotalCentsintegerrequired

invoicestring or nullrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.invoices.statement('obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

{ "organisationId": "org_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "month": "2026-10", "periodFrom": "2026-11-02", "periodTo": "2026-11-02", "billingMode": "PREPAID", "currency": "EUR", "lines": [ { "position": 1, "kind": "TOP_UP", "description": "Welcome card for new customers", "quantity": 1, "unitPriceCents": 1250, "amountCents": 1250, "referenceType": "Example", "referenceId": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K" } ], "subtotalCents": 1250, "invoice": "Example" }