cURL
curl https://invoice.horizonpay.co/api/v1/webhook-endpoints \
-H "Authorization: Bearer $INVOICE_AI_API_KEY"import InvoiceAI from '@horizonpay/invoice-ai'
const invoiceai = new InvoiceAI() // reads INVOICE_AI_API_KEY
for await (const endpoint of invoiceai.webhookEndpoints.list()) {
console.log(endpoint.url, endpoint.active)
}from invoice_ai import InvoiceAI
client = InvoiceAI() # reads INVOICE_AI_API_KEY
for endpoint in client.webhook_endpoints.list():
print(endpoint.url, endpoint.active){
"data": [
{
"id": "4f9c2a1e-7b3d-4e8a-9c6f-2d1b0a3e5f71",
"url": "https://example.com/webhooks/invoice-ai",
"events": [
"invoice.finalized",
"invoice.paid"
],
"active": true,
"disabled_at": null,
"failure_count": 0,
"created_at": "2026-09-22T09:30:00.000Z"
}
],
"next_cursor": null
}{
"type": "https://invoice.horizonpay.co/problems/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Send your API key as `Authorization: Bearer inv_live_…`.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "unauthorized"
}{
"type": "https://invoice.horizonpay.co/problems/forbidden",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential is missing the invoices:write scope.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "forbidden"
}{
"type": "https://invoice.horizonpay.co/problems/validation",
"title": "Validation failed",
"status": 422,
"detail": "The cursor is not valid.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "validation",
"errors": [
{
"path": "cursor",
"message": "Pass the `next_cursor` from the previous page, unchanged."
}
]
}{
"type": "https://invoice.horizonpay.co/problems/rate-limited",
"title": "Too many requests",
"status": 429,
"detail": "Rate limit of 120 per 60s exceeded.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "rate_limited"
}Webhook endpoints
List webhook endpoints
Lists your webhook endpoints, newest first. Signing secrets are never included.
Scope: webhooks:manage
GET
/
webhook-endpoints
cURL
curl https://invoice.horizonpay.co/api/v1/webhook-endpoints \
-H "Authorization: Bearer $INVOICE_AI_API_KEY"import InvoiceAI from '@horizonpay/invoice-ai'
const invoiceai = new InvoiceAI() // reads INVOICE_AI_API_KEY
for await (const endpoint of invoiceai.webhookEndpoints.list()) {
console.log(endpoint.url, endpoint.active)
}from invoice_ai import InvoiceAI
client = InvoiceAI() # reads INVOICE_AI_API_KEY
for endpoint in client.webhook_endpoints.list():
print(endpoint.url, endpoint.active){
"data": [
{
"id": "4f9c2a1e-7b3d-4e8a-9c6f-2d1b0a3e5f71",
"url": "https://example.com/webhooks/invoice-ai",
"events": [
"invoice.finalized",
"invoice.paid"
],
"active": true,
"disabled_at": null,
"failure_count": 0,
"created_at": "2026-09-22T09:30:00.000Z"
}
],
"next_cursor": null
}{
"type": "https://invoice.horizonpay.co/problems/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Send your API key as `Authorization: Bearer inv_live_…`.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "unauthorized"
}{
"type": "https://invoice.horizonpay.co/problems/forbidden",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential is missing the invoices:write scope.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "forbidden"
}{
"type": "https://invoice.horizonpay.co/problems/validation",
"title": "Validation failed",
"status": 422,
"detail": "The cursor is not valid.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "validation",
"errors": [
{
"path": "cursor",
"message": "Pass the `next_cursor` from the previous page, unchanged."
}
]
}{
"type": "https://invoice.horizonpay.co/problems/rate-limited",
"title": "Too many requests",
"status": 429,
"detail": "Rate limit of 120 per 60s exceeded.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "rate_limited"
}Authorizations
An Invoice-AI API key sent as Authorization: Bearer inv_live_….
Create keys in Settings → API keys; the secret is shown once. Each key carries scopes, and every operation lists the scope it needs (x-required-scope):
business:read— Read your business profile, tax ID and bank detailsclients:read— List and read your clientsclients:write— Create, update and archive clientsproducts:read— List and read products and pricesproducts:write— Create, update and archive products and pricesinvoices:read— List and read invoices, including PDFsinvoices:write— Create, edit and delete draftsinvoices:finalize— Finalize invoices and void theminvoices:send— Email invoices to your clientspayments:write— Mark invoices as paidwebhooks:manage— Manage webhook endpoints
Keys cannot be created or revoked through the API, so a leaked key cannot mint more keys.
Query Parameters
The next_cursor from the previous page. Opaque — do not build it yourself.
Page size, 1–100. Defaults to 25.
Required range:
1 <= x <= 100