The Invoice object

A bill or statement.

  • id

    string

    The system-assigned identifier of the invoice.

  • state

    enum

    The status of the invoice.

    Possible values:
    OPENPAIDVOID
  • stateTime

    date-time

    The time associated with the current state (e.g. paid time).

  • number

    string

    The invoice number.

  • currencyCode

    string

    The currency code for the invoice (e.g. USD).

  • description

    string

    The user facing description for the invoice.

  • account

    InvoiceAccount

    The contact information associated with the invoice.

  • effectiveTime

    date-time

    The time the invoice was finalized.

  • period

    Period

    The billing period for the invoice.

  • subtotalAmount

    string

    The subtotal amount for the invoice.

    This includes item-level discounts.

  • discountAmount

    string

    The invoice-level discount amount.

    This does not include item level discounts.

  • balance

    InvoiceBalance

    The starting and ending account balance as of the time the invoice was finalized.

  • taxAmount

    string

    The tax amount for the invoice.

    This is for rendering purposes only and is not the reported tax amount.

  • totalAmount

    string

    The total amount for the invoice.

  • dueAmount

    string

    The total amount minus any credits automatically associated with the invoice.

  • remainingDueAmount

    string

    The due amount minus the amount already paid.

  • dueTime

    date-time

    The time the invoice must be paid by.

  • paidAmount

    string

    The amount already paid towards the invoice.

  • paymentState

    enum

    The status of the invoice payment.

    Possible values:
    PAYMENT_METHOD_REQUIREDACTION_REQUIREDPROCESSING
  • paymentIntent

    PaymentIntent

    The payment intent for the invoice.

  • items

    InvoiceItem[]

    The line items for the invoice.

  • changes

    InvoiceChange[]

    The prorated changes that occurred mid-billing cycle.

  • createTime

    date-time

    The creation time of the invoice.

  • updateTime

    date-time

    The last update time of the invoice.

PreviousInvoices
NextList invoices

Turn users intorevenue
$

Subscribe to monthly product updates

© 2024 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & Custom Auth