Invoices Object

---

id

string

REQUIRED · 

Unique identifier for the invoice

customer

object

id

string

Unique identifier for the customer

name

string

Name of the customer

email

string

Email of the customer

phone

string

Phone number of the customer

created_at

string · date-time

Date and time when the customer was created

updated_at

string · date-time

Date and time when the customer was last updated

subscription_id

string

Unique identifier for the subscription associated with the invoice

is_recurring

boolean

Whether the invoice is recurring or not

status

string

Status of the invoice. In case there is no clear mapping, the raw status is passed.

All possible enum values:

• pending
• paid
• failed
• cancelled
• refunded
• draft

issue_date

string · date-time

Date of the invoice

due_date

string · date-time

Due date of the invoice

paid_on_date

string · date-time

Date when the invoice was paid or marked as paid

transaction_fee

string

Transaction fee on a payment

number

string

Invoice number

currency

string

Currency of the invoice

exchange_rate

number

Exchange rate of the currency of the invoice

total_discount

string

Total discount applied to the invoice

sub_total

string

Sub total of the invoice

total_tax_amount

string

Total tax amount of the invoice

balance

string

Balance amount to be paid

payments

object[]

List of payments associated with the invoice

id

string

Unique identifier for the payment

method

string

Payment method used for the payment. In case there is no clear mapping, the raw payment method is passed.

All possible enum values:

• card
• bank_transfer
• cash
• check
• paypal
• wallet
• wire_transfer

status

string

Status of the payment. In case there is no clear mapping, the raw status is passed.

All possible enum values:

• pending
• authorized
• paid
• partial
• refunded
• voided
• cancelled
• unknown

amount

string

Amount of the payment

currency

string

Currency of the payment

exchange_rate

number

Exchange rate of the currency of the payment

created_at

string · date-time

Date and time when the payment was created

updated_at

string · date-time

Date and time when the payment was last updated

line_items

object[]

List of line items associated with the invoice

id

string

The unique identifier for line item

name

string

The name of the line item

description

string

The description of the line item

item

string

The ID of the item

quantity

number

The quantity of the line item

unit_price

string

The unit price of the line item

tax_rate

string

The ID of the tax rate

tax_amount

string

The tax amount of the line item

total_line_amount

string

The total line amount of the line item.

type

string

The type of the line item

currency

string

The currency of the line item

exchange_rate

number

The exchange rate of the currency for the line item

memo

string

Memo of the invoice

created_at

string · date-time

Date and time when the invoice was created

updated_at

string · date-time

Date and time when the invoice was last updated

remote_data

object

Raw data returned from the remote API call.