Factuarea APIDevelopers

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

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

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

Formatuuid
recurring_invoice*string

Public identifier (UUID v7) of the recurring invoice.

Formatuuid

Query Parameters

count?string

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

expand?string

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

Headers

Factuarea-Version?string

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.

Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json