Subscriptions

Use the Subscription API to get specific subscription information by an ID or all subscriptions information for shoppers. A subscription is a product that a shopper purchases on a recurring basis, such as weekly, monthly, or yearly. Subscription products are charged on a pre-recurrence basis, so if the subscription is set to renew every year, the shoppers are charged for that product every year. Examples of subscription products include virus scanning software, online newspapers, or season tickets.

Note:

Subscriptions are only available after a shopper sumbits a cart.

Methods


					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: application/xml
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<subscriptions uri="https://api.digitalriver.com/v1/shoppers/me/subscriptions">
   <subscription uri="https://api.digitalriver.com/v1/shoppers/me/subscriptions/subscription_ID"/>
</subscriptions>
			
					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: application/xml
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					<subscription  uri="https://api.digitalriver.com/v1/shoppers/me/subscriptions/subscription_ID">
   <id>subscription_ID</id>
   <creationDate>2013-01-25T13:29:45.000Z</creationDate>
   <activationDate>2013-01-25T06:00:00.000Z</activationDate>
   <nextRenewalDate>2013-03-01T06:00:00.000Z</nextRenewalDate>
   <expirationDate>2013-03-01T06:00:00.000Z</expirationDate>
   <graceDate>2013-03-01T06:00:00.000Z</graceDate>
   <cancellationDate>2013-01-31T00:00:00.000Z</cancellationDate>
   <renewalQuantity>1</renewalQuantity>
   <nextRenewalQuantity>1</nextRenewalQuantity>
   <autoRenewal>enabled</autoRenewal>
   <status>Cancelled</status>
   <products>
      <product uri="https://api.digitalriver.com/v1/shoppers/me/products/product_ID">
         <displayName>Software Service Subscription</displayName>
      </product>
   </products>
   <orders>
      <order uri="https://api.digitalriver.com/v1/shoppers/me/orders/order_ID"/>
   </orders>
</subscription>
			

Response Body Parameters

Field
Data Type
Visibility
Description
activationDate
date
default
The subscription's activation date. You can base the activation date on either the purchase date or the date the shopper activates and begins using the subscription product.
autoRenewal
string
default
When enabled, the subscription's renewal type is autoRenew. Possible values: enabled or disabled.
cancellationDate
date
default
The date when the subscription was canceled.
creationDate
date
default
The date when the subscription was created.
expirationDate
date
default
The date when a subscription expires.
graceDate
date
default
The date the grace period ends. After a subscription expires, a grace period allows shoppers a short window of time during which they can renew the subscription without an interruption or restriction of service.
id
string
default
The subscription ID. The ID is assigned automatically when the subscription is created.
nextRenewalDate
date
default
The date the subscription is due for renewal.
nextRenewalQuantity
int
default
The quantity of a subscription for the next renewal.
orders
structured
expand
The orders for which a subscription was purchased. Currently, this list contains only the current and original orders. See the Orders API for more information.
products
structured
expand
A list of products for a subscription. See the Products API for more information.
renewalQuantity
int
default
The current renewal quantity for a subscription.
status
string
default
The current status of a subscription. Possible values: Not Started, Active, Cancelled, or Expired.