v1

latestOpenAPI 3.1.02026-08-06244570.4 KB
Account

List transactions

List transaction history for the authenticated user.

Authentication: API Key required (x-api-key header) or JWT token

Pagination: Use limit and offset query parameters.

Transaction types:

  • PDFGEN: PDF generation (consumes credits)
  • REFUND: Credit refund (on failed generation)
  • PURCHASE: Credit purchase
  • BONUS: Bonus credits

Credits field:

  • Positive value = credits consumed
  • Negative value = credits added

No credits consumed: This is a read-only endpoint.

Rate Limits: 60 requests/min (free), 120 requests/min (paid). Headers included in response.

get/v1/account/transactions

Query parameters

limitinteger

Number of records to return

Number of records to return

offsetinteger

Number of records to skip

Number of records to skip

Response

Transaction history

totalinteger required

Total number of transactions

limitinteger required

Number of records returned

offsetinteger required

Number of records skipped

Example response

{
  "limit": 300,
  "offset": 0,
  "total": 42,
  "transactions": [
    {
      "created_at": "2024-01-20T14:30:00Z",
      "credits": 1,
      "exec_tm": 1250,
      "template_id": "HMQywVpZxqAM",
      "transaction_ref": "550e8400-e29b-41d4-a716-446655440000",
      "transaction_type": "PDFGEN"
    },
    {
      "created_at": "2024-01-15T10:00:00Z",
      "credits": -100,
      "transaction_ref": "660e8400-e29b-41d4-a716-446655440001",
      "transaction_type": "PURCHASE"
    }
  ]
}