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
  • Applying a midterm change with price override using the Preview Cart resource
  • Applying a midterm change with price override using the Preview resource

Was this helpful?

  1. Admin APIs
  2. Subscription management
  3. Immediately apply a midterm subscription change

Applying a midterm change with price override

Learn how to apply a midterm change with a price override for a subscription with add-ons.

PreviousImmediately apply a midterm subscription changeNextReducing the subscription renewal quantity

Last updated 4 months ago

Was this helpful?

The ability to adapt and tailor subscription services to meet the evolving needs of your customers is essential for sustaining satisfaction and loyalty. One of the most valued flexibilities in subscription management is the ability to modify a subscription mid-term, whether adding an extra service or upgrading to a premium plan. However, this adjustment requires meticulous handling to ensure billing is accurate and fair, particularly when implementing a price override for the remainder of the billing cycle.

As you manage subscriptions, you may encounter situations where customers want to change their subscription plan in the middle of their billing cycle, which could involve adding an add-on to their existing subscription or upgrading to a higher-tier plan. We have two tools for these midterm changes: Preview Cart and the Preview resources. These tools allow for prorated prices, ensuring that customers are charged fairly for any alterations to their subscriptions based on the exact duration of the new service. This guide will guide you through applying a midterm change with a price override, ensuring a seamless transition for your customers while maintaining billing accuracy.

Applying a midterm change with price override using the Preview Cart resource

We must ensure a precise and fair billing adjustment when subscribers want to modify their subscriptions by adding extras or moving to a more comprehensive plan before their current billing cycle ends. In this scenario, the Preview Cart resource is a crucial tool, allowing for the seamless application of prorated charges for such midterm modifications. By using this functionality, businesses can provide a flexible subscription model that will enable customers to customize their service experience while guaranteeing utmost transparency in billing..

This section explains how to apply a midterm change with a price override using the Preview Cart resource, using a practical example to guide you through enhancing subscriber satisfaction while safeguarding billing accuracy.

The Preview Cart resource is a powerful API resource designed for subscription-based services that enable businesses to make changes to a customer's subscription plan, such as upgrades or add-ons. Its real-time visualization of prorated charges sets it apart, ensuring that customers are billed fairly and accurately for any mid-cycle modifications they make to their subscriptions.

This feature offers a transparent and flexible way for users to customize their service experience according to their evolving needs. By using the Preview Cart resource, companies can provide a seamless process for applying price overrides and visualizing potential billing adjustments before committing to changes, enhancing customer satisfaction and maintaining billing accuracy.

In this scenario, the customer has a basic subscription and decides to upgrade the subscription product with an add-on. Use the t resource to upgrade the customer's subscription product. Ensure you replace with {YOUR_API_KEY} with your authorization token. This request should include the subscription product identifier (subscriptionId). Include the quantity (quantity), and the add-ons (addOns) you want to include with their respective prorated unit prices (proratedUnitPrice) in the request body. In the following example, the value for the proratedUnitPrice is 20.5.

curl --location --request POST 'https://api.digitalriver.com/v1/subscriptions/{subscriptionId}/preview-cart' \
--header 'authorization: Basic {YOUR_API_KEY}\
...
--data-raw '{
  "product" : {
    "id" : "5396391700"
  },
  "quantity" : 1,
  "addOns" : [ {
    "product" : {
      "id" : "5400082600"
    },
    "quantity" : 1,
    "proratedUnitPrice" : 0.0
  } ],
  "proratedUnitPrice" : 20.5
}'

You will receive a 200 OK response.

{
  "subscriptionId" : "15682787789",
  "subTotal" : 20.5,
  "credit" : 0.0,
  "totalTax" : 0.0,
  "totalAmountDue" : 20.5,
  "currency" : "USD",
  "prorationDate" : "2021-03-03",
  "previewCharges" : [ {
    "product" : "5396391700",
    "quantity" : 1,
    "unitPrice" : 20.5,
    "proratedUnitPrice" : 20.5
  } ],
  "previewSubscription" : {
    "addOns" : [ {
      "product" : {
        "id" : "5400082600"
      },
      "quantity" : 1,
      "proratedUnitPrice" : 0.0
    } ],
    "product" : {
      "id" : "5396391700"
    },
    "quantity" : 1,
    "proratedUnitPrice" : 20.5
  },
  "cart" : {
    "token" : "bearer dbea3e7a3605b764afe1113c3bd539aee2645ebef2c5581584663d957b514f24d205a4b72aa404acc03d85062b1b7c99954ef1e22c9a2de5a9214082273e2ee0e5480ea0e38cc85260e9c7d22d7e8851",
    "url" : "[https://drhadmin-sys-drx.drextenv.net/store?Action=DisplayHGOP2LandingPage&Locale=en_US&SiteID=sub2test&Token=eHBLKQgMBhgUBTIFSVpVSVxFXVhBW1RJUk1fVU9TVktVewA%3D&session=CB289EB23D78E50C7203166BFDD6CF1AAA48BA8DDDED419570AB88C662F4B8480D9146F3517FB71E6658420B74105DE424E90940F72DAC34E5F9EF1E089976E25ED5A6AEB92345D8420A79758692FFFE]"
  },
  "isCartNeeded" : true,
  "isPaymentOnFile" : true
}

