Read documents for your Telegram subscription bot or Discord subscription bot project.
API key access: Unrestricted project key required. There is no issuable documents:read API-key scope. Restricted keys cannot call this endpoint.
List returns an array in data with required top-level total, limit and offset. Both parent fields are needed to filter; otherwise the list is unfiltered. No matches returns 200 with data: [], which does not establish whether the parent exists.
Required, non-null fields: document_id (UUID string), kind (enum), filename (string, possibly empty), file_size (number of bytes), and created_at (UTC ISO datetime string).
kind is invoice, receipt, usage_report, credit_note, reverse_invoice, refund_note, or payout_statement.
Optional UUID-or-null fields: payment_request_id, invoice_id, project_id, and customer_id. project_name is an optional string-or-null. download_url is an optional URL string, never null; it is omitted when unavailable.
GET/v2/projects/{project_id}/documents
Authorization
Bearer API KeyRequired
Path Parameters
project_idstringrequired
Project UUID.
Query Parameters
parent_typestring
invoice, subscription or paymentRequest (case-sensitive). Supply with parent_id.
parent_idstring
Parent identifier; no UUID constraint. Supply with parent_type.
