Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

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

freeTrialboolean

If <code>true</code>, indicates that this is a free trial.

autoRenewalboolean

If <code>true</code>, indicates that renewals for this subscription are automatic rather than manual.

termsstring

For auto renewal subscriptions, the terms displayed to the customer at acquisition.

planIdstring

The unique identifier of the plan

subscriptionIdstring

The subscription identifier.

billingAgreementIdstring

The Digital River billing agreement identifier.

startTimestring date-time

The start date and time of the subscription.

endTimestring date-time

The <code>startTime</code> plus the subscription duration.

Example response

{
  "freeTrial": true,
  "autoRenewal": true,
  "terms": "Please accept these terms.",
  "planId": "654321",
  "subscriptionId": "665430999",
  "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf"
}