Invoice Items API overview

The Invoice Items API lets you retrieve the billable line items charged to your Sendcloud account. An invoice item is a single billable line — for example a parcel fee, a pickup fee, or a subscription charge.

​

Pending vs invoiced items

Invoice items are returned before they are consolidated onto an invoice, so you can reconcile expected spend in near real-time.

• Invoiced items have invoice_id set, along with tax and tax_rate.
• Pending items have invoice_id, tax, and tax_rate set to null. Tax is only computed when the item is invoiced.

​

Item types and subtypes

Every item has a type (for example shipment, surcharge, or subscription). Some types are further specified by a subtype: surcharge and surcharge refund items carry the surcharge that was applied (for example dimensional), so you can tell surcharges apart without parsing the description. Items without a subtype have subtype set to null.

​

Subtype values

The subtypes below are the values you can expect today. Sendcloud maintains this list and adds new subtypes when carriers introduce new surcharges or new services are launched, so treat subtype as an open string: handle values you do not recognise gracefully rather than rejecting them. Surcharges come in pairs. The refund of a surcharge is a surcharge_refund item whose subtype is the surcharge’s subtype with a _refund suffix (for example dimensional and dimensional_refund). Each of the above also exists with a _refund suffix. Items for add-ons and services (for example addon, notification or subscription items) use these subtypes:

​

Filtering

Filter the list with created_after / created_before (compared against the item’s billing date, both inclusive), parcel_id, invoice_id, or type. See the Retrieve a list of invoice items endpoint for the full list of supported parameters.

​

Pagination

This endpoint uses cursor-based pagination via Link response headers. See Pagination for details.