Skip to Content
DevelopersAPI referenceRecurring invoices

Run (recurring invoices)

POST
/v1/recurring-invoices/{id}/run

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Response Body

application/json
  1. response
schedule*
invoiceId*string|null
invoiceNumber*string|null
sent*boolean
Example Request
curl -X POST 'https://your-billleaf-api/v1/recurring-invoices/string/run'
Example Response200
{  "schedule": {    "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"  },  "invoiceId": "string",  "invoiceNumber": "string",  "sent": true}