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
  • Action type
  • activate
  • cancel
  • email
  • expiration_date
  • payment_option
  • payment_source
  • perpetual_price
  • reduce
  • reference_id
  • renewal_price
  • renewal_product
  • renewal_quantity
  • renewal_type
  • ship_to_address

Was this helpful?

  1. Events
  2. Event types
  3. Subscription event types

Subscription action processed event

Understand the subscription action processed event.

PreviousSubscription updated eventNextSubscription cancelled event

Last updated 2 months ago

Was this helpful?

The subscription.action.processed occurs when a subscription changes, such as activation, email, expiration date, payment option, payment source, perpetual price, immediate quantity change, external reference ID, renewal price, renewal product, renewal quantity, renewal type, and ship-to-address. Requests sent through the High Availability Subscription API trigger this event; changes made through other channels will not activate this event. Additionally, the Webhook Service sends notifications regardless of whether the change succeeds or fails. It provides essential feedback on the success or failure of the requested action, serving as a foundational tool for overseeing subscription action statuses and preserving system integrity. This event also underscores the importance of transparency and real-time updates in maintaining the alignment of subscription services with the needs and expectations of subscribers.

Central to this event is the field, which identifies the specific modification applied to the subscription.

For seamless integration and monitoring of this event, it is advised to ensure correct configuration with the High Availability API and consult with the Digital River Customer Success Manager (CSM) as needed.

This structured event data facilitates a deeper understanding and more efficient management of subscription lifecycle events.

{
   "type":"subscription.action.processed",
   "data":{
      "object":{
         "action":{
            "actionType":"ship_to_address",
            "actionStatus":"success"
         },
         "subscription":{
            "id":"13530199",
            "creationDate":"2022-06-01T09:14:48.000Z",
            "activationDate":"2022-06-01T05:00:00.000Z",
            "nextRenewalDate":"2022-07-01T05:00:00.000Z",
            "expirationDate":"2022-07-01T05:00:00.000Z",
            "graceDate":"2022-07-08T05:00:00.000Z",
            "currentQuantity":1,
            "renewalQuantity":1,
            "autoRenewal":true,
            "locale":"en_US",
            "state":"Subscribed",
            "duration":30,
            "frequency":30,
            "siteId":"sub2test",
            "shopper":{
               "id":"26195489030199"
            },
            "renewalPrice":{
               "unitPrice":10.99,
               "locked":false,
               "currency":"USD"
            },
            "term":{
               "termUnit":"MONTHS",
               "termLength":1
            },
            "product":{
               "id":"5363866300",
               "displayName":"Monthly auto renewal Subscription",
               "sku":"SUB_AUTORENEW"
            },
            "shipToAddress":{
               "id":"406032130199",
               "firstName":"Vikram42",
               "lastName":"Kumar",
               "line1":"Abc",
               "city":"Pune",
               "postalCode":"324345",
               "countrySubdivision":"CA",
               "country":"AR",
               "countryName":"Argentina",
               "phoneNumber":"02134567890",
               "emailAddress":"vkumar42@dr.com"
            },
            "paymentOption":{
               "nickName":"Default",
               "id":"4022980199",
               "isDefault":"true",
               "type":"CreditCardMethod",
               "creditCard":{
                  "expirationMonth":"4",
                  "expirationYear":"2024",
                  "displayableNumber":"************1111",
                  "type":"visa",
                  "displayName":"Visa"
               },
               "address":{
                  "id":"406032100199",
                  "firstName":"Vikram42",
                  "lastName":"Kumar",
                  "line1":"Abc",
                  "city":"Pune",
                  "postalCode":"324345",
                  "countrySubdivision":"CA",
                  "country":"AR",
                  "countryName":"Argentina",
                  "phoneNumber":"02134567890",
                  "emailAddress":"vkumar42@dr.com"
               }
            },
            "addOns":[
                
            ]
         }
      }
   },
   "clientIds":{
      "site_id":"sub2test"
   },
   "searchableData":{
      "subscriptionId":"13530199"
   }
}
{
   "id":"12430c66-8f77-472e-81a3-f5c852ec69c6",
   "platformId":"Headless",
   "type":"subscription.action.processed",
   "accountId":"sub2test",
   "clientIds":{
      "site_id":"sub2test"
   },
   "data":{
      "object":{
         "action":{
            "actionType":"ship_to_address",
            "actionStatus":"success"
         },
         "subscription":{
            "id":"13530199",
            "creationDate":"2022-06-01T09:14:48.000Z",
            "activationDate":"2022-06-01T05:00:00.000Z",
            "nextRenewalDate":"2022-07-01T05:00:00.000Z",
            "expirationDate":"2022-07-01T05:00:00.000Z",
            "graceDate":"2022-07-08T05:00:00.000Z",
            "currentQuantity":1,
            "renewalQuantity":1,
            "autoRenewal":true,
            "locale":"en_US",
            "state":"Subscribed",
            "duration":30,
            "frequency":30,
            "siteId":"sub2test",
            "shopper":{
               "id":"26195489030199"
            },
            "renewalPrice":{
               "unitPrice":10.99,
               "locked":false,
               "currency":"USD"
            },
            "term":{
               "termUnit":"MONTHS",
               "termLength":1
            },
            "product":{
               "id":"5363866300",
               "displayName":"Monthly auto renewal Subscription",
               "sku":"SUB_AUTORENEW"
            },
            "shipToAddress":{
               "id":"406032130199",
               "firstName":"Vikram42",
               "lastName":"Kumar",
               "line1":"Abc",
               "city":"Pune",
               "postalCode":"324345",
               "countrySubdivision":"CA",
               "country":"AR",
               "countryName":"Argentina",
               "phoneNumber":"02134567890",
               "emailAddress":"vkumar42@dr.com"
            },
            "paymentOption":{
               "nickName":"Default",
               "id":"4022980199",
               "isDefault":"true",
               "type":"CreditCardMethod",
               "creditCard":{
                  "expirationMonth":"4",
                  "expirationYear":"2024",
                  "displayableNumber":"************1111",
                  "type":"visa",
                  "displayName":"Visa"
               },
               "address":{
                  "id":"406032100199",
                  "firstName":"Vikram42",
                  "lastName":"Kumar",
                  "line1":"Abc",
                  "city":"Pune",
                  "postalCode":"324345",
                  "countrySubdivision":"CA",
                  "country":"AR",
                  "countryName":"Argentina",
                  "phoneNumber":"02134567890",
                  "emailAddress":"vkumar42@dr.com"
               }
            },
            "addOns":[
                
            ]
         }
      }
   },
   "searchableData":{
      "subscriptionId":"13530199"
   },
   "createdTime":"2022-06-01T09:23:24.045582Z",
   "indexName":"webhook-events-dev-20220528",
   "callbackTrackerIndexName":"webhook-event-callbacks-dev-20220528",
   "transformPayload":false
}

