> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Get a hub subscription > Returns a single tenant subscription. NEVER returns the signing secret (only create/rotate reveal it, once). ## OpenAPI ````yaml en/openapi/v3-current/consignado.yaml get /v1/subscriptions/{id} openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- OpenAPI 3.1 surface for Lerian Consignado — Dataprev. The API covers tenant credentials and rail configuration, worker margin, loan auctions and bids, contract registration and lifecycle, disbursement confirmation, portability, refinancing, renegotiation, FGTS guarantees, reconciliation, funds, assignments, usage, throughput, and event subscriptions. Secret material is written to the tenant secret store and is never returned by any operation. license: name: Lerian Studio General License title: Lerian Consignado API version: v1.0.0 servers: - url: https://consignado.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Per-tenant Dataprev credential custody and public rail configuration (upload, status, rotation, revoke, requester code, and worker portal base URL) name: Credentials - description: >- Tenant-scoped consignado gateway usage: priced billable-unit aggregation per competência name: Consignado Usage - description: >- Per-tenant streaming-hub subscription control-plane (list, create, get, rotate, revoke, and test delivery) name: Subscriptions - description: >- Dataprev payroll-rail surface: FGTS balance and authorization reads, the FGTS guarantee execution, contract suspension, reactivation and term changes, the rail's own contract documents, and the on-demand reads of leilão solicitações, escriturações, repasses and employment terminations name: Consignado Rail - description: >- Synchronous rail command surface: the operations a bancarizador without the lender drives over HTTP. Each shares its command implementation with the equivalent lender event trigger. name: Consignado Rail Commands - description: >- Gateway-owned disbursement confirmation: a client bank recording money it has ALREADY paid to a worker. It crosses no government boundary and proxies no Dataprev operation. name: Consignado Disbursement - description: >- Per-tenant self-service outbound Dataprev rail throughput: read and set this tenant's own requests-per-second, including a deliberate pause at zero name: Consignado Throughput paths: /v1/subscriptions/{id}: get: tags: - Subscriptions summary: Get a hub subscription description: >- Returns a single tenant subscription. NEVER returns the signing secret (only create/rotate reveal it, once). operationId: getSubscription parameters: - description: Bearer token, relayed to the streaming-hub as server-to-server auth. in: header name: Authorization schema: description: >- Bearer token, relayed to the streaming-hub as server-to-server auth. type: string - description: Subscription id. in: path name: id required: true schema: description: Subscription id. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: GetResponse: additionalProperties: false properties: subscription: $ref: '#/components/schemas/Subscription' required: - subscription type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object Subscription: additionalProperties: false properties: created_at: description: RFC 3339 creation timestamp (UTC). examples: - '2026-01-15T12:00:00Z' format: date-time type: string delegated_scope: description: >- Base64 of the subscription's delegated scope (this gateway's fund); absent on a tenant-wide subscription. examples: - Rk9ORE8tQQ== type: string enabled: description: Whether delivery is enabled. type: boolean endpoint: description: Webhook delivery endpoint. examples: - https://hooks.example.com/ingest type: string event_types: description: Event-type filter; absent means all events. items: type: string type: - array - 'null' id: description: Hub-assigned subscription id (UUIDv7). examples: - 0192f1a0-0000-7000-8000-00000000c001 type: string name: description: Human-readable subscription name. examples: - orders-webhook type: string plan_tier: description: Delivery plan tier. examples: - standard type: string schema_major: description: Pinned event schema major version; absent means unpinned. examples: - 2 format: int64 type: integer signature_version: description: Webhook signature scheme version. examples: - 1 format: int64 type: integer sink_kind: description: Delivery sink kind. examples: - webhook type: string updated_at: description: RFC 3339 last-update timestamp (UTC). examples: - '2026-01-15T12:00:00Z' format: date-time type: string verification_state: description: Endpoint verification state. examples: - active type: string required: - id - name - sink_kind - endpoint - signature_version - plan_tier - enabled - verification_state - created_at - updated_at type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````