LogoLogo
System Status
  • Commerce API
    • Test and use cases
    • Roles and permissions
    • Sending API calls
  • Shopper APIs
    • Shopper basics
      • Common use cases
        • Creating a customer
        • Applying store credit
        • Private store workflow
        • Guest checkout
    • OAuth
      • Authentication
      • OAuth 2.0 APIs
      • Token
      • Access tokens
      • Session-aware access tokens
      • Authorizing a shopper
    • Shoppers
      • Managing shoppers
        • User management
        • Single sign-on (SSO)
        • Data validation
        • Bulk user management
        • Bulk user account export
      • Managing a shopper's account
      • Managing a shopper's address
      • Managing payment options
    • Product discovery
      • Categories
      • Products
      • Product variations
      • Pricing
      • Inventory status
      • Financing
      • Offers
        • Understanding offers
        • How to use point of promotions (POPs)
          • Retrieving all point of promotion offers for a specific product
          • Retrieving all offers for a specific point of promotion
        • How to use offers
      • Private stores
        • Managing private stores
        • Submitting an order for a private store
        • Useful APIs
      • Fulfillment
        • Electronic Fulfillment Service (OFI)
        • Digital rights
        • Digital rights revocation
        • Physical fulfillment
          • EDI X12 832 definition data elements
          • EDI X12 846 definition data elements
          • EDI X12 850 definition data elements
          • EDI X12 855 definition data elements
          • EDI X12 856 definition data elements
          • EDI X12 180-1 definition data elements
          • EDI X12 180-2 definition of data elements
          • EDI X12 180-3 definition of data elements
    • Cart
      • Applying a shopper to a cart
      • Getting the current cart
      • Creating or updating a cart
        • Adding a product to a cart
          • Gifting
        • Capturing the customer's IP address
        • Providing address information
        • Managing the shipping or billing address
        • Providing subscription information
        • Managing payment methods
        • Capturing the Terms of Sale (TOS) acceptance
      • Managing offers in a cart
        • Applying an offer
        • Applying a coupon or promo code
        • Getting all applied offers
        • Removing an applied offer
        • Removing eligible offers
        • Reconciling conflicting offers
        • Dynamic offers/personalization
          • Skipping Global Commerce merchandising offer arbitration
          • Triggering a promotional URL offer
          • Overriding a promotional URL offer discount
      • Pricing
        • Landed cost
          • Mixed cart support
          • Tax-included pretty price
      • Redirecting to a Digital River-hosted cart
      • Configuring taxes
        • Managing tax identifiers
      • Managing shipping options
        • Getting shipping options
        • Providing a shipping discount
      • Managing line items
      • Applying a price override
      • Managing payment sessions
      • Managing web checkout
      • Submitting a cart
        • Initiating a charge
        • Authorization declines
      • Resuming cart submission
      • HGOP2
    • Orders
      • Getting orders
      • Selling entities
      • Retrieving addresses from an order
      • Retrieving line items from an order
      • Order lookup
      • Returns
        • Initiate an authenticated session
        • Setting up returns in Global Commerce
        • Managing returns
    • Subscriptions
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Updating the subscription's shipping address
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
      • Immediately apply a midterm subscription change
        • Reducing the subscription renewal quantity
  • Admin APIs
    • Admin basics
      • Available Admin API calls
    • Order management
      • Getting the order's details
      • Downloading the invoice
    • Offer management
    • Refund management
      • Authorization
      • Refund reason codes
      • Creating a satisfaction refund
      • Getting the available refunds for a specific order
      • Getting refunds for a specific order
      • Getting refunds available for a shopper's order
      • Getting the JSON schema for an order refund
      • Managing a refund for a delayed payment method
      • Refund error scenarios
    • Subscription management
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update the subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal product
        • Changing the subscription renewal price
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Activating a subscription
        • Changing the subscription's external reference identifier
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
        • Updating the subscription's expiration date
      • Immediately apply a midterm subscription change
        • Applying a midterm change with price override
        • Reducing the subscription renewal quantity
      • Subscription notifications
        • Updating the subscriber's email address
        • Card Account Updater
        • Sending a payment information change notification
        • Sending an expired credit card notification
        • Sending an invalid payment account notification
        • Sending a payment failure notification
        • Sending a subscription renewal reminder notification
        • Setting up subscription renewal reminders
        • Setting up trial subscription renewal reminders
        • Setting up marketing reminders
      • Using the Expired Card Optimizer
    • Customer management
      • Retrieving customer details
      • Requesting PII removal for a customer
    • Site management
      • Configuring authorized shipping and billing countries
      • Getting a site's authorized billing countries
      • Getting a site's authorized shipping countries
    • Product management
      • Getting started
      • Manage products (asynchronous API)
        • Creating or updating a product
        • Adding or updating a product variation
        • Deploying a product
        • Applying live changes
        • Retiring a product
        • Deleting a product variation
        • Deleting a base or individual product's locale
      • Retrieve products (synchronous API)
        • Getting a product by locale
        • Getting a product variation
        • Getting a product variation by locale
      • Get the task status for a product (synchronous API)
        • Getting the latest information on a product task
        • Retrieving the tasks for a specific product
        • Retrieving the tasks for products
      • Bulk operation
        • Asynchronous bulk operations
          • Creating products in bulk
          • Updating products in bulk
          • Deploying products in bulk
          • Deleting product variations in bulk
        • Bulk product upload (BPU)
        • Bulk Product Export (BPE)
          • Line-item level satisfaction refund
          • Order-level satisfaction refund
          • Auto-created line-item level return product
          • Line-item level return product
    • File management
      • Downloading a file
  • Payments
    • Payments solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BLIK
          • Configuring Boleto
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BLIK
      • Boleto
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Building payment workflows
      • Flows by payment type
      • Handling redirect payment methods
    • PSD2 and SCA
    • Payment testing scenarios
      • Testing standard payment methods
      • Testing redirect payment methods
      • Testing receiver payment methods
      • Testing the CCAvenue payment method
  • Events
    • Events overview
    • Responding to events
    • Event types
      • Delayed payment event types
        • Delayed payment expired event
          • Boleto
          • Konbini
          • Wire Transfer
        • Delayed payment reminder event
          • Boleto
          • Konbini
          • Wire Transfer
      • Subscription event types
        • Subscription created event
        • Subscription updated event
        • Subscription action processed event
        • Subscription cancelled event
        • Subscription credit card expired event
        • Subscription payment information changed event
        • Subscription renewal reminder event
        • Subscription renewed event
        • Subscription trial converted event
        • Subscription trial renewal reminder event
        • Subscription payment failed event
      • Post-order event types
        • Invoice created event
        • Refund credit memo event
      • Inventory event types
        • Inventory out of stock event
        • Inventory source and management
        • Inventory self-managed updated event
        • Inventory fulfiller-managed updated event
      • Post-order Notification Integration Guide
    • Webhooks
      • Commerce API safelist
      • Searching for a webhook
      • Creating a webhook
      • Using webhooks
      • Editing a webhook
      • Turning webhooks on or off
      • Revealing a webhook's secret
      • Rotating a webhook's secret
      • Viewing the webhook details
      • Deleting a webhook
  • Developer Resources
    • Postman collection
    • Commerce API references
    • Shopper APIs reference
    • Admin APIs reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline refund element
        • Online Banking elements
        • Tax Identifier element
        • Delayed payment instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
  • General resources
    • Global Commerce
    • Global Commerce
      • Company hierarchy
      • Categories
        • Getting a list of categories
      • Products
        • Product scenarios
        • Individual products
          • Creating an individual product
        • Base product with variants
          • Creating a base product with variants
        • Bundle offers
          • Creating a prorated bundle offer with a subscription
        • Product combination
          • Creating a product combination
        • Gifting
        • Inventory status
      • Customer service
        • Log a shopper's request to remove PII
      • Customers
        • Creating a customer
        • Digital River-maintained customer login
        • Client-maintained customer login
      • Transparent Commerce purchase flow
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2024 latest
      • 2023
      • 2022
      • 2021
      • 2020
