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
  • Email address update phases
  • Changing the billing and shipping email addresses in the cart before placing the order  
  • Commerce API 
  • Digital River-hosted storefront page 
  • Email addresses created after submitting an order
  • Requisition billing and shipping email addresses
  • Subscription billing and shipping email addresses
  • Owner’s email address
  • Updating the subscriber’s email address for a specific subscription
  • Missing email address parameter
  • Email address is more than 255 characters
  • Updating the subscriber's email address for all subscriptions

Was this helpful?

  1. Admin APIs
  2. Subscription management
  3. Subscription notifications

Updating the subscriber's email address

Learn how to update the subscriber's email address.

PreviousSubscription notificationsNextCard Account Updater

Last updated 4 months ago

Was this helpful?

Ensuring seamless communication with your subscribers is crucial for maintaining strong customer relationships. Whether they've changed their primary email address or prefer to receive notifications at a different email, updating a subscriber's email address is vital to ensuring they stay informed and engaged. This guide provides a step-by-step process for updating a subscriber's email address in Digital River, allowing you to send to their preferred email easily. We will cover how to update various types of email addresses, including the sign-in email, billing email, and shipping email associated with a shopper's account, to ensure that your communications reach your subscribers accurately and efficiently.

Digital River supports the following email types:

email address type
Description

You can combine the notifications for a specific shopper by creating an event rule per each notification. You update email notifications using .

Email address update phases

Understanding the critical moments for email address updates in the customer journey is essential for maintaining accurate and effective communication. This section outlines the three key phases in which you can update a subscriber's email address on Digital River: before placing the order, at the cart stage, and after creating a subscription. Each phase offers unique opportunities to ensure your communications reach the intended inbox, catering to the dynamic nature of subscriber preferences and needs. Whether correcting an error or updating preferences, these phases provide the flexibility to manage email addresses efficiently.

Phase

Update an email address for a subscription.

  • The subscriber can change their billing email address after creating the subscription. 

Changing the billing and shipping email addresses in the cart before placing the order  

Ensuring that your billing and shipping email addresses are up-to-date when preparing to finalize an order is critical. This guide outlines the steps to change these email addresses directly from your cart before placing an order on Digital River’s platform. Whether correcting a mistake or updating information, following these procedures helps guarantee that order confirmations and related communications are sent to the correct email address.

Commerce API 

The Commerce API provided by Digital River is a powerful tool designed to streamline the online shopping experience for both shoppers and merchants. It offers a variety of endpoints that allow for the management of carts, including the ability to update billing and shipping email addresses before an order is placed. This flexibility ensures that order communication is accurate and reaches the correct recipient. In this section, we will explore using the Commerce API to change billing and shipping email addresses directly from the cart, ensuring that your order process is as smooth and error-free as possible.

You can use one of the following calls to change the billing or shipping email address from the cart.

Digital River-hosted storefront page 

Changing the billing and shipping email addresses on the Digital River-hosted storefront page depends on how your cart is customized. Contact your account representative for more information.

Email addresses created after submitting an order

Requisition billing and shipping email addresses

In the journey from cart to checkout, understanding the role and mechanism of email addresses becomes pivotal. Specifically, requisition billing and shipping email addresses are essential components. These addresses are not merely contact points but pivotal elements that ensure a smooth and secure transaction process. This section delves into the nuances of these email addresses, shedding light on how they are created, their purposes, and how they differ from the initial email addresses provided during the shopping experience. These addresses play a critical role in the overall commerce ecosystem, whether through the API or a Digital River-hosted storefront.

When a shopper submits an order, the system creates two email addresses for the order: 

  • Requisition billing email address

  • Requisition shipping email address

The requisition billing and shipping email addresses are snapshots belonging to the order. The requisition billing email address is the shopper’s billing address associated with their chosen payment method. When the shopper places the order, the action disconnects the requisition billing email address from the payment method.  

Orders placed by Commerce API

The requisition billing email address for; if a physical product order comes from the billing address associated with the payment method/payment option used to place the order. (The billing address includes the email address.) The shopper provides the requisition shipping email address; if the shopper does not specify the shipping email address, the system copies the requisition billing email address to the requisition shipping email address. 

The requisition shipping email address for a non-physical product order comes from the requisition billing address. (The billing address includes the email address.)  The system copies the requisition billing email address to the shipping email address.  

Orders placed by Digital River-hosted solution with legacy payments

When an authenticated shopper signs into your storefront and your Digital River-hosted storefront billing address page provides an Email field, the system copies the owner's email address to the requisition billing email address.  

An anonymous shopper flow should provide an Email field on the storefront page for shoppers to provide their email addresses. 

Orders placed by Digital River-hosted solution with CloudPay (Checkout.js) 

A Digital River-hosted solution leverages Checkout.js to support the payment source, and Checkout.js leverages the Commerce API/apply-payment-method API to attach the source to the cart for both authenticated and anonymous shoppers. So, the system uses the requisition billing email address as the source’s billing email address in the cart.

