# GET /api/v2/subscription-types/{subscription_type}

Read a subscription type

- MCP id: subscription-types.show
- Scope: api:read:subscription_types
- Permission: subscription_types::read
- Needs the billing feature on your organisation
- Rate cost: 1 unit, read bucket.
- Cache-Control: private, no-store

Returns one type in the detail view.

Types are soft-deleted, so a deleted type is `404` unless `trashed=with` or `trashed=only` is passed; `trashed=only` 404s a live type. Its template lines are reached through the items link, never through `?include=`.

## Parameters
- subscription_type (integer, path): The SubscriptionType's numeric id. Accepts a soft-deleted record.
- view (string, optional): Which field set to render.
- trashed (string, optional): Whether soft-deleted rows are included.
- meta (array of string, optional): Optional meta members to compute for this response.
- X-Request-Id (header, optional): A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.
- If-None-Match (header, optional): The ETag a read is conditional on. A match is answered 304 with no body.

## Response 200
- id (integer, required): Unique identifier.
- name (string ≤ 255, required): Subscription type name. It is also the name every customer subscription of this type is displayed under, so renaming a type renames what its existing subscriptions read as. Names are not unique.
- description (string or null, required, multiline): What subscriptions of this type cover, as free text.
- default_billing_interval (string, required): Interval a new subscription of this type is billed at by default. Omitting it on create yields yearly, the stored default, not the monthly that plnnrly's form pre-selects, which is a form convenience the API deliberately does not reproduce.
- auto_renew (boolean, required): Whether subscriptions created from this type renew automatically by default. The value is stored exactly as sent; nothing forces it to `false`.
- active (boolean, required): Whether the type is offered in the catalogue. It is a catalogue flag only: nothing in the application filters on it, so deactivating a type does not stop existing subscriptions of that type from being renewed or invoiced.
- sort_order (integer or null, required, server-assigned): Position in the catalogue, assigned by the server on create as one past the highest existing position. It is the default sort key, and there is no way to reorder types through the API: dragging types into order in plnnrly has no API equivalent in v2.0.
- created_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Creation timestamp.
- updated_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Last-write timestamp; use for incremental sync. It also feeds the `ETag` revision, because a subscription type has no `version` field.
- deleted_at (timestamp (YYYY-MM-DDThh:mm:ssZ) or null, required): Soft-delete timestamp, `null` while live.
- items_count (integer ≥ 0, required): Number of template lines on this subscription type.
- links (SubscriptionTypeLinks, required)
  - self (url, required): The canonical URI of this record.
  - items (url, required): Template lines on this subscription type.

## Errors
- 403 forbidden-by-policy | insufficient-permission | insufficient-token-scope: Forbidden.
- 304 : Not modified.
- 400 idempotency-key-required | invalid-cursor | invalid-query-parameter | malformed-request | unsupported-parameter: Bad request.
- 401 token-expired | unauthenticated: Unauthenticated.
- 404 endpoint-not-found | resource-not-found: Not found.
- 406 not-acceptable: Not acceptable.
- 429 rate-limit-exceeded: Too many requests.
- 500 internal-error: Server error.
- 503 tenant-unavailable: Service unavailable.

## Example
```bash
curl -X GET \
  'https://<your-url>/api/v2/subscription-types/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'
```