Skip to content
OpenShop Logo OpenShop

Subscription Details

GET
/admin/subscription

Get subscription details by id

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
id
required
number

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Get subscription details by id

object
subscription
required
object
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
adminNotes
required
string | null
nextProcessingDate
required
Any of:
failedAttemptCount
required
number
failureReason
required
string | null
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
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
compareAtPrice
required
string | null
lineTotal
required
string
discountTotal
required
string
basePriceLineTotal
required
string
subscriptionCustomer
required
object
userId
required
number
email
required
string
firstName
required
string
lastName
required
string
phoneNumber
required
string | null
phoneCountry
required
string | null
shippingAddress
required
object
id
required
number
createdOn
required
string
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
providerPaymentMethodId
required
string
paymentType
required
isDefault
required
boolean
isActive
required
boolean
lastFour
required
string | null
brand
required
string
expiryYear
required
string | null
expiryMonth
required
string | null
name
required
string
subscriptionOrders
required
Array<object>
object
currencyCode
required
string
id
required
number
orderNumber
required
number
createdOn
required
string
grandTotal
required
string
fulfillmentStatus
required