Get a subscription

Módulo Settings

GET/subscriptions/{id}subscriptions.get

Present only when an organization uses Atlas: plan, billing and tenant settings. Returns one subscription with its `ETag`. A subscription the caller may not see returns 404.

Requiere la capacidad org.billing.read.
Alcances de OAuth: org.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

subscriptions.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the subscription.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: Subscription

subscriptions.get: Subscription
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the subscription.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
plan_code	string	Sí	Plan code from `plans.yaml`.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
subscription_state	"trialing" \| "active" \| "past_due" \| "read_only" \| "canceled"	Sí	Subscription status as Stripe reports it; read_only after the grace period.
trial_ends_at	string (date-time) \| null	Sí	When the subscription's trial ends; null when it never had one.
extra_seats	integer	Sí	Seats bought above the plan's seat allowance.Restricciones: range 0 to any
seats_grandfathered	boolean	Sí	True when the subscription keeps unlimited seats from before plans had seat limits, until its plan changes.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "plan_code": "pro",
  "subscription_state": "trialing",
  "trial_ends_at": "2026-10-08T14:30:00Z",
  "extra_seats": 3,
  "seats_grandfathered": false
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/subscriptions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.subscriptions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.subscriptions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos subscriptions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f