API Reference

Create a recurring invoice

post
https://api.wingspan.app/v3/payments/recurring-invoices

Create a schedule-driven RecurringInvoice (AR) that generates an Invoice each period. Idempotent via Idempotency-Key. Fires RecurringInvoice.Created. If externalId is already used by another resource of this type for the owning Account, returns 409 ResourceConflict; create is not an upsert. Supplying payerId resolves or creates the contractor-owned default PayerEngagement. Supplying payerEngagementId requires a contractor-owned PayerEngagement for the calling Account. Returns 404 ResourceNotFound when the relationship is unknown or unowned, or the engagement cannot be seated that way.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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:
string
string
required
^[A-Za-z0-9_.]{22,80}$
string
string
required
schedule
object
required

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

boolean

Auto-open and email each generated Invoice.

boolean

Auto-pay each generated Invoice when a payment method is on file.

invoiceTemplate
object
required

Per-occurrence Invoice body stamped onto each generated Invoice. Template purity — no id / status / events / actors / absolute dueDate / invoiceNumber; the due date is set relatively via paymentTermsDays.

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.

string
enum

Defaults to Active when omitted. Create accepts Active or Draft only.

Allowed:
Headers
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.

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

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 3 months ago

Did this page help you?