RecurringInvoices

Get a recurring invoice

Deprecated. Use GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}, which behaves identically.

Retrieves the full details of a recurring invoice template, including its schedule, template lines and next generation date.

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}

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/recurring-invoices/{recurring_invoice_id}
  • 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

Recurring invoice retrieved successfully

successboolean required

Example response

{
  "success": true,
  "data": {
    "draft_in_advance": true,
    "status": "ACTIVE",
    "pause": {
      "reason": "GENERATION_FAILURE",
      "blocker": "NIF_NOT_REGISTERED"
    },
    "lines": [
      {
        "pricing_mode": "UNIT_PRICE",
        "total_excluding_tax": 1,
        "total_including_tax": 100,
        "exemption_reason": "EXENTA_ART_20"
      }
    ],
    "amount": 106,
    "custom_fields": [
      {
        "key": "project",
        "label": "Project",
        "value": "Corporate website"
      }
    ],
    "max_invoices": 6,
    "last_generated_scheduled_date": "2026-05-01"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

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