Recurring invoices
Pause recurring invoice
Pause a recurring invoice. No new invoices will be generated until resumed. Reversible — use `resume`/`activate` to reactivate. For a permanent, irreversible stop use `cancel`.
AuthorizationBearer <token>
In: header
Path Parameters
recurring_invoice*string
Header Parameters
Idempotency-Key?string
Unique key generated by the client to ensure idempotency on retries. It lets you safely resend the same request: the first response is cached and returned without re-executing the mutation. It is an opaque string to the server; any unique value of up to 64 characters is valid (UUID v7, UUID v4, ULID, nanoid, etc.). UUID v7 is recommended for consistency with the API identifiers. The same key reused with a different body returns 409 idempotency_key_reused.
Length
1 <= length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
import { Factuarea } from "@factuarea/sdk";const factuarea = new Factuarea({ apiKey: process.env.FACTUAREA_API_KEY! });const result = await factuarea.recurringInvoices.pause("01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01");{
"data": {
"id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a08",
"object": "recurring_invoice",
"client": {
"id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
"name": "Acme Corporation"
},
"series": {
"id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
"code": "F-2026"
},
"status": "active",
"frequency": "monthly",
"name": "Cuota mantenimiento mensual Acme",
"description": "Contrato de soporte y mantenimiento Plan Pro",
"notes": "Renovación automática. Facturar el día 1 de cada mes.",
"email_to": "facturacion@acme.example",
"send_automatically": true,
"days_before_due": 30,
"max_occurrences": 12,
"occurrences_count": 3,
"remaining_occurrences": 9,
"holiday_handling": "next_business_day",
"start_on": "2026-01-01",
"end_on": "2026-12-31",
"next_run_at": "2026-02-01T09:00:00Z",
"last_run_at": "2026-01-01T09:00:00Z",
"cancelled_at": null,
"subtotal": 200,
"taxes_total": 42,
"total": 242,
"currency": "EUR",
"lines": [
{
"object": "recurring_invoice_line",
"description": "Cuota soporte mensual",
"quantity": 1,
"unit_price": 200,
"tax_rate": 21,
"retention": 0,
"surcharge": 0,
"subtotal": 200,
"taxes": 42,
"total": 242
}
],
"metadata": {
"erp_code": "IVA-GEN",
"ledger_account": "477000"
},
"external_id": "ERP-REC-2026-0008",
"tags": [
"suscripcion",
"mantenimiento"
],
"custom_fields": [
{
"field": "contrato",
"value": "CTR-2026-0007"
}
],
"created_at": "2025-12-20T15:00:00Z",
"updated_at": "2026-01-01T09:05:00Z"
}
}{
"error": {
"type": "authentication_error",
"code": "missing_api_key",
"message": "No se ha proporcionado una API key válida en el header Authorization.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
"request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
}
}{
"error": {
"type": "authorization_error",
"code": "insufficient_scope",
"message": "Esta API key no tiene el scope requerido para esta operación.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
"request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
}
}{
"error": {
"type": "idempotency_error",
"code": "idempotency_key_reused",
"message": "La cabecera `Idempotency-Key` ya se usó con un body distinto. Usa una clave nueva o reenvía exactamente el mismo body.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
"request_id": "req_01HKQS5NHT9A4U7R2E3F8GZWTJ"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
"request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
"request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
}
}