Skip an occurrence
Skip an occurrence. Skip one explicit slot of an ACTIVE/NEEDS_ATTENTION series. A slot that is already handled is a 409, so a retry can never skip a second invoice. Scope: write. Manager, Admin or Owner token (Members get 403). Requires the Studio plan or higher (`recurringBilling`, 402 otherwise). While recurring invoices are temporarily unavailable, every recurring endpoint returns a definitive 409 `conflict`.
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Path Parameters
Recurring invoice series id.
Header Parameters
Caller-generated UUID/ULID; replay returns the cached response within 24h.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/recurring-invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/skip" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "scheduledDate": "2019-08-24" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "occurrenceId": "740a3903-0839-47b4-bce7-bee5e46cbf4a", "scheduledDate": "2019-08-24", "state": "SKIPPED_USER", "series": { "status": "ACTIVE", "nextScheduledDate": "2019-08-24", "revision": 0, "generatedInvoiceCount": 0 } }, "warnings": [ "string" ]}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}Resume recurring invoice
Resume a PAUSED series (409 otherwise). Never backfills: passed slots become MISSED; completes when no slot remains. Re-arms automatic sending for AUTO_SEND series, so it needs confirmAutoSend: true when an upcoming slot will be emailed (422 otherwise, nothing changed). Scope: write. Manager, Admin or Owner token (Members get 403). Requires the Studio plan or higher (`recurringBilling`, 402 otherwise). While recurring invoices are temporarily unavailable, every recurring endpoint returns a definitive 409 `conflict`.
Undo a skipped occurrence
Restore a SKIPPED_USER slot before its run time (409 afterwards or for ENDED series). The slot returns to PENDING on the revision in force for its date now, with issue and due dates recomputed, not the revision it had when skipped; confirmAutoSend is required when that revision is AUTO_SEND. Scope: write. Manager, Admin or Owner token (Members get 403). Requires the Studio plan or higher (`recurringBilling`, 402 otherwise). While recurring invoices are temporarily unavailable, every recurring endpoint returns a definitive 409 `conflict`.