v1

latestSwagger 2.02026-07-1351226.3 KB

Retrieve details for the specified Subscription

get/v1/subscriptions/{subscriptionId}

subscriptionIdstring required

Unique identifier of the Subscription to retrieve

X-App-Keystring required

A unique application key identifying the source of the request. This is required for request tracking

X-Shopper-Idstring

Shopper ID to be operated on, if different from JWT

Request was successful

cancelableboolean

Whether or not the Subscription is allowed to be canceled

createdAtstring iso-datetime required

When the Subscription was created

expiresAtstring iso-datetime

When the Subscription will expire

labelstring

A human readable description of this Subscription

launchUrlstring url

The url to use or manage this Subscription's active product

paymentProfileIdinteger

Unique identifier of the payment profile that will be used to automatically renew this Subscription

priceLockedboolean required

Whether the renewal price will be based from the list price or a locked-in price for this shopper

renewAutoboolean required

Whether or not the Subscription is set to be automatically renewed via the billing agent

renewableboolean 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

subscriptionIdstring required

Unique identifier of the Subscription

upgradeableboolean required

Whether or not the Subscription is allowed to be upgraded