Sign in
latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Retrieve Subscription

Get Subscription By Subscription Id

Get subscription details by subscription Id

get/v1/subscriptions/{subId}

Path parameters

subIdstring required

Subscription Id

Headers

tokenstring required

Basic authorization (dispatch Key and Secret) or Full access token

Response

OK

idstring

Subscription id

billingAgreementIdstring

Billing agreement id

externalReferenceIdstring

External reference id

creationDatestring date-time

Subscription creation date

activationDatestring date-time

Subscription activation date

nextRenewalDatestring date-time

Subscription next renewal date

nextBillingDatestring date-time

Subscription next billing date

expirationDatestring date-time

Subscription expiration date

graceDatestring date-time

Subscription grace date

cancellationDatestring date-time

Subscription cancellation date

currentQuantityinteger

Subscription current quantity

renewalQuantityinteger

Subscription renewal quantity

autoRenewalboolean

Subscription auto renewal flag

localestring

Subscription locale

durationinteger

Subscription duration

frequencyinteger

Subscription frequency

currentBillingCycleNumberinteger

Subscription current billing cycle

totalNumberOfBillingCycleinteger

Subscription total billing cycle

siteIdstring

Site id