Update a recurring invoice

patch

https://api.wingspan.app/v3/payments/recurring-invoices/{recurringInvoiceId}

Update the schedule, invoice template body, or metadata. The only status transition accepted here is Draft to Active (sending the saved recurrence); pause, resume, and cancel use their action verbs. Omitted top-level fields are left unchanged. When supplied, invoiceTemplate merges into the stored template body. Omitted body fields remain unchanged and an explicit null clears a nullable field. When supplied, lineItems replaces the whole array; omitted lineItems remain unchanged. A body change applies to later occurrences.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

recurringInvoiceId

string

required

Body Params

automaticCollectionMode

string

enum

Most-specific explicit setting wins: recurring invoice, then Engagement, then Payer. Inherit clears this scope's preference. Omission on PATCH leaves it unchanged. Changes govern new payment reservations.

Allowed:

schedule

object

Schedule for a schedule-driven recurrence (RecurringInvoice / RecurringPayable), in interval-multiplier form. NOT present on rule-driven RecurringDeduction / RecurringCredit.

shouldAutoSend

boolean

shouldAutoPay

boolean

invoiceTemplate

object

Partial per-occurrence Invoice template update. Every field is optional; omitted fields retain their stored value.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

status

string

enum

The only supported status transition through update is Draft to Active.

Allowed:

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

If-Match

string

Strong ETag from a prior GET or write response. Mismatch returns 412 Precondition Failed. Pass * to accept any current state.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated recurring invoice

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

412Optimistic-concurrency precondition failed (If-Match mismatch)

422Validation error