Skip to main content
GET
Retrieve a subscription.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

subscriptionUid
string | null
required

The subscription's unique identifier

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
BillingRenewalTerm
enum<integer>

1 - Monthly, 2 - Yearly, 3 - Quarterly, 4 - One Time

Available options:
1,
2,
3,
4
Required range: 1 <= x <= 4
Account
Account · object | null

Circular reference to Account (not expanded here).

Plan
object | null
Example:
Quantity
integer<int32> | null
StartDate
string<date-time>
EndDate
string<date-time> | null
ExpirationDate
string<date-time> | null
RenewalDate
string<date-time> | null
NewRequiredQuantity
integer<int32> | null
IsPlanUpgradeRequired
boolean
PlanUpgradeRequiredMessage
string | null
SubscriptionAddOns
object[] | null
DiscountCouponSubscriptions
object[] | null
DiscountCode
string | null
DiscountCouponExpirationDate
string<date-time> | null
LatestInvoice
object | null
Example:
Rate
number<decimal> | null