Skip to main content

Internal invoice object with comprehensive billing and administrative details

_id
string

Unique identifier for the invoice.

planName
string

Name of the plan associated with the invoice.

orderIndex
integer

Order index of the invoice.

organizationId
string

Unique identifier for the organization associated with the invoice.

subscriptionId
string

Unique identifier for the subscription associated with the invoice.

stripeInvoiceId
string

Unique identifier for the Stripe invoice. This is ID of Invoice Stripe see this link for full documentation https://stripe.com/docs/api/invoices/object

invoiceUrl
string

URL to view the invoice, this is genereted by Stripe.

invoicePdf
string

URL to download the invoice as PDF. this is genereted by Stripe.

items
object[]

List of invoice items.

subTotal
integer

Subtotal amount of the invoice.

tax
integer

Tax amount of the invoice.

total
integer

Total amount of the invoice.

currency
string

Currency code of the invoice.

invoiceNumber
string

Invoice number.

status
enum<string>

Status of the invoice. Can be one of the following values: OPEN (The invoice is currently open and pending payment) or EXPIRED (The invoice has expired and payment is overdue).

Available options:
OPEN,
EXPIRED
paymentMethod
string

Payment method used for the invoice.

paidTime
string

Timestamp of when the invoice was paid.

startDate
string

Start date of the invoice period.

endDate
string

End date of the invoice period.

dueDate
string

Due date of the invoice.

updatedTime
string

Timestamp of the last update to the invoice.

createdTime
string

Timestamp of when the invoice was created.

billingPeriod
string

Billing period information.

failedCode
enum<string>

License Module business failedCode that indicate specific failure conditions or business rule violations during license module operations. These codes help identify the failed operation of license-related and provide standardized failure identification across the system.

Possible values:

  • inv-032: Invalid state/condition - Invoice state invalid
  • inv-033: Invoice not found - Please verify the invoice number
  • inv-035: Access forbidden - User lacks invoice permission
  • inv-039: Unpaid invoice blocks operation - Operation blocked by unpaid invoice
  • inv-045: Server failure - Internal server failure
Available options:
inv-032,
inv-033,
inv-035,
inv-039,
inv-045