Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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 details
  • clients:read — List and read your clients
  • clients:write — Create, update and archive clients
  • products:read — List and read products and prices
  • products:write — Create, update and archive products and prices
  • invoices:read — List and read invoices, including PDFs
  • invoices:write — Create, edit and delete drafts
  • invoices:finalize — Finalize invoices and void them
  • invoices:send — Email invoices to your clients
  • payments:write — Mark invoices as paid
  • webhooks:manage — Manage webhook endpoints

Keys cannot be created or revoked through the API, so a leaked key cannot mint more keys.

Headers

Idempotency-Key
string

A unique key per distinct operation (a UUID works), reused only when retrying that same request. Up to 255 characters; stored for 24 hours.

Maximum string length: 255
Example:

"6f1c2d9e-8a4b-4c3f-9e7d-2b5a1c8f4e30"

Body

application/json
product
string
required

The parent product, prod_… or UUID.

Minimum string length: 1
Example:

"prod_Hy7Rq2Lm9Xc4Vb8Nt3Kd6Pw1"

unit_amount
integer
required

Price per unit in integer minor units (2500000 is $25,000.00).

Required range: 0 <= x <= 9007199254740991
Example:

2500000

currency
string
required

ISO 4217 code, three letters (uppercased for you). Must match the invoice currency when billed.

Required string length: 3
Pattern: ^[A-Z]{3}$
Example:

"USD"

nickname
string

Internal label, e.g. "Monthly".

type
enum<string>
default:one_time

one_time (default) or recurring. recurring requires recurring.interval.

Available options:
one_time,
recurring
Example:

"recurring"

recurring
object

Required when type is recurring; must be omitted for one_time.

tax_rate
number
default:0

Default tax percentage, 0–100, for lines billed from this price. Defaults to 0.

Required range: 0 <= x <= 100
Example:

0

active
boolean
default:true

Whether the price is available. Defaults to true.

Example:

true

Response

The created price.

data
object
required

The created price.