Powered by GitBook
On this page
  • User management details
  • Activate a user's subscription
  • Cancel a subscription request
  • Modify auto-renewal request
  • Suspending subscriptions
  • User management schemas

Was this helpful?

  1. Shopper APIs
  2. Shoppers
  3. Managing shoppers

User management

Learn how to manage users.

User Management is a comprehensive service designed to assist third-party applications in efficiently handling user-related operations. This service supports user activation, password resets, subscription management, and order handling tasks, offering a standard interface with user-based authentication. It ensures secure and seamless management of user information hosted by Digital River.

User management details

The table below lists the various user management tasks that third-party applications can perform using specific request and response types. This collection of operations ensures seamless user management, from activation and password resets to subscription and order handling.

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

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

When you activate a user's subscription, you must meet the necessary validations to enable the subscription effectively. This process requires specific information about the user and their subscription details. It involves multiple checks to confirm the validity and ownership of the subscription, the associated product, and the activation key. Here, we outline the steps and validation tasks necessary for successful subscription activation and handling potential errors that may arise during the process.

To activate a subscription, you must send an ActivateSubscriptionRequest to the relevant endpoint. This request must include all necessary details, such as the user ID, subscription ID, product information, and activation date.

Here is a sample ActivateSubscriptionRequest:

{
	"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"
		}
	}
}