Applying a midterm change with price override using the Preview resource

Applying a midterm change with a price override using the Preview resource is a simple and efficient process that allows you to adjust your customers' subscriptions. This feature facilitates changes such as adding new products or services and applying prorated pricing. The Preview resource enables you to simulate changes to the subscription without actually applying them, providing a preview of the updated subscription cost.

The Preview resource for applying a midterm change with a price override offers significant benefits for both the customer and your business. For the customer, it enhances satisfaction and flexibility by adjusting their subscription based on their evolving needs or requests. For your business, it ensures accurate billing for any additions or changes to the customer's subscription, reflecting the value of the service provided.

The Preview resource provides immediate financial insights into the proposed changes without committing to them. This feature is a powerful tool for better financial planning and decision-making. It also facilitates upselling by showing customers the prorated cost of adding services or products to their subscriptions, encouraging upselling, and allowing customers to see the added value instantly.

Finally, using the Preview resource to apply midterm changes with a price override minimizes billing confusion. It reduces disputes related to billing, as customers can see a clear preview of how their subscription changes will affect their charges before the changes are applied.

Use the Preview resource when the shopper wants to change their subscription, which requires an extra payment. The response will show the total amount due to help the shopper understand how much they need to pay for this change. Note that this response is informational only. It does not create a cart.

curl --location --request POST 'https://api.digitalriver.com/v1/subscriptions/{subscriptionId}/preview' \
--header 'authorization: Basic {YOUR_API_KEY}\
...
--data-raw '{    
  "product" : {
    "id" : "5363866300"
  },
  "product" : {
    "id" : "5396391700"
  },
  "product" : {
    "id" : "5396391700"
  },
  "quantity" : 1,
  "addOns" : [ {
    "product" : {
      "id" : "5400082600"
    },
    "quantity" : 1,
    "proratedUnitPrice" : 0.0
  } ],
  "proratedUnitPrice" : 20.5
}

You will receive a 200 OK response.

{
  "subscriptionId" : "15684493989",
  "subTotal" : 20.5,
  "credit" : 0.0,
  "totalTax" : 0.0,
  "totalAmountDue" : 20.5,
  "currency" : "USD",
  "prorationDate" : "2021-03-05",
  "previewCharges" : [ {
    "product" : "5396391700",
    "quantity" : 1,
    "unitPrice" : 20.5,
    "proratedUnitPrice" : 20.5
  } ],
  "previewSubscription" : {
    "addOns" : [ {
      "product" : {
        "id" : "5400082600"
      },
      "quantity" : 1,
      "proratedUnitPrice" : 0.0
    } ],
    "product" : {
      "id" : "5396391700"
    },
    "quantity" : 1,
    "proratedUnitPrice" : 20.5
  },
  "isCartNeeded" : true,
  "isPaymentOnFile" : true
}

If correctly formatted, this request will return a 200 OK response. The API response will include a breakdown of the changes, including prorated charges for the new or adjusted subscription items. Ensure these details align with the intended adjustments.

A successful request will return a 200 OK response containing the updated subscription details, including the prorated charges, the total amount due, and a cart token for completing the upgrade process. You can use the token in the 200 OK response to continue the programmatically.

In this scenario, the customer has a basic subscription and upgrades the subscription product with add-ons. Use the request. Ensure you replace with {YOUR_API_KEY} with your authorization token. This request should include the subscription product identifier (subscriptionId). Include the product identifiers (id), the quantity (quantity), and the add-ons (addOns) you want to include with their respective prorated unit prices (proratedUnitPrice) in the request body. In the following example, the value for the proratedUnitPrice is 20.5.

submit cart
POST /v1/subscriptions/{subscriptionId}/preview-car
POST /v1/subscriptions/{subscriptionId}/preview