Skip to main content
GET
Show subscription

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

token
string
required

Subscription token (sb_xxx) or numeric ID

Query Parameters

id
integer

Legacy numeric subscription id, still accepted and integer-coerced by the shared subscription params schema. Never used for lookup here: a numeric {token} is copied over it in a before_action, and any other {token} addresses the record itself.

Response

Success

The show response, which always carries the two fields the points control reads.

Requiring them lives here rather than on the shared subscription object, because the mutation responses render a different view and omit both. renewal_bundle is an object here rather than nullable: this operation always resolves a bundle, and a subscription that renews alone reports itself as the single member.

points_enabled restates its type because listing a name under required without also declaring it under properties documents the constraint but generates nothing: openapi-typescript emits only the properties a branch declares, so it was required here and absent from the generated client, leaving consumers unable to rely on a field this operation always sends.

renewal_bundle is deliberately left as a bare object and does NOT restate its shape, which is a known limitation rather than an oversight. Narrowing it to type: object generates Record<string, never>, and intersecting that with the shape on the shared subscription object types every member field never. Nothing reads the generated type for this field today, because the one client that calls this operation validates the response against its own schema, so the effect is latent. Fixing it properly means extracting the bundle into a named schema referenced from both places, which changes the generated type for every subscription response and wants its own change.

subscription
object
required

Subscription rendered by SubscriptionBlueprinter

meta
object