Subscription billing and shipping email addresses

If the shopper submits a subscription order, the system creates two more email addresses for the subscription:  

  • Subscription billing email address

  • Subscription shipping email address

Owner’s email address

If the shopper is authenticated and has an account they can use to sign in, the system also associates an owner’s email address with the shopper. The owner’s email address applies only to the authenticated shopper and is not associated with the shopper’s order or subscription.

When the authenticated user signs in to their account, they can manage their email addresses from their account and add several often-used payment methods to their account. Each payment method is associated with a billing address in the shopper’s address book. The billing address includes a billing email address.

Updating the subscriber’s email address for a specific subscription

curl --location --request POST 'https://api.digitalriver.com/v1/subscriptions/{subscriptionId}/email' \
--header‘ 'authorization: Basic ***\
...
--data-raw '{“ "emailAddress”" “ "jdoe@acme.com"
}'

You will receive a 202 Accepted response.

Missing email address parameter

{
  "errors": {
    "error": [
      {
        "code": "validation-error",
        "subcode": "required-data-missing",
        "description": "Missing required field: emailAddress"
      }
    ]
  }
}

Email address is more than 255 characters

curl --location --request POST 'https://api.digitalriver.com/v1/shoppers/me?applyEmailToSubscriptions=true' \
--header 'authorization: Basic ***\
...
--data-raw '{
 "emailAddress" : "jdoe@acme.com"
}'
{
  "errors": {
    "error": [
      {
         "code": "invalid-request",
         "subcode": "invalid-length",
         "description": "emailAddress cannot exceed a length of 255 characters"
      }
    ]
  }
}

Updating the subscriber's email address for all subscriptions

curl --location --request POST 'https://api.digitalriver.com/v1/shoppers/me?applyEmailToSubscriptions=true' \
--header 'authorization: Basic ***\
...
--data-raw '{
 "emailAddress" : "jdoe@acme.com"
}'

You will receive a 204 No Content response.

The email address the shopper uses to sign in to their account. You can .

The billing email address the shopper provided when placing an order. You can .

The shipping email address the shopper provided when placing an order. You can .

When creating a subscription, subscription-relevant information from the original acquisition, including the billing email address, is copied to the subscription. You can or .

When creating a subscription, subscription-relevant information from the original acquisition, including the shipping email address, is copied to the subscription. You can or .

Apply or edit the email address BEFORE placing the order. You can do this when you or and discover the email address is not the one you expected.

in the cart before submitting the order.

Update the email address AFTER you and you create the subscription.

in .

If the shopper accidentally enters the incorrect email address while placing an order, you can or .

 to .  

 to override the billing email address in the cart.  

PU to override the billing email address in the cart.  

The subscription billing address is associated with the shopper’s subscription and recurring payment method. You can update the or .

A long-term subscriber sometimes needs to change their subscription email address for a particular authenticated subscription. Use the request to update a subscription customer’s ship-to and bill-to email address so they can receive notifications. You need to include the email address (emailAddress) in the payload. The email address should use a and not exceed 255 characters. In the following example, the value of the emailAddress is jdoe@acme.com.

If the email address parameter is missing, you will see a error message with a validation-error code.

An email address cannot exceed 255 characters. If the email address is more than 255 characters, you will see a error message with an invalid-request code.

A long-term subscriber sometimes needs to change their subscription email address for all subscriptions. Use the request to update a subscription customer's ship-to and bill-to email addresses for all subscriptions so they can receive notifications. You need to include the email address (emailAddress). The email address should use a and not exceed 255 characters. In the following example, the value of the emailAddress is jdoe@acme.com.

subscription email address for a shopper’s specific subscription
all of the shopper’s subscriptions
Submit cart
submit the order
BEFORE
Create a subscription product
Global Commerce
Shopper's email address
change the shopper's email address in the cart before placing the order
Requisition billing email address
change the shopper's billing address in the cart before placing the order
Requisition shipping email address
change the shopper's shipping address in the cart before placing the order
Subscription billing email address
update a shopper's billing email address for a specific subscription
all of the shopper's subscriptions
Subscription shipping email address
update a shopper's shipping email address for a specific subscription
all of the shopper's subscriptions
Change the billing and shipping email address
update the subscriber’s email address for a specific subscription
all of the subscriber's subscriptions
future notifications
Global Commerce
valid email format
valid email format
update the billing or shipping email address in the cart
attach a payment method to a cart
customer
Create cart
400 Bad Request
400 Bad Request
POST /v1/shoppers/me/carts/active
PUT /v1/ shoppers/me/carts/active/billing-address
T /v1/shoppers/me/carts/active/shipping-address
POST /v1/subscriptions/{subscriptionId}/email
POST /v1/shoppers/me?applyEmailToSubscriptions=true