Skip to content

Get Subscription Details

GET
/subscription

Get subscription details for the current user by id

id
required
number

Get subscription details for the current user by id

object
subscription
required
object
currencyCode
required
string
orderNumber
required
number
subscriptionPlanMinCycles
required
number | null
subscriptionPlanMaxCycles
required
number | null
name
required
string
variantDisplay
required
string | null
productImageUrl
required
string | null
sku
required
string | null
lineTotal
required
string
id
required
number
createdOn
required
string
status
required
lastProcessedDate
required
string | null
originalOrderId
required
number
intervalCount
required
number
intervalUnit
required
pausedUntil
required
string | null
cancelledOn
required
string | null
cancelReason
required
string | null
subscriptionNumber
required
number
nextProcessingDate
required
Any of:
productId
required
number
variantId
required
number | null
quantity
required
number
unitPrice
required
string
subscriptionPlanId
required
number
priceProperties
required
Array<object>
object
pricePropertyDefinitionId
required
number
key
required
string
displayName
required
string
value
required
string
subscriptionShippingAddress
required
object
id
required
number
createdOn
required
string
isDefault
required
boolean
company
required
string | null
streetLine1
required
string
streetLine2
required
string | null
city
required
string
stateProvince
required
string
postalCode
required
string
countryCode
required
firstName
required
string
lastName
required
string
subscriptionPayment
required
Any of:
object
id
required
number
provider
required
paymentType
required
lastFour
required
string | null
brand
required
string
expiryYear
required
string | null
expiryMonth
required
string | null
name
required
string
providerPaymentMethodId
required
string
isDefault
required
boolean
isActive
required
boolean