From 61c73b6406be443542d473f1efa4c37a1bea0d69 Mon Sep 17 00:00:00 2001 From: Sinan Keskin Date: Tue, 25 Aug 2026 23:29:59 +0300 Subject: [PATCH] docs: clarify paid-plan requirement in API permission error message Matches the updated tnt-api error string for DEV-12132: read/write endpoints beyond POST /v2/tracking_requests now explain in the 401 response that a paid plan is required, with a link to the billing settings page. --- docs/api-docs/api-reference/introduction.mdx | 2 +- docs/api-docs/useful-info/entitlements.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-docs/api-reference/introduction.mdx b/docs/api-docs/api-reference/introduction.mdx index 104cae8c..94dbff83 100644 --- a/docs/api-docs/api-reference/introduction.mdx +++ b/docs/api-docs/api-reference/introduction.mdx @@ -37,7 +37,7 @@ Replace `YOUR_API_KEY` with the raw key value from the [developer portal](https: ### Restricted API access on Free plans -Free-plan accounts can authenticate and create tracking requests, but read endpoints are gated. A valid key on a restricted account returns `401 Unauthorized` with `"You do not have permissions for using the API, except for creating tracking requests"` when you call any endpoint other than `POST /v2/tracking_requests`. +Free-plan accounts can authenticate and create tracking requests, but read endpoints are gated. A valid key on a restricted account returns `401 Unauthorized` with `"You do not have permissions for using the API, except for creating tracking requests. All other permissions require a paid plan. See https://app.terminal49.com/settings/billing"` when you call any endpoint other than `POST /v2/tracking_requests`. To read tracking data (`GET /v2/shipments`, `GET /v2/containers`, `GET /v2/tracking_requests/{id}`, and other endpoints), your account needs full API access enabled. Full API access is not automatic on the Free plan. Contact [support@terminal49.com](mailto:support@terminal49.com) to enable a 7-day API trial, or see [Pricing](/api-docs/useful-info/pricing) for plans that include ongoing API read access. diff --git a/docs/api-docs/useful-info/entitlements.mdx b/docs/api-docs/useful-info/entitlements.mdx index 808e54da..693c6aec 100644 --- a/docs/api-docs/useful-info/entitlements.mdx +++ b/docs/api-docs/useful-info/entitlements.mdx @@ -17,7 +17,7 @@ Some Terminal49 features require account enablement beyond standard API access. | Surface | Entitlement | How to request access | Non-entitled behavior | | --- | --- | --- | --- | -| Read endpoints (`GET /v2/shipments`, `GET /v2/containers`, `GET /v2/tracking_requests/{id}`, and other GETs) | Full API access (paid plan or 7-day API trial) | Contact support@terminal49.com to enable the trial, or upgrade at [Pricing](/api-docs/useful-info/pricing) | `401 Unauthorized` with `You do not have permissions for using the API, except for creating tracking requests`. `POST /v2/tracking_requests` still works. | +| Read endpoints (`GET /v2/shipments`, `GET /v2/containers`, `GET /v2/tracking_requests/{id}`, and other GETs) | Full API access (paid plan or 7-day API trial) | Contact support@terminal49.com to enable the trial, or upgrade at [Pricing](/api-docs/useful-info/pricing) | `401 Unauthorized` with `You do not have permissions for using the API, except for creating tracking requests. All other permissions require a paid plan. See https://app.terminal49.com/settings/billing`. `POST /v2/tracking_requests` still works. | | Container Map GeoJSON API (`GET /v2/containers/{id}/map_geojson`) | Routing Data | Contact sales@terminal49.com | `403 Forbidden` with `Routing data feature is not enabled for this account` | | Vessel position and future-position endpoints | Routing Data / vessel positions | Contact sales@terminal49.com | `403 Forbidden` with `Routing data feature is not enabled for this account` | | MCP `get_container_route` tool | Routing Data | Contact sales@terminal49.com | The tool returns a feature-not-enabled response; use `get_container_transport_events` for historical milestones |