> ## Documentation Index
> Fetch the complete documentation index at: https://recurr.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get subscription detail

> 🚧 **Under development.** Not available today.




## OpenAPI

````yaml /api-reference/openapi.yaml get /subscriptions/{subscriptionId}
openapi: 3.1.0
info:
  title: Recurr API
  version: 1.0.0
  description: >
    Recurr's webhook event API. Subscription, payment, motion, and ticket

    events delivered as signed HTTP POSTs to your registered endpoints.


    See the [Overview](/api-reference/overview) for delivery model, HMAC

    authentication, idempotency, retry policy, and schema versioning.


    REST endpoints (Replay, Destination management) are documented as

    `paths` for completeness but are roadmap. See
    [Replay](/api-reference/replay)

    and [Destinations](/api-reference/destinations) for status.
  contact:
    email: hello@recurr.dev
    url: https://recurr.dev
  license:
    name: Proprietary
servers:
  - url: https://api.recurr.dev/v1
    description: Production (roadmap)
security:
  - BearerAuth: []
tags:
  - name: Subscribers
    description: Read subscriber state, history, and tags. Update metadata.
  - name: Subscriptions
    description: Subscription state + admin overrides (pause, resume, cancel, plan change).
  - name: Events
    description: Query historical webhook events for audit + debugging.
  - name: Cohorts
    description: >-
      Manage cohort definitions + view members. Used by Recurr motions for
      targeting.
  - name: Motions
    description: Inspect motion performance + manually trigger for specific subscribers.
  - name: Metrics
    description: Aggregate metrics — MRR, churn, recovery, cohort retention.
  - name: Payments
    description: Charge detail + refund / customer-credit operations.
  - name: Tickets
    description: Read subscriber-submitted billing tickets.
  - name: Replay
    description: Re-send historical webhook events to a destination.
  - name: Destinations
    description: Manage webhook delivery endpoints.
paths:
  /subscriptions/{subscriptionId}:
    get:
      tags:
        - Subscriptions
      summary: Get subscription detail
      description: |
        🚧 **Under development.** Not available today.
      operationId: getSubscription
      parameters:
        - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: Subscription detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
      security:
        - BearerAuth: []
components:
  parameters:
    SubscriptionId:
      name: subscriptionId
      in: path
      required: true
      schema:
        type: string
  schemas:
    Subscription:
      type: object
      required:
        - id
        - status
        - plan
        - current_period_start
        - current_period_end
      properties:
        id:
          type: string
          example: sub_01HQ...
        status:
          type: string
          enum:
            - active
            - trialing
            - paused
            - cancelled
            - lapsed
        plan:
          type: string
          example: premium_monthly
        current_period_start:
          type: string
          format: date-time
        current_period_end:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rk_live_… / rk_test_…
      description: |
        Your Recurr **secret API key** as a Bearer token:
        `Authorization: Bearer rk_live_…`.

        Keys are **environment-scoped** — `rk_live_` operates on live data,
        `rk_test_` on isolated test data (see
        [Test mode](/api-reference/test-mode)). Create, scope, and rotate keys
        in your dashboard (**Settings → API keys**, `developer` role). Secret
        keys are server-side only — never ship them in an app binary or client
        JavaScript.

````