---
title: "Get subscription"
method: GET
path: "/subscriptions/{subscriptionId}"
tags: ["Subscriptions"]
---

# Get subscription

`GET /subscriptions/{subscriptionId}`

Query a subscription by id

## Path parameters

- `subscriptionId` integer, required

## Query parameters

- `includeSubObjects` boolean

## Headers

- `api-token` string, required

## Response `200`

Successful subscription query. The response body contains the data representation of the queried subscription and (if requested) any sub-objects.

- SubscriptionWithSubObjectsRes
  - `id` integer
  - `dateCreated` string, date-time
  - `dateUpdated` string, date-time
  - `dateActivated` string, date
  - `dateBilling` string, date
  - `status` string
  - `paymentPlanId` integer
  - `customerCode` string
  - `timesBilled` integer
  - `setupAmount` number, float
  - `recurringAmount` number, float
  - `freeTrialPeriod` integer
  - `maxCycles` integer
  - `hasFailedPayments` string
  - `addOnIds` integer[]
  - `addOns` BaseSubscriptionAddOn[]
    - `addOnId` integer
    - `name` string
    - `description` string
    - `amount` number, float
    - `firstProcessedNumber` integer
    - `lastProcessedNumber` integer
    - `isActive` string
    - `frequency` string
    - `quantity` integer
  - `payments` BasePayment[]
    - `id` integer
    - `setupAmount` number, float
    - `recurringAmount` number, float
    - `addOnAmount` number, float
    - `amount` number, float
    - `taxAmount` number, float
    - `dateDue` string, date-time
    - `dateProcessed` string, date-time
    - `status` string
    - `paymentNumber` integer
    - `numberOfRetries` integer

## Other responses

- `400` — You are initiating a request with invalid parameter and/or body values.
- `401` — You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the `api-token` header
- `403` — You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.
- `404` — No resource(s) found for the given request. If you have not used query parameters with your request your business currently has no resource(s) matching the specified values.
- `500` — Helcim internal server error encountered.

---

[API](https://skmtc.net/helcim/apis/the-helcim-api.md) · [All operations](https://skmtc.net/helcim/apis/the-helcim-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helcim/the-helcim-api/versions/345052ca6578/schema)