Billing Line Item Object

A billing line item object is used to represent billing line items on shipments.

Properties

This table lists the properties of a billing line item object and identifies those properties that are required.

NameTypeRequired?Description
billing_category

billing category

The billing category for this line item.

carrier_descriptionstring

If the carrier provides a description from their API about the billing charge (not specific to the user). Maximum length of 100 characters.

carrier_billing_codestring

If the carrier provides a billing code for the billing charge.

memostring

This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters.

amountobject

Total amount and currency of the line item.

amount.amountstring

The amount of the line item.

amount.currencystring

The currency of the line item.

Billing Categories

This table lists the valid values for billing categories.

NameDescription
uncategorized

Use this for any fees that don't align with the specific categories below.

shipping

The base charge for the shipping amount.

insurance

Fee for carrier insurance added to the shipment.

confirm

Confirmation charges, for delivery signature, adult signature, etc.

discount

A negative charge that is a discount for the user.

fuel_charge

Fuel surcharges.

additional_fees

Other fees that don't fit into the categories provided.

tariff

Customs tariffs and levies.

tax

Taxes relating to the shipment, like sales tax, VAT, etc.

delivery

Fees associated with the delivery, appointment, COD, retry, etc.

handling

For additionally handling, normally for non-machineable.

special_goods

Fees for non-standard shipped goods, dangerous goods, fresh flowers, etc.

pickup

For shipment pickup services fees.

location_fee

Fees for rural areas, residential delivery, anything added as a result of the location.

oversize

Fees related to the shape, weight, or size of the shipment.

returns

Return fees stemming from a return label.

notifications

Priority notifications from the carrier, opting into special notifications for services.