User Management Service Details

The User Management service allows third-party applications to perform the following tasks:

Task
Request Type
Response Type
Activate a user
Activate Shopper Request
Activate Shopper Response
Inactivate a user
Inactivate Shopper Request
Inactivate Shopper Response
Reset user password
Reset Shopper Password Request
Reset Shopper Password Response
Retrieve user information
Get Shopper Request
Get Shopper Response
Add/modify users, including updating the user's default billing method
Add Update Shopper Request
Add Update Shopper Response
Cancel a user's subscription
Cancel Subscription Request
Cancel Subscription Response
Activate a user's subscription
Activate Subscription Request
Activate Subscription Response
Modify a subscription's renewal date
Modify Renewal Date Request
Modify Renewal Date Response
Modify a subscription's renewal mechanism (manual or auto)
Modify Auto Renewal Request
Modify Auto Renewal Response
Search for a user's orders and get the order details
Search Order Request
Search Order Response
Cancel a user's order
Cancel Order Request
Cancel Order Response
Return a user's order
Return Order Request
Return Order Response
Add or modify extended attributes on an user's order and line items
Update Order Attributes Request
Update Order Attributes Response

All the tasks mentioned above can use user-based basic authentication. You can configure the user-based authentication per client integration. The complex type(s) CommonRequest and CommonResponse are inherited by all the complex types mentioned above.

Activate a User's Subscription

There are restrictions for an Activate Subscription Request call. Factors (such as payment type and auto/manual) are not verified when sending an Activate Subscription Request call. The following table lists the only validations that occur during an Activate Subscription Request call.

Validation Task
Error Code
Error message
Details
The user identified in the element is a valid user
200
Shopper Not Found

The Subscription identified in the element is a valid Subscription
710
Subscription order [888888] pending activation was not found
Where 888888 is the value passed in the element
The specified Subscription belongs to the specified user
720
Subscription order [888888] does not belong to shopper [loginID =12345, externalReferenceID = 54321]
Where 888888 is the value passed in the element; and 12345 and 54321 are the DigitalRiver loginID and externalReferenceID for the shopper
The specified Subscription contains a subscription product
730
No subscription products found for the order [888888]
Where 888888 is the value passed in the element
The product identified in the element is a valid product
730
No subscription products found for the order [productID=22222externalReferenceID=33333companyID=44444locale=55555]
Where 22222, 33333, 44444, 55555 are the values provided in the element
The activation key supplied in the element is valid for the given Subscription
750
Activation Key [activationKey=111] for provided productKey [productID=22222externalReferenceID=33333companyID=44444locale=55555] was not found
Where 111 is the activation key supplied in the  element and 22222, 33333, 44444, 55555 are the values provided in the element
The activation date supplied in the element is in a valid format
n/a
n/a
If invalid, the activation date will be set to the current date
The activation key supplied in the element has not previously been activated
770
The subscription for the provided Activation Key [activationKey=111] has already been activated
Where 111 is the activation key supplied in the element
The subscription line item has not already been refunded
780
Order [888888] has been refunded
Where 888888 is the value passed in the element
The subscription line item has not already been canceled
790
Order [888888] was canceled
Where 888888 is the value passed in the element
The renewal date supplied in the element is in a valid format and does not occur in the past
850
Requested renewal date is invalid.

Your subscription <sub ID> was renewed on <renew date> which is before so your message cannot be processed
851
Requested renewal date is before subscription activation date.

Nothing invalid
0
Your request was carried out successfully

User Management (Canonical Version 2) Example

<CancelSubscriptionRequest>
 <shopperKey>
    <userID>26593336708</userID>
    <siteID>tmamer</siteID>
  </shopperKey>
    <SubscriptionID>4343240414</SubscriptionID>
    <subscriptionProductKey>
    	<productID>55551800</productID>
    	<companyID>tmamer</companyID>
      <externalReferenceID></externalReferenceID>
    </subscriptionProductKey>
    <suppressCancelNotification>false</suppressCancelNotification>
	 <subscriptionKey>
		<subscriptionID>463301709</subscriptionID>
	</subscriptionKey>
</CancelSubscriptionRequest>

<ModifyAutoRenewalRequest >
 <shopperKey>
    <userID>26593336708</userID>
    <siteID>tmamer</siteID>
 </shopperKey>
    <SubscriptionID>4343240414</SubscriptionID>
    <subscriptionProductKey>
		<productID>55551800</productID>
    	<companyID>tmamer</companyID>
        <externalReferenceID></externalReferenceID>
    </subscriptionProductKey>
    
    <activationKey>22222</activationKey>
    <autoRenewalAction>Manual</autoRenewalAction>
    <autoRenewalDate>2009-08-08</autoRenewalDate>
    <subscriptionKey>
		<subscriptionID>463301709</subscriptionID>
	</subscriptionKey>
</ModifyAutoRenewalRequest>

<ActivateSubscriptionRequest>
 <shopperKey>
    <userID>26593336708</userID>
    <siteID>tmamer</siteID>
  </shopperKey>
    <SubscriptionID>4343240414</SubscriptionID>
    <subscriptionProductKey>
    	<productID>55551800</productID>
    	<companyID>tmamer</companyID>
      <externalReferenceID></externalReferenceID>
    </subscriptionProductKey>
    <activationDate>2009-02-03</activationDate>
    <renewalDate>2009-08-08</renewalDate>
    <subscriptionKey>
		<subscriptionID>463301709</subscriptionID>
	</subscriptionKey>
</ActivateSubscriptionRequest>

Suspending Subscriptions

Suspend a Subscription

When you suspend a subscription, Digital River generates a suspension key that is unique to this subscription. (You are not responsible for providing the suspension key.)

The start date and end date must be in the YYYY:mm:ddTHH:mm:ssZ format. 

If you want to start the suspension, do not provide the date. To change the suspension's end date to be indefinite, set the noEndDate value to true.

Specify the type of suspension you want to create. If you do not provide the suspension type and provide both a suspension end date and no suspension date, this action will result in an error.

Modify an Existing Suspension Date for a Subscription

When modifying the existing suspension date for a subscription, you must supply the subscription key, the suspension type, and the new suspension date. To start the suspension immediately, provide the current date. To change the suspension's end date to be indefinite, set the noEndDate value to true.

End an Existing/Future Suspension

To end an existing or future extension, you must supply the subscription key, suspension type, and the current date in the End Date field. This action removes the suspension.

Sample Process Flow for Modifying a Suspension