Invoice object

Overview

The Invoice object is returned by some of the endpoints in this section and contains a subset of the invoice properties.

📘

To learn about invoices on the Inspire Payment Platform, read About Invoices.

Properties of the Invoice object

• id (String): Invoice ID.
• currencySymbol (String): Currency symbol.
• amountDue (String): Amount due on the invoice.
• amountSubtotal (String): Subtotal.
• currencyIsoCode (String): ISO code of the currency.
• isSubscription (Boolean): If True, this is a subscription invoice.
• subscriptionId (String): Subscription ID.
• invoiceNumber (String): Invoice number.
• status (String): Invoice status.
• customerName (String): Customer's name.
• customerEmail (String): Customer's email.
• customerDescription (String): A description of the customer.
• lineItems (String): Invoice line items.
• dueDate (String): Invoice due date.
• createdDate (String): Date and time when the invoice was created.
• linkUrl (String): Link to the invoice on the Inspire Platform.
• recurringInterval (Object): Invoice recurring interval.