Shipments
Rates
Rate Model
This is how all rates are returned on the platform. Initially when you are creating rates, you'll typically have many options here. When it's time to purchase the rate, you'll pass the id of the rate you want to buy.
object "rate"
The description of the model.
type String
The type of rate. Can be one of delivery, pickup, or received. Defaults to delivery.
created_at Integer
Time in epoch seconds when this rate was created.
id String
Unique identifier for the rate, prefixed with rate_
amount integer
The total cost of the rate that will be displayed.
billed_amount integer
The actual amount you will be charged when purchasing this rate. Can be higher or lower than the amount if you are discounting or upcharging your shipment.
retail_amount integer
The retail price of the rate.
provider object
The carrier or courier details for this rate.
Show Details
service_level object
Details about the delivery service for this rate.