User management
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 allows third-party applications to perform the following tasks:
Task | Request Type | Response Type |
Activate a user |
|
|
Inactivate a user |
| |
Reset user password | | |
Retrieve user information | | |
Add/modify users, including updating the user's default billing method | | |
Cancel a user's subscription | | |
| | |
Modify a subscription's renewal date | | |
Modify a subscription's renewal mechanism (manual or auto) | | |
Search for a user's orders and get the order details | | |
Cancel a user's order |
| |
Return a user's order | | |
Add or modify extended attributes on a user's order and line items | |
|
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.
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 | 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 |
The specified | Error Code: 720
Message: Subscription order [888888] does not belong to shopper [loginID =12345, externalReferenceID = 54321]
Details: Where the |
The specified Subscription contains a given product | Error Code: 730
Message: No subscription products found for the order [888888]
Details: Where |
The product identified in the `' element is valid | Error Code: 730
Message: No subscription products found for the order |
The activation key supplied in the | Error Code: 750
Message: Activation Key [activationKey=111] for provided productKey [productID=22222externalReferenceID=
33333companyID=44444locale=55555] was not found
Details: Where |
The activation date supplied in the | 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 | Error Code: 770
Message: The subscription for the provided Activation Key [activationKey=111] has already been activated
Details: Where |
The subscription line item has not already been refunded | Error Code: 780
Message: Order [888888] has been refunded
Details: Where |
The subscription line item has not already been cancelled | Error Code: 790
Message: Order [888888] was cancelled
Details: Where |
Your subscription | 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 |
{"CancelSubscriptionRequest": {"shopperKey": {"userID": "26593336708","siteID": "tmamer"},"SubscriptionID": "4343240414","subscriptionProductKey": {"productID": "55551800","companyID": "tmamer","externalReferenceID": ""},"suppressCancelNotification": "false","subscriptionKey": {"subscriptionID": "463301709"}}}​{"ModifyAutoRenewalRequest": {"shopperKey": {"userID": "26593336708","siteID": "tmamer"},"SubscriptionID": "4343240414","subscriptionProductKey": {"productID": "55551800","companyID": "tmamer","externalReferenceID": ""},"activationKey": "22222","autoRenewalAction": "Manual","autoRenewalDate": "2009-08-08","subscriptionKey": {"subscriptionID": "463301709"}}}​{"ActivateSubscriptionRequest": {"shopperKey": {"userID": "26593336708","siteID": "tmamer"},"SubscriptionID": "4343240414","subscriptionProductKey": {"productID": "55551800","companyID": "tmamer","externalReferenceID": ""},"activationDate": "2009-02-03","renewalDate": "2009-08-08","subscriptionKey": {"subscriptionID": "463301709"}}}
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.
