PlanComparisonResponse
Public plan comparison matrix (`GET /v1/plans/public/comparison`). Columns aligned to the public catalog; content is DB-editable.
Properties
| Field | Type | Description |
|---|---|---|
data | object | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`). |
type* | string | Resource type, fixed for this operation. Part of the resource identity in the JSON:API envelope. Always `plan_comparison`. |
attributes* | object | The resource's own data, kept apart from its identity. |
plans* | array | Columns, in public-catalog order. |
rows* | array | Comparison dimensions, ordered. |
meta | object | Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC. |
version | string | API version that processed the request. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC` — the canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601` — explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
GET /v1/plans/public/comparison