---
title: "Query Subscriptions"
method: GET
path: "/v1/subscriptions/{id}"
---

# Query Subscriptions

`GET /v1/subscriptions/{id}`

Returns all or a specific subscription by the given subscription id

## Path parameters

- `id` string, required

## Headers

- `x-user-secret-key` string, required
- `Content-Type` string, required

## Response `200`

200

- object
  - `status` integer
  - `error` unknown
  - `resource` object
    - `type` string
    - `data` object
      - `_id` string
      - `created_at` string
      - `updated_at` string
      - `company_id` string
      - `amount` integer
      - `status` string
      - `user_id` string
      - `latest_charge_id` string
      - `expired_at` string
      - `expired_reason` string
      - `last_change_by` string
      - `archived` boolean
      - `_source_ip_address` string
      - `customer` object
        - `customer_id` string
        - `first_name` string
        - `last_name` string
        - `email` string
        - `phone` string
        - `company_name` string
        - `payment_source` object
          - `gateway_name` string
          - `gateway_type` string
          - `gateway_mode` string
          - `updated_at` string
          - `vault_token` string
          - `gateway_id` string
          - `expire_year` integer
          - `expire_month` integer
          - `address_country` string
          - `address_line1` string
          - `address_line2` string
          - `address_city` string
          - `address_state` string
          - `address_postcode` string
          - `card_name` string
          - `card_number_last4` string
          - `card_number_bin` string
          - `card_scheme` string
          - `ref_token` string
          - `status` string
          - `created_at` string
          - `_id` string
          - `type` string
      - `statistics` object
        - `total_collected_amount` integer
        - `successful_transactions` integer
      - `schedule` object
        - `interval` string
        - `start_date` string
        - `end_date` string
        - `next_assessment` string
        - `next_assessment_planned` string
        - `first_assessment` string
        - `status` string
        - `processing_pended_at` string
        - `last_assessment_planned` string
        - `last_assessment` string
        - `locked` boolean
        - `completed_count` integer
        - `held_count` integer
        - `retry_count` integer
        - `frequency` integer
      - `currency` string

## Other responses

- `400` — 400

---

[API](https://skmtc.dev/commbank/apis/powerboard-api.md) · [All operations](https://skmtc.dev/commbank/apis/powerboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/commbank/powerboard-api/revisions/2ef3ed32f8c2/schema)