Get recurring invoice
GET
apiKeyheader
AuthorizationBearer <token>An API key (blk_…) from Settings → API keys.
id*stringapplication/json- response
id*stringclientId*stringclientName*stringtitle*string|nullcurrency*stringlines*array<>total*integerRange
-9007199254740991 <= value <= 9007199254740991every*integerRange
-9007199254740991 <= value <= 9007199254740991unit*stringValue in
"week""month""year"startDate*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
dateendDate*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
datemaxOccurrences*|Range
-9007199254740991 <= value <= 9007199254740991nextRunDate*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
datedueDays*|Range
-9007199254740991 <= value <= 9007199254740991mode*stringValue in
"draft""send"status*stringValue in
"active""paused""ended"notes*string|nullterms*string|nullgeneratedCount*integerRange
-9007199254740991 <= value <= 9007199254740991lastRunAt*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timelastError*string|nullcreatedAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timecurl -X GET 'https://your-billleaf-api/v1/recurring-invoices/string'Example Response200
{ "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"}