Recurring Invoices

Preview upcoming recurring invoice dates

Return the next scheduled run dates with their due dates and estimated totals. Defaults to 5 occurrences.

get/companies/{company}/recurring-invoices/{recurring_invoice}/preview

Request

Base URL: https://api.factuarea.com/v1
URL: https://api.factuarea.com/v1/companies/{company}/recurring-invoices/{recurring_invoice}/preview
Auth: one of:
- HTTP bearer
- API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

recurring_invoicestring uuid required

Public identifier (UUID v7) of the recurring invoice.

Query parameters

countstring

Number of upcoming occurrences to preview, between 1 and 36 (default 5).

expandstring

Send document to also return next_invoice, a full preview of the next invoice.

Headers

Factuarea-Versionstring date

Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Upcoming dates. When expand=document is supplied, next_invoice includes the computed lines and totals without persisting an invoice.

Example response

{
  "data": [
    {
      "estimated_total": "242.00"
    }
  ],
  "next_invoice": {
    "lines": [
      {
        "unit_price": "100.0000",
        "subtotal": "200.00",
        "tax": "42.00",
        "line_total": "242.00"
      }
    ],
    "totals": {
      "subtotal": "200.00",
      "tax": "42.00",
      "total": "242.00"
    }
  }
}

Changes

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