Action type

activate

cancel

Canceling a subscription triggers a change in the subscription's state from Subscribed to Cancelled. This action does not immediately close the account but sets the subscription to end after the current billing period. The actionType for this event would be cancel, indicating the specific action taken on the subscription.

email

  • Billing email address: Identified by subscription.billingOption.billAddress.emailAddress, this address is used for sending billing-related communications.

  • Shipping email address: Defined by subscription.shipToAddress.emailAddress, this address is used for any communications related to physical deliveries associated with the subscription.

expiration_date

payment_option

payment_source

perpetual_price

reduce

reference_id

renewal_price

When you change the shopper's subscription price, the system updates the shopper's subscription renewal price.

renewal_product

renewal_quantity

renewal_type

ship_to_address

For more information, see topic.

An actionType refers to a specific action carried out on a subscription within a high-availability subscription system. It is a key component of the process, identifying the nature of the modification or adjustment made to a subscriber's account. Each actionType is associated with a distinct change in the subscription's status, parameters, or configuration. Examples of actionType include , , and , each triggering different processes and updates to the subscription details and state. This system ensures that all changes are accurately monitored and allows for efficient subscription management and integrity.

When you , the subscription state changes from pendingActivation to Subscribed. It also updates the subscription expiration date and all subscription-related data columns.

You will be notified when you . The specific fields for updating these addresses in the system are:

When you for a subscription, the system associates a new expiration date with the subscription.

When you , the system associates a new billing or payment option with the subscription. When updated successfully, Retry On Account Update will trigger a billing attempt if the subscription falls under the renewal window.

When you , the system associates the new payment source with the subscription. If there is a billing option associated with the payment source, the system will create a new billing option for the payment source. The request payload contains the sourceId and isShippingSameAsBilling flag.

When you , the system changes the subscription price . The system updates the perpetual price or the hold price.

When you , either by lowering the quantity of the subscription items or removing product add-ons, the system promptly adjusts the subscriber's current subscription details. However, this action does not result in a refund for the adjustments made for the remaining period of the current subscription cycle.

You will be notified when you .

When you , the system updates the shopper's subscription renewal product.

When you , the system updates the shopper's subscription renewal quantity.

When you , the system updates the shopper's subscription renewal quantity.

When you , the system either adds or updates it.

activate a shopper's subscription
update a shopper's subscription billing or shipping email address
update a shopper's expiration date
update a shopper's subscription payment option
update a shopper's subscription payment source
modify the subscription's external reference ID
change the shopper's subscription renewal product
change the shopper's subscription renewal quantity
change the shopper's subscription renewal type
actionType
ship_to_address
activate
cancel
for the remaining subscription cycle
modify a shopper's subscription's perpetual price
change the shopper's ship-to address
Using subscription.action.processed and subscription.updated
reduce a subscriber's subscription