Skip to content
Hoursmith Docs
APIReferenceRecurring invoices

List recurring invoice occurrences

List recurring invoice occurrences. Stored occurrences from `from` merged with projected slots from max(from, today), ascending. Page with pagination.nextFrom. 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/{id}/occurrences

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Recurring invoice series id.

Query Parameters

from?string

Default: today in the series timezone.

limit?integer

Default 12.

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/occurrences"
{  "data": [    {      "scheduledDate": "2019-08-24",      "state": "SCHEDULED",      "occurrenceId": "740a3903-0839-47b4-bce7-bee5e46cbf4a",      "runAt": "2019-08-24T14:15:22Z",      "issueDate": "2019-08-24",      "dueDate": "2019-08-24",      "servicePeriodStart": "2019-08-24",      "servicePeriodEnd": "2019-08-24",      "hasOverride": true,      "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",      "invoice": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "number": "string",        "status": "string",        "total": "string",        "currency": "string"      },      "deliveryStatus": "string",      "skipReason": "string",      "failureMessage": "string"    }  ],  "warnings": [    "string"  ],  "pagination": {    "limit": 0,    "from": "2019-08-24",    "nextFrom": "2019-08-24"  }}
{  "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?