> For the complete documentation index, see [llms.txt](https://docs.terminal.africa/tship/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terminal.africa/tship/rate.md).

# Rates

### The Rate Object

This section describes the different attributes available for a rate.

| Attribute                  | Type       | Description                                                     |
| -------------------------- | ---------- | --------------------------------------------------------------- |
| amount                     | *number*   | Total cost of pickup and delivery.                              |
| carrier\_logo              | *string*   | Image URL for carrier logo.                                     |
| carrier\_name              | *string*   | Name of carrier executing shipment.                             |
| carrier\_rate\_description | *string*   | Carrier description of rate e.g. UPS First Class.               |
| carrier\_reference         | *string*   | Unique identifier for carrier.                                  |
| carrier\_slug              | *string*   | Unique slug for carrier.                                        |
| currency                   | *string*   | Currency of rate amount.                                        |
| delivery\_date             | *date*     | Estimated delivery date for shipment.                           |
| delivery\_eta              | number     | Estimated delivery time in minutes.                             |
| delivery\_time             | *string*   | Human readable description of estimated time to deliver parcel. |
| id                         | *string*   | Unique identifier for rate.                                     |
| metadata                   | *object*   | Provides additional information for a rate.                     |
| pickup\_eta                | *number*   | Estimated pickup time in minutes.                               |
| pickup\_time               | *string*   | Human readable description of estimated time to pickup parcel.  |
| rate\_id                   | *string*   | Unique reference for rate.                                      |
| used                       | *boolean*  | Indicates if a rate has been used in a shipment request.        |
| created\_at                | *datetime* | Time rate created.                                              |
| updated\_at                | *datetime* | Time rate last updated.                                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.terminal.africa/tship/rate.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.