Skip to content
Hoursmith Docs
APIReferenceRecurring invoices

List recurring invoices

List recurring invoices. Cursor-paginated series list. Unknown or repeated scalar query parameters return 422. Scope: read. 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`.

GET
/recurring-invoices

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Query Parameters

cursor?string

Opaque; reuse unchanged.

limit?integer

Default 50.

sort?string

id, name, nextScheduledDate, createdAt, updatedAt; prefix - for descending. Default -createdAt.

status?string

Repeatable.

clientId?string

Repeatable (≤ 25).

search?string

Matches the series name.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/recurring-invoices"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "status": "ACTIVE",      "attentionCode": "string",      "attentionMessage": "string",      "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",      "clientName": "string",      "currency": "string",      "revision": 0,      "deliveryMode": "DRAFT",      "cadence": {        "unit": "DAY",        "interval": 0,        "timezone": "string",        "localRunTime": "string"      },      "nextScheduledDate": "2019-08-24",      "nextRunAt": "2019-08-24T14:15:22Z",      "pausedUntil": "2019-08-24",      "generatedInvoiceCount": 0,      "estimatedTotal": "string",      "includesVariableWork": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "warnings": [    "string"  ],  "pagination": {    "limit": 1,    "nextCursor": "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"  }}
Was this page helpful?