User management

Search…
User management
Learn how to manage users.
User Management provides an interface that third-party applications and processes can use to manage and retrieve Digital River-hosted user information. Use this service to add, modify, or remove a single user.
User management details
User Management allows third-party applications to perform the following tasks:
Task
Request Type
Response Type
Activate a user
ActivateShopperRequest
ActivateShopperResponse
Inactivate a user
InactivateShopperRequest
 InactivateShopperResponse
Reset user password
 ResetShopperPasswordRequest
 ResetShopperPasswordRequest
Retrieve user information
 GetShopperRequest
 GetShopperResponse
Add/modify users, including updating the user's default billing method
 AddUpdateShopperRequest
 AddUpdateShopperResponse
Cancel a user's subscription
 CancelSubscriptionRequest
 CancelSubscriptionResponse
​Activate a user's subscription​
ActivateSubscriptionRequest
 ActivateSubscriptionResponse
Modify a subscription's renewal date
 ModifyRenewalDateRequest
 ModifyRenewalDateResponse
Modify a subscription's renewal mechanism (manual or auto)
 ModifyAutoRenewalRequest
 ModifyAutoRenewalResponse
Search for a user's orders and get the order details
 SearchOrderRequest
 SearchOrderResponse
Cancel a user's order
CancelOrderRequest
 CancelOrderResponse
Return a user's order
 ReturnOrderRequest
 ReturnOrderResponse
Add or modify extended attributes on a user's order and line items
 UpdateOrderAttributesRequest
UpdateOrderAttributesResponse
All tasks mentioned above can use user-based basic authentication. You can configure this authentication per client integration. All the complex types mentioned above inherit CommonRequest and CommonResponse.
Activate a user's subscription
There are restrictions for an ActivateSubscriptionRequest. When sending an ActivateSubscriptionRequest, the request does not verify factors such as payment type and auto/manual. The following table lists the validations that occur during an ActivateSubscriptionRequest.
Validation Task
Error Information
The user identified in the shopperKey element is valid 
Error Code: 200
Message: Shopper Not Found
The subscription identified in the 'SubscriptionID` element is valid
Error Code: 710
Message: Subscription order [888888] pending activation was not found
Details: Where the <SubscriptionID> element passes the 888888 value.
The specified Subscription belongs to the given user
Error Code: 720
Message: Subscription order [888888] does not belong to shopper [loginID =12345, externalReferenceID = 54321]
Details: Where the<SubscriptionID> element passes the 888888 value. The values 12345 and 54321 are the Digital River loginID and externalReferenceID for the shopper.
The specified Subscription contains a given product
Error Code: 730
Message: No subscription products found for the order [888888]
Details: Where888888 is the value passed in the <subscriptionProductKey> element
The product identified in the `' element is valid
Error Code: 730
Message: No subscription products found for the order [productID=22222externalReferenceID= 33333companyID=44444locale=55555]
Details: Where <subscriptionProductKey> element provides the values22222,33333,44444,55555`.
The activation key supplied in the <activatioKey> element is valid for the given Subscription
Error Code: 750
Message: Activation Key [activationKey=111] for provided productKey [productID=22222externalReferenceID=
33333companyID=44444locale=55555] was not found
Details: Where 111 is the activation key supplied in the <acivtionKey> element and 22222, 33333, 44444, 55555 are the values provided in the element
The activation date supplied in the <activationDate> element is valid
Error Code: Not applicable
Message: Not applicable
Details: If invalid, the activation date will be set to the current date
The activation key supplied in the <activationKey> element has not previously been activated
Error Code: 770
Message: The subscription for the provided Activation Key [activationKey=111] has already been activated
Details: Where 111 is the <activationKey> activation key supplied in the element
The subscription line item has not already been refunded
Error Code: 780
Message: Order [888888] has been refunded
Details: Where 888888 is the value passed in the <SubscriptionID> element
The subscription line item has not already been cancelled
Error Code: 790
Message: Order [888888] was cancelled
Details: Where 888888 is the value passed in the <SubscriptionID> element
Your subscription <SubscriptionID> was renewed on renewal date which is before so your message cannot be processed*
Error Code: 851
Message: Requested renewal date is before the subscription activation date
Details: Not applicable
Nothing invalid
Error Code: 0
Message: Your request was carried out successfully.
Details: Not applicable
Request sample
1
{
2
	"CancelSubscriptionRequest": {
3
		"shopperKey": {
4
			"userID": "26593336708",
5
			"siteID": "tmamer"
6
		},
7
		"SubscriptionID": "4343240414",
8
		"subscriptionProductKey": {
9
			"productID": "55551800",
10
			"companyID": "tmamer",
11
			"externalReferenceID": ""
12
		},
13
		"suppressCancelNotification": "false",
14
		"subscriptionKey": {
15
			"subscriptionID": "463301709"
16
		}
17
	}
18
}
19
​
20
{
21
	"ModifyAutoRenewalRequest": {
22
		"shopperKey": {
23
			"userID": "26593336708",
24
			"siteID": "tmamer"
25
		},
26
		"SubscriptionID": "4343240414",
27
		"subscriptionProductKey": {
28
			"productID": "55551800",
29
			"companyID": "tmamer",
30
			"externalReferenceID": ""
31
		},
32
		"activationKey": "22222",
33
		"autoRenewalAction": "Manual",
34
		"autoRenewalDate": "2009-08-08",
35
		"subscriptionKey": {
36
			"subscriptionID": "463301709"
37
		}
38
	}
39
}
40
​
41
{
42
	"ActivateSubscriptionRequest": {
43
		"shopperKey": {
44
			"userID": "26593336708",
45
			"siteID": "tmamer"
46
		},
47
		"SubscriptionID": "4343240414",
48
		"subscriptionProductKey": {
49
			"productID": "55551800",
50
			"companyID": "tmamer",
51
			"externalReferenceID": ""
52
		},
53
		"activationDate": "2009-02-03",
54
		"renewalDate": "2009-08-08",
55
		"subscriptionKey": {
56
			"subscriptionID": "463301709"
57
		}
58
	}
59
}
Copied!
Suspending subscriptions
When you suspend a subscription, the system 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 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.
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 indefinite, set the noEndDate value to true.
To end an existing or future suspension, you must supply the subscription key, suspension type, and the current date in the End Date field. This action removes the suspension.
The following image shows the process flow for modifying a suspension.
Modifying a suspension
User management schemas
Version
Scheme Components Table
Raw Schema
Sample XML
24 (Current)
​View ​
​View​
Not available
23
​View 
​View​
Not available
22
​View​
​View​
Not available
Customers
Single sign-on (SSO)
Last modified 1yr ago
Copy link
Contents
User management details
Activate a user's subscription
Suspending subscriptions
User management schemas