curl -X PATCH https://invoice.horizonpay.co/api/v1/products/prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1 \
-H "Authorization: Bearer $INVOICE_AI_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "description": "Monthly advisory block, up to 10 hours." }'import InvoiceAI from '@horizonpay/invoice-ai'
const invoiceai = new InvoiceAI() // reads INVOICE_AI_API_KEY
const product = await invoiceai.products.update('prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1', {
description: 'Monthly advisory block, up to 10 hours.',
})
console.log(product.description)from invoice_ai import InvoiceAI
client = InvoiceAI() # reads INVOICE_AI_API_KEY
product = client.products.update(
"prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1",
description="Monthly advisory block, up to 10 hours.",
)
print(product.description){
"data": {
"id": "prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1",
"object": "product",
"name": "Consulting retainer",
"description": "Monthly advisory block, up to 10 hours.",
"images": [],
"active": true,
"created": "2026-09-22T09:30:00.000Z",
"updated": "2026-09-22T09:45:00.000Z"
}
}{
"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/not-found",
"title": "Not found",
"status": 404,
"detail": "Product not found.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "not_found"
}{
"type": "https://invoice.horizonpay.co/problems/validation",
"title": "Validation failed",
"status": 422,
"detail": "Some fields need attention.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "validation",
"errors": [
{
"path": "images.0",
"message": "Enter a valid image URL"
}
]
}{
"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"
}Update a product
Updates the fields you send and leaves the rest unchanged. Send active: true to restore an archived product. Finalized invoices keep the line descriptions they were issued with.
Scope: products:write
curl -X PATCH https://invoice.horizonpay.co/api/v1/products/prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1 \
-H "Authorization: Bearer $INVOICE_AI_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "description": "Monthly advisory block, up to 10 hours." }'import InvoiceAI from '@horizonpay/invoice-ai'
const invoiceai = new InvoiceAI() // reads INVOICE_AI_API_KEY
const product = await invoiceai.products.update('prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1', {
description: 'Monthly advisory block, up to 10 hours.',
})
console.log(product.description)from invoice_ai import InvoiceAI
client = InvoiceAI() # reads INVOICE_AI_API_KEY
product = client.products.update(
"prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1",
description="Monthly advisory block, up to 10 hours.",
)
print(product.description){
"data": {
"id": "prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1",
"object": "product",
"name": "Consulting retainer",
"description": "Monthly advisory block, up to 10 hours.",
"images": [],
"active": true,
"created": "2026-09-22T09:30:00.000Z",
"updated": "2026-09-22T09:45:00.000Z"
}
}{
"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/not-found",
"title": "Not found",
"status": 404,
"detail": "Product not found.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "not_found"
}{
"type": "https://invoice.horizonpay.co/problems/validation",
"title": "Validation failed",
"status": 422,
"detail": "Some fields need attention.",
"instance": "req_7f3c9a1e2b4d4e8a9c6f2d1b0a3e5f71",
"code": "validation",
"errors": [
{
"path": "images.0",
"message": "Enter a valid image URL"
}
]
}{
"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.
Path Parameters
The product, prod_… or UUID.
"prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1"
Body
Any subset of fields. Omitted fields are left unchanged.
Product name, 1–200 characters. Becomes the default line description.
1 - 200"Consulting retainer"
Longer description. null or "" clears it.
Up to 8 image URLs.
8[]
false archives, true restores.
true
Response
The updated product.
The updated product.
Show child attributes
Show child attributes