Rate Card Pricing

The pricing object returned with a rate card holds the price matrix. This section describes that object.

Attribute		Description
band_surcharge_overrides	array	Always empty on merchant endpoints. The per-band markup structure behind the prices is not exposed.
currency	enum	Currency every price in the matrix is quoted in.
currency_symbol	string	Display symbol for the currency e.g. ₦.
delivery	object	Price matrix for the delivery direction. See below.
format	enum	How to read a price. Must be one of standard (the cell is the total price for a shipment in that band) or multiplier (the cell is the price per unit — multiply by the chargeable weight).
includes_surcharges	boolean	Always true. Prices are what you are charged, with all surcharges applied.
name	string	Display name of the rate card.
pickup	object	Price matrix for the pickup direction. See below.
rate_card_id	string	Unique reference for the rate card.
unit	string	Unit the weight bands are measured in. Usually kg.

The matrix object

delivery and pickup have the same shape. A card can price one direction only, in which case the other has has_pricing set to false.

Attribute		Description
has_pricing	boolean	Indicates the matrix holds at least one price.
rows	array	The weight bands. See below.
zones	array	The columns of the matrix. Each has a zone_code, a name and a display label.

The row object

Attribute		Description
band	string	The weight band as a range e.g. 1-2.
cells	object	Prices for this band, keyed by zone_code. A value of null means the card has no price for that band and zone.
label	string	The band's upper bound, for display as the row heading.
override_range	string	Marks a band priced outside the card's standard surcharge set. null on a normal row.

The columns of a rate card are its zones, so a price matrix is unreadable without knowing which countries fall into each one. Use the zones download to get that.