---
title: "Retrieve a subscription"
method: GET
path: "/subscriptions/{subscription_id}"
tags: ["Subscriptions"]
---

# Retrieve a subscription

`GET /subscriptions/{subscription_id}`

Retrieves the details of a subscription with the given `subscription_id`.

## Path parameters

- `subscription_id` string, required

## Query parameters

- `accountId` string
- `begin` string, date
- `end` string, date
- `event` 'canceled' | 'charged' | 'created' | 'deactivated' | 'trialended' | 'trialstarted'
- `products` string
- `scope` 'all' | 'live' | 'test'
- `status` 'active' | 'canceled' | 'deactivated' | 'overdue' | 'trial'

## Response `200`

OK

- GetASubscriptionResponse — Response schema containing detailed subscription information.
  - `id` string — Unique identifier for the subscription.
  - `subscription` string — Identifier for the subscription, same as `id`.
  - `active` boolean — Indicates if the subscription is active.
  - `state` string — Current state of the subscription (e.g., trial, active, canceled).
  - `isSubscriptionEligibleForPauseByBuyer` boolean — Indicates if the buyer can pause the subscription.
  - `isPauseScheduled` boolean — Indicates if a pause is scheduled for the subscription.
  - `changed` integer — Timestamp of the last change to the subscription in milliseconds.
  - `changedValue` integer — Value of the last change timestamp in milliseconds.
  - `changedInSeconds` integer — Value of the last change timestamp in seconds.
  - `changedDisplay` string — Human-readable display of the last change date.
  - `live` boolean — Indicates if the subscription is live or in test mode.
  - `declineReason` string — Reason for payment decline, if applicable.
  - `paymentMethod` string — The payment method associated with the subscription.
  - `expiry` string — Expiry date of the payment method in MM/YY format.
  - `cardEnding` string — Last four digits of the payment card.
  - `cardType` string — Type of payment card used (e.g., VISA, Mastercard).
  - `currency` string — Currency used for subscription billing.
  - `account` string — Account ID associated with the subscription.
  - `product` string — Product path of the subscription.
  - `sku` string — SKU of the subscription product.
  - `display` string — Display name of the subscription product.
  - `quantity` integer — Quantity of the subscription product.
  - `adhoc` boolean — Indicates if the subscription is ad-hoc.
  - `autoRenew` boolean — Indicates if the subscription is set to auto-renew.
  - `price` number — Price of the subscription.
  - `priceDisplay` string — Human-readable display of the subscription price.
  - `priceInPayoutCurrency` number — Subscription price in the payout currency.
  - `priceInPayoutCurrencyDisplay` string — Human-readable display of the subscription price in payout currency.
  - `discount` number — Discount amount applied to the subscription.
  - `discountDisplay` string — Human-readable display of the discount amount.
  - `discountInPayoutCurrency` number — Discount amount in the payout currency.
  - `discountInPayoutCurrencyDisplay` string — Human-readable display of the discount in payout currency.
  - `subtotal` number — Subtotal amount of the subscription.
  - `subtotalDisplay` string — Human-readable display of the subscription subtotal.
  - `subtotalInPayoutCurrency` number — Subtotal amount in the payout currency.
  - `subtotalInPayoutCurrencyDisplay` string — Human-readable display of the subtotal in payout currency.
  - `attributes` object — Custom attributes associated with the subscription.
  - `addons` object[] — Add-ons associated with the subscription.
    - `product` string — Product path of the add-on.
    - `sku` string — SKU of the add-on.
    - `display` string — Display name of the add-on.
    - `quantity` integer — Quantity of the add-on product.
    - `price` number — Price of the add-on product.
    - `priceDisplay` string — Human-readable display of the add-on price.
  - `nextChargeDate` string, date-time — The next charge date for the subscription.

## Other responses

- `400` — Bad Request
- `401` — Authentication credentials are missing or invalid.
- `429` — Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header.
- `500` — Internal server error.

---

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