Skip to main content
GET
/
v3
/
rates
/
{rate}
Read Rate
curl --request GET \
  --url http://localhost/api/v3/rates/{rate}
{
  "data": {
    "id": 123,
    "handle": "<string>",
    "type": "<string>",
    "location": "<string>",
    "code": "<string>",
    "name": "<string>",
    "rate": "<string>",
    "is_default": true,
    "is_archived": true,
    "region_id": 123,
    "region": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>"
    },
    "location_id": 123,
    "location_object": {
      "id": "<string>",
      "name": "<string>",
      "handle": "<string>"
    },
    "country_iso_2": "<string>",
    "profile_conditions": [
      "<unknown>"
    ],
    "product_conditions": [
      "<unknown>"
    ],
    "start_time": "<string>",
    "end_time": "<string>",
    "issue_period": 123,
    "issue_period_type": "<string>",
    "issue_absolute_expiry": "<string>",
    "earn_instructions": "<string>",
    "internal_notes": "<string>",
    "is_published": true,
    "priority": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

rate
integer
required

The rate ID

Response

Rate

data
Rate · object
required