Skip to Content
DevelopersAPI referenceRecurring invoices

List recurring invoices

GET
/v1/recurring-invoices

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (blk_…) from Settings → API keys.

Query Parameters

page?integer
Range1 <= value <= 100000
Default1
pageSize?integer
Range1 <= value <= 100
Default25
sort?string
Match^[A-Za-z]+:(asc|desc)$
status?string
Value in"active""paused""ended"
q?string
Lengthlength <= 100

Response Body

application/json
  1. response
items*array<>
total*integer
Range-9007199254740991 <= value <= 9007199254740991
page*integer
Range-9007199254740991 <= value <= 9007199254740991
pageSize*integer
Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'https://your-billleaf-api/v1/recurring-invoices'
Example Response200
{  "items": [    {      "id": "string",      "clientId": "string",      "clientName": "string",      "title": "string",      "currency": "string",      "lines": [        {          "description": "string",          "quantity": 1,          "unitPrice": 0,          "taxRateBps": 0        }      ],      "total": -9007199254740991,      "every": -9007199254740991,      "unit": "week",      "startDate": "2019-08-24",      "endDate": "2019-08-24",      "maxOccurrences": -9007199254740991,      "nextRunDate": "2019-08-24",      "dueDays": -9007199254740991,      "mode": "draft",      "status": "active",      "notes": "string",      "terms": "string",      "generatedCount": -9007199254740991,      "lastRunAt": "2019-08-24T14:15:22Z",      "lastError": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}