POST /v1/recurring-invoices/{id}/pause

POST

/v1/recurring-invoices/{id}/pause

curl --request POST \
  --url https://api.asap.cool/v1/recurring-invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/pause

• Production

Parameters

Path Parameters

id

required

string format: uuid

Recurring template identifier.

Responses

200

The paused template.

Media type application/json

Public projection of a [RecurringInvoice].

object

auto_collect_sepa

required

Whether each auto-sent invoice is debited off-session via a stored SEPA mandate (per-series opt-in; defaults to false).

boolean

auto_send

required

Whether generated drafts are finalized and sent automatically.

boolean

contact_id

required

Target contact.

string format: uuid

created_at

required

RFC3339 creation timestamp.

string

frequency

required

Cadence (monthly/quarterly/yearly).

string

id

required

Stable identifier.

string format: uuid

items

required

Line items snapshot (JSONB array).

object

next_generation_date

required

Next generation date (YYYY-MM-DD).

string

notes

Optional notes for generated documents.

string | null

operation_nature

Operation nature (biens/services/mixte) applied to generated documents; null when unset.

string | null

paused_at

RFC3339 pause timestamp, or null when active.

string | null

status

required

Lifecycle status derived from paused_at: "active" or "paused".

string

title

Optional title for generated documents.

string | null

updated_at

required

RFC3339 last-update timestamp.

string

Example ^generated

{
  "auto_collect_sepa": true,
  "auto_send": true,
  "contact_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "created_at": "example",
  "frequency": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "items": {},
  "next_generation_date": "example",
  "notes": "example",
  "operation_nature": "example",
  "paused_at": "example",
  "status": "example",
  "title": "example",
  "updated_at": "example"
}

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing invoice:write scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

404

Not found or cross-org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}