Remember to verify all validation tasks for successful subscription activation to avoid errors. Refer to the validation table for specific requirements.

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

Cancel a subscription request

You must provide specific details about the subscription and the user to cancel a subscription request. The process involves constructing a CancelSubscriptionRequest object with the required elements and sending it to the appropriate endpoint. This section will guide you through the steps necessary to cancel a subscription successfully.

To cancel a subscription request, follow these steps:

  1. Construct a CancelSubscriptionRequest object with the necessary details:

    • shopperKey including userID and siteID.

    • SubscriptionID for the subscription you want to cancel.

    • subscriptionProductKey with productID, companyID, and externalReferenceID.

    • Set suppressCancelNotification as needed.

    • Provide subscriptionKey with subscriptionID.

    • Send the request using the appropriate endpoint.

  2. Here is a sample CancelSubscriptionRequest:

{
	"CancelSubscriptionRequest": {
		"shopperKey": {
			"userID": "26593336708",
			"siteID": "tmamer"
		},
		"SubscriptionID": "4343240414",
		"subscriptionProductKey": {
			"productID": "55551800",
			"companyID": "tmamer",
			"externalReferenceID": ""
		},
		"suppressCancelNotification": "false",
		"subscriptionKey": {
			"subscriptionID": "463301709"
		}
	}

Modify auto-renewal request

Modifying an auto-renewal request allows you to change the settings related to a subscription's automatic renewal. It can include switching between manual and automatic renewal, updating the renewal date, or changing other relevant details. The following section outlines the steps to successfully modify an auto-renewal request, ensuring that your subscription preferences are up-to-date and accurate.

To modify an auto-renewal request, follow these steps:

  1. Construct a ModifyAutoRenewalRequest object with the necessary details:

    • shopperKey including userID and siteID.

    • SubscriptionID for the subscription you want to modify.

    • subscriptionProductKey with productID, companyID, and externalReferenceID.

    • Provide the activationKey.

    • Set the autoRenewalAction to either "Manual" or "Auto".

    • Specify the autoRenewalDate in the YYYY-MM-DD format.

    • Provide the subscriptionKey with subscriptionID.

  2. Send the request using the appropriate endpoint.

Here is a sample ModifyAutoRenewalRequest:

{
	"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"
		}
	}
}

Suspending subscriptions

Suspending a subscription temporarily halts the services and products associated with that subscription without completely canceling it. This function allows users to pause their subscription for a specific period or indefinitely. The process involves generating a unique suspension key and setting start and end dates for the suspension, with options for immediate suspension and indefinite end dates. Below, we outline the necessary steps and requirements for successfully suspending a subscription and handling any potential errors that may arise during the process.

To suspend a subscription, follow these steps:

  1. Ensure the system generates a unique suspension key for the subscription.

  2. Specify the start and end dates for the suspension in the YYYY:mm:ddTHH:mm:ssZ format.

    • If you want the suspension to start immediately, omit the start date.

    • To make the suspension's end date indefinite, set the noEndDate value to true.

  3. Specify the type of suspension you want to create. Do not provide both a suspension end date and no suspension date without a suspension type, as this will result in an error.

  4. When modifying an existing suspension date, supply the subscription key, suspension type, and new suspension date. To begin the suspension immediately, use the current date. Set noEndDate to true to make the suspension indefinite.

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.

User management schemas

The user management schema is a structured framework that defines the organization, attributes, and relationships of user data within a system. It typically includes versions outlining various components and configurations, essential for integration and effective user management. The table below lists the versions available:

Version
Scheme Components Table
Raw Schema
Sample XML

26 (Current

Not available

25

Not available

24

Not available

These versions help understand and manage how user-related data is handled, ensuring consistency and compliance across different system integrations.

PreviousManaging shoppersNextSingle sign-on (SSO)

Last updated 11 months ago

Was this helpful?

Modifying a suspension

View
View
View
View
View
View
Activate a user's subscription