---
title: "Get a subscription by ID"
method: GET
path: "/api/subscription/{id}"
---

# Get a subscription by ID

`GET /api/subscription/{id}`

## Request

- Base URL: `https://api.atono.io`
- URL: `https://api.atono.io/api/subscription/{id}`
- Auth: API key in header `X-API-KEY`

Returns a subscription by ID

## Path parameters

- `id` string, uuid, required

## Query parameters

- `include` SubscriptionControllerSubscriptionInclusionType[], required

## Response `200`

getSubscription 200 response

- SingleResourceBodySubscriptionResource
  - `data` SubscriptionResource
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` SubscriptionResourceSubscriptionAttributes, required
      - `subscriptionId` string, required
      - `subscriptionTier` 'INTERNAL' | 'TRIAL' | 'FREE' | 'STARTER' | 'BUSINESS' | 'ENTERPRISE', required
      - `subscriptionStatus` 'ACTIVE' | 'CANCELED', required
      - `customerId` string, required
      - `trialCount` integer, required
      - `startDate` string, date-time, required
      - `endDate` string, date-time, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `entitledUserSeats` integer, required
      - `entitledStorage` integer, required
      - `entitledCapyUsage` integer, required
      - `entitledActiveItemCount` integer, required
      - `items` SubscriptionSubscribedItem[], required
        - `id` string, required
        - `productId` string, required
        - `priceId` string, required
        - `quantity` integer, required
        - `recurringInterval` string, required
        - `recurringIntervalCount` integer, required
    - `relationships` SubscriptionResourceSubscriptionRelationships, required
      - `workspace` SingleRelationship, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `products` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `prices` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
      - `subscriptionItems` MultipleRelationships, required
        - `links` RelationshipLinks, required
          - `self` string, uri, nullable, required
          - `related` string, uri, nullable, required
        - `data` ResourceIdentifier[], nullable, required
          - `type` string, required: Identifies the type of the linked resource.
          - `id` string, required: The unique identifier of the linked resource.
        - `meta` unknown, required
  - `errors` ProblemDetail[]: A list of errors returned with the response, if the request could not be completed. Each object includes details about a specific issue.
    - `id` string: A unique identifier for this specific error occurrence. Useful for debugging and support.
    - `links` object, nullable: Links related to the error. May include a URL to relevant documentation or support resources.
    - `status` integer: The HTTP status code associated with the error (e.g., 400, 404, 422).
    - `code` string: An internal code that identifies the type or category of the error.
    - `title` string: A short summary of the problem.
    - `source` ProblemSource: Identifies the part of the request that caused the error. Only one source is present per error.
      - `pointer` string, nullable: Specifies the path to the field in the request body that caused the error.
      - `parameter` string, nullable: Identifies a query parameter in the request URL that caused the error.
      - `header` string, nullable: Identifies the request header that caused the error.
    - `detail` string: Additional information about the error, intended to provide more context than the title.
    - `meta` unknown
  - `meta` unknown
  - `included` unknown[]: A list of related resources included in the response, either automatically by the API or in response to an include parameter in the request. Each item contains a full resource object (e.g., users, teams, acceptance criteria).
    - unknown
  - `links` unknown

---

[API](https://skmtc.dev/atono/apis/backend-api.md) · [All operations](https://skmtc.dev/atono/apis/backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atono/apis/backend-api/revisions/78a57b1d8c3d?raw)