RecurringInvoices

Get the generation history of a recurring invoice

Deprecated. Use GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/history.

Returns the invoices previously generated from this recurring template, including their status and generation dates. Only generated invoices: this route never reports failed runs, skipped slots or pauses — the successor does.

  • Response shape: it differs from the successor's, and that is why this notice exists. This route is frozen as it shipped until its Sunset date: it returns the whole history in data.history and carries no pagination. The successor pages with page/limit and answers the first 20 entries by default. Send limit and read data.pagination when you migrate.

Retires on 9 December 2026. See the migration guide for what moved where and what changes when you switch.

get/v1/recurring-invoices/{recurring_invoice_id}/history

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/recurring-invoices/{recurring_invoice_id}/history
  • Auth: HTTP bearer

Path parameters

recurring_invoice_idstring uuid required

Unique identifier (UUID) of the recurring invoice template, as returned when it is created or listed. A template of another company answers 404 with RECURRING_NOT_FOUND, exactly like one that does not exist.

Response

Generation history retrieved successfully

successboolean required

Example response

{
  "success": true,
  "data": {
    "history": [
      {
        "type": "GENERATED",
        "origin": "UNATTENDED"
      }
    ]
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.