Skip to main content
PUT
Update invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
amount
number

The total amount for the invoice in smallest currency unit (e.g., cents)

Required range: x >= 0
Example:

9999

currency
enum<string>

The currency code in ISO 4217 format

Available options:
USD,
EUR,
GBP,
AED
Example:

"USD"

description
string

A clear description of what this invoice is for

Example:

"Monthly Premium Plan Subscription - January 2024"

planCode
string

The unique identifier of the plan being billed

Example:

"PREMIUM_MONTHLY"

planName
string

The display name of the plan being billed

Example:

"Premium Monthly Plan"

templateId
string

ID of the invoice template to use. If not provided, default template will be used

Example:

"template-123"

status
enum<string>
default:DRAFT

Current status of the invoice

Available options:
DRAFT,
FINALIZED,
PAYMENT_FAILED,
PAID,
VOID
Example:

"DRAFT"

components
object

Custom invoice components including line items and customer details

startDate
string<date-time>

The start date of the billing period

Example:

"2024-01-01T00:00:00.000Z"

renewalDate
string<date-time>

The next renewal date for recurring invoices

Example:

"2024-02-01T00:00:00.000Z"

paymentTerms
number

Number of days until payment is due

Required range: x >= 0
Example:

30

Response

Invoice updated successfully

id
string
required
invoiceNumber
string
required
date
string
required
status
enum<string>
required
Available options:
DRAFT,
FINALIZED,
PAYMENT_FAILED,
PAID,
VOID
amount
number
required
currency
string
required
description
string
required
customerName
string
required
customerEmail
string
required
planType
string