Factuarea APIDevelopers

List all recurring invoices

List your recurring invoice templates with cursor-based pagination.

GET
/recurring_invoices
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Number of objects to return. Integer between 1 and 100. Defaults to 25.

Default25
Range1 <= value <= 100
starting_after?string

Cursor for forward pagination. Use the uuid of the last object on the previous page.

Formatuuid
ending_before?string

Cursor for backward pagination. Use the uuid of the first object on the current page.

Formatuuid
status?string

Recurring plan status. Exact match on status.

status[in]?string

Recurring plan status. Comma-separated list. Any of the values matches.

client_id?string

Client ID (UUID v7). Exact match on client_id.

Formatuuid
client_id[in]?string

Client ID (UUID v7). Comma-separated list. Any of the values matches.

frequency?string

Issuance frequency (e.g. monthly, yearly). Exact match on frequency.

frequency[in]?string

Issuance frequency (e.g. monthly, yearly). Comma-separated list. Any of the values matches.

next_run_at[gte]?string

Next run date. Greater than or equal to the given value.

Formatdate-time
next_run_at[lte]?string

Next run date. Less than or equal to the given value.

Formatdate-time
next_run_at[gt]?string

Next run date. Strictly greater than the given value.

Formatdate-time
next_run_at[lt]?string

Next run date. Strictly less than the given value.

Formatdate-time
name?string

Name of the recurring plan. Exact match on name.

name[contains]?string

Name of the recurring plan. Partial case-insensitive match (LIKE %term%) on name.

tags?string

Filter by classification tag (lowercase slug). Supports multiple values with tags[in]=a,b (JSON_CONTAINS, OR semantics — matches recurring invoices carrying ANY of the tags). Exact match on tags.

tags[in]?string

Filter by classification tag (lowercase slug). Supports multiple values with tags[in]=a,b (JSON_CONTAINS, OR semantics — matches recurring invoices carrying ANY of the tags). Comma-separated list. Any of the values matches.

sort?string

Sort order. Use a field for ascending or a - prefix for descending (e.g. -created). Allowed fields: created, next_run_at. Combined with the cursor, ordering stays deterministic (a stable secondary sort by the cursor id, Stripe-style). When omitted, results follow the default cursor order (created descending).

Value in"created" | "-created" | "next_run_at" | "-next_run_at"
search?string

Free-text search. Escaped LIKE %term% (case-insensitive, max 80 chars) across the resource's key text columns, combined with the other filters (AND) and compatible with the cursor.

Lengthlength <= 80
metadata?

Filter by metadata key/value pairs using the deepObject syntax metadata[key]=value. Multiple pairs are combined with AND. Each key must match [A-Za-z0-9_.-]{1,64}; a maximum of 50 pairs is allowed (more → 422).

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
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json