BillingRate cards

Get Many Rate Cards

GET
/shipos/rate-cards
x-access-token<token>

In: header

Query Parameters

page?number
Formatdouble
Default0
limit?number
Formatdouble
Default10
order_by?string
Default"created_at"

Value in

  • "created_at"
  • "name"
  • "updated_at"
order?string

Shared sort/order types used across handler input schemas.

Defining these centrally avoids inline z.enum(["asc", "desc"]) literals sprinkled across handler input schemas; callers should reference APISortDirection via z.nativeEnum(APISortDirection) instead. API values intentionally stay lowercase to match persisted table-filter state.

Value in

  • "asc"
  • "desc"
search?string
Default""

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/shipos/rate-cards"
{  "data": [    {      "team_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "currency": "string",      "subscription_period": "DAILY",      "subscription_amount": 0.1,      "minimum_period": "DAILY",      "minimum_amount": 0.1,      "description": "string",      "name": "string",      "id": "string",      "supported_actions": [        {          "action": "VIEW_RATE_CARD"        }      ]    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}