Scope: sales:invoices.read https://api.alladdin.com/api/v2/recurring-invoices/{invoiceRecurringId}/schedule

Returns the occurrence schedule for a recurring invoice, including past converted, skipped, and future pending dates.

Parameters

Path parameters

invoiceRecurringId string required

Recurring invoice ID (24-char hex ObjectId)

Query parameters

until string<date> optional

Upper date boundary (YYYY-MM-DD). Defaults to one year from today.

Request

import requests

url = "https://api.alladdin.com/api/v2/recurring-invoices/{invoiceRecurringId}/schedule?until=value"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Success responses

200 Recurring invoice schedule

Error responses

401 Invalid or missing API key application/json 404 Recurring invoice not found application/json

← PreviousGet a recurring invoice →

Next →Delete a recurring invoice →