EndPoint List All Invoice Items

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

get_invoice_items

Description

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first. [API Help]

Parameters

Parameter

Label

Required

Options

Description

customer

Customer Id

Only return invoices for the customer specified by this customer Id.

invoice

Invoice Id

Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.

pending

Pending

Option	Value
true	true
false	false

Set to true to only show pending invoice items, which are not yet attached to any invoices. Set to false to only show invoice items already attached to invoices. If unspecified, no filter is applied.

created_gt

Created later than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is greater than this value.

created_gte

Created on or later than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is greater than or equal to this value.

created_lt

Created earlier than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is less than this value.

created_lte

Created on or earlier than (yyyy-MM-dd)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Return results where the created field is less than or equal to this value.

Output Columns

Label	DataType	Length	Raw
Id	DT_WSTR	100	False
InvoiceId	DT_WSTR	1020	False
Object	DT_WSTR	100	False
Amount	DT_I8	0	False
AmountDecimal	DT_WSTR	4000	False
Currency	DT_WSTR	100	False
Customer	DT_WSTR	1020	False
Date	DT_DBTIMESTAMP	0	False
Description	DT_WSTR	255	False
Discountable	DT_BOOL	0	False
Discounts	DT_WSTR	100	False
Livemode	DT_BOOL	0	False
PeriodEnd	DT_DBTIMESTAMP	0	False
PeriodStart	DT_DBTIMESTAMP	0	False
PriceID	DT_WSTR	120	False
PriceObject	DT_WSTR	100	False
PriceActive	DT_BOOL	0	False
PriceBillingScheme	DT_WSTR	100	False
PriceCreated	DT_DBTIMESTAMP	0	False
PriceCurrency	DT_WSTR	100	False
PriceLivemode	DT_BOOL	0	False
PriceLookupKey	DT_WSTR	1020	False
PriceNickname	DT_WSTR	100	False
PriceProductId	DT_WSTR	100	False
PriceRecurringAggregateUsage	DT_WSTR	100	False
PriceRecurringInterval	DT_WSTR	100	False
PriceRecurringIntervalCount	DT_I8	0	False
PriceRecurringTrialPeriodDays	DT_I8	0	False
PriceRecurringUsageType	DT_WSTR	100	False
PriceTiersMode	DT_WSTR	1020	False
PriceTransformQuantity	DT_WSTR	1020	False
PriceType	DT_WSTR	100	False
PriceUnitAmount	DT_I8	0	False
PriceUnitAmountDecimal	DT_WSTR	100	False
Proration	DT_BOOL	0	False
Quantity	DT_I8	0	False
SubscriptionId	DT_WSTR	100	False
TaxRates	DT_WSTR	100	False
UnitAmount	DT_I8	0	False
UnitAmountDecimal	DT_WSTR	100	False

Input Columns

Label	DataType	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.