---
title: "Retrieve details for the specified Subscription"
method: GET
path: "/v1/subscriptions/{subscriptionId}"
tags: ["v1"]
---

# Retrieve details for the specified Subscription

`GET /v1/subscriptions/{subscriptionId}`

## Path parameters

- `subscriptionId` string, required

## Headers

- `X-App-Key` string, required
- `X-Shopper-Id` string

## Response `200`

Request was successful

- Subscription
  - `addons` SubscriptionAddon[] — An array of additional products that have been purchased to augment this Subscription
    - `commitment` 'PAID' | 'FREE' | 'TRIAL', required — The financial commitment the customer has in the product
    - `pfid` integer, required — Unique identifier of the add-in product
    - `quantity` integer, required
  - `billing` SubscriptionBilling, required
    - `commitment` 'PAID' | 'FREE' | 'TRIAL', required — The financial commitment the customer has in the product
    - `pastDueTypes` string[] — The types of charges that are past due when `status` is PAST_DUE
    - `renewAt` string, iso-datetime, required — The point in time after which the Subscription will bill for automatic renewal
    - `status` 'CURRENT' | 'PAST_DUE', required — Whether payments are past due
  - `cancelable` boolean — Whether or not the Subscription is allowed to be canceled
  - `createdAt` string, iso-datetime, required — When the Subscription was created
  - `expiresAt` string, iso-datetime — When the Subscription will expire
  - `label` string — A human readable description of this Subscription
  - `launchUrl` string, url — The url to use or manage this Subscription's active product
  - `paymentProfileId` integer — Unique identifier of the payment profile that will be used to automatically renew this Subscription
  - `priceLocked` boolean, required — Whether the renewal price will be based from the list price or a locked-in price for this shopper
  - `product` SubscriptionProduct, required
    - `label` string, required — A human readable description of the Product that is subscribed
    - `namespace` string, required — Grouping of related Subscriptions
    - `pfid` integer, required — Unique identifier of the Product that is subscribed
    - `productGroupKey` string, required — Primary key of a grouping of related Subscriptions
    - `renewalPeriod` integer, required — The number of `renewalPeriodUnits` that will be added by the `renewalPfid`
    - `renewalPeriodUnit` 'MONTH' | 'QUARTER' | 'SEMI_ANNUAL' | 'YEAR', required — The unit of time that `renewalPeriod` is measured in
    - `renewalPfid` integer, required — Unique identifier of the renewal Product
    - `supportBillOn` boolean, required — Whether the product supports the `billOn` option on the renewal endpoint
  - `relations` SubscriptionRelations
    - `children` string[] — A set of related Subscriptions that will be canceled automatically if this Subscription is canceled
    - `parent` string — Unique identifier of this Subscription's parent
  - `renewAuto` boolean, required — Whether or not the Subscription is set to be automatically renewed via the billing agent
  - `renewable` boolean, required — Whether or not the Subscription is allowed to be renewed
  - `status` 'ACTIVE' | 'PENDING' | 'CANCELED', required — Whether the Subscription is active or the specific non-active state
  - `subscriptionId` string, required — Unique identifier of the Subscription
  - `upgradeable` boolean, required — Whether or not the Subscription is allowed to be upgraded

## Other responses

- `400` — Request was malformed
- `401` — Authentication info not sent or invalid
- `403` — Authenticated user is not allowed access
- `404` — Resource not found
- `422` — Invalid Subscription Id
- `429` — Too many requests received within interval
- `500` — Internal server error
- `504` — Gateway timeout

---

[API](https://skmtc.dev/godaddy/apis/untitled-api-6.md) · [All operations](https://skmtc.dev/godaddy/apis/untitled-api-6/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/godaddy/untitled-api-6/revisions/557ceee3e2d8/schema)