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
  • Assigning a perpetual unit price to a subscription
  • Creating a cart for a subscription with a perpetual unit price
  • Creating or changing a perpetual unit price

Was this helpful?

  1. Shopper APIs
  2. Subscriptions
  3. Update subscription at the next renewal

Adding or updating a perpetual unit price

Learn how to assign a perpetual unit price to a subscription with add-ons.

PreviousChanging the subscription renewal quantityNextChanging the subscription's payment option

Last updated 4 months ago

Was this helpful?

Assigning a perpetual unit price to a customer's subscription is crucial to subscription management. This allows for a fixed pricing model that remains constant throughout the subscription's lifecycle, simplifying billing for businesses and customers alike. Through the Commerce API, you can easily set a perpetual unit price for the primary product and any additional add-ons, ensuring clarity and stability in subscription pricing. The following documentation will guide you through implementing this pricing model using an API call.

Assigning a perpetual unit price to a subscription

Businesses aim to offer value and convenience to their customers sustainably. Assigning a perpetual unit price to a subscription is a strategic approach that fosters long-term customer relationships by providing consistent pricing. This method benefits the business and its customers by ensuring price stability and transparency throughout the subscription period. In this section, we will show you how to set a perpetual unit price for a customer's subscription using the Commerce API, covering the necessary steps to implement this pricing model effectively for both primary products and add-on services.

Use the resource to assign a perpetual unit price to a customer's subscription. You need to include the subscription identifier (subscriptionId) and the perpetual unit price (perpetUnitPrice). In the following example, the value of the product's perpetualUnitPrice is 120 and the value for the add-on's perpetualUnitPrice is 50. See the for more information.

curl --location --request POST 'https://api.digitalriver.com/v1/subscriptions/{subscriptionId}/perpetual-price' \
--header 'authorization: Basic ***\
...
--data-raw '{
    "perpetualUnitPrice": 120,
    "addOns": [
        {
            "product": {
                "externalReferenceId": "A123"
            },
            "perpetualUnitPrice": 20
        },
        {
            "product": {
                "id": "B456"
            },
            "perpetualUnitPrice": 50
        }
    ]
}'

You will receive a 202 Accepted response. The new plan will go into effect on the next renewal.

Creating a cart for a subscription with a perpetual unit price

Providing flexible pricing options such as perpetual unit pricing can significantly enhance the customer experience and loyalty. This guide walks you through creating a shopping cart that includes a subscription and assigns a perpetual unit price. By leveraging the Digital River API, you can effortlessly configure perpetual pricing for products in a shopper's cart, ensuring transparency and consistency in the pricing strategy. Whether handling standalone products or adding subscriptions with specific perpetual prices, this documentation outlines the steps to seamlessly integrate these options into the active shopping cart. This approach is particularly beneficial for businesses aiming to offer more value and flexibility to their customers, encouraging long-term engagement.

curl --location --request POST 'https://api.digitalriver.com/v1/shoppers/me/carts/active' \
--header 'authorization: Basic ***\
...
--data-raw '{
    "cart": {
        "lineItems": {
            "lineItem": [
                {
                    "quantity": "1",
                    "product": {
                        "id": "5363866300"
                    },
                    "customAttributes": {
                        "attribute": [
                            {
                                "name": "groupIdForAddon",
                                "value": "9814462289"
                            }
                        ]
                    },
                    "subscriptionOverrideInfo": {
                        "perpetualUnitPrice": {
                            "currencyCode": "USD",
                            "amount": 49.99
                        }
                    }
                },
                {
                    "quantity": "1",
                    "product": {
                        "id": "5400082600"
                    },
                    "customAttributes": {
                        "attribute": [
                            {
                                "name": "groupIdForAddon",
                                "value": "9814462289"
                            },
                            {
                                "name": "parentProductIdForAddon",
                                "value": "5363866300"
                            }
                        ]
                    },
                    "subscriptionOverrideInfo": {
                        "perpetualUnitPrice": {
                            "currencyCode": "USD",
                            "amount": 39.99
                        }
                    }
                }
            ]
        }
    }
}'
curl --location --request POST 'https://api.digitalriver.com>/v1/shoppers/me/carts/line-items' \
--header 'Content-Type:  application/json' \
--header 'authorization: bearer ***\
--data-raw '{
    "cart": {
        "lineItems": {
            "lineItem": [
                {
                    "quantity": "1",
                    "product": {
                        "id": "5363866300"
                    },
                    "customAttributes": {
                        "attribute": [
                            {
                                "name": "groupIdForAddon",
                                "value": "9814462289"
                            }
                        ]
                    },
                    "subscriptionOverrideInfo": {
                        "perpetualUnitPrice": {
                            "currencyCode": "USD",
                            "amount": 49.99
                        }
                    }
                },
                {
                    "quantity": "1",
                    "product": {
                        "id": "5400082600"
                    },
                    "customAttributes": {
                        "attribute": [
                            {
                                "name": "groupIdForAddon",
                                "value": "9814462289"
                            },
                            {
                                "name": "parentProductIdForAddon",
                                "value": "5363866300"
                            }
                        ]
                    },
                    "subscriptionOverrideInfo": {
                        "perpetualUnitPrice": {
                            "currencyCode": "USD",
                            "amount": 39.99
                        }
                    }
                }
            ]
        }
    }
}'

You will receive a 200 OK response. The response to this request creates a shopping cart and returns an access token to be included in all other cart interactions.

{
  "cart" : {
    "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active",
    "paymentMethods" : {
      "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/payment-methods"
    },
    "webCheckout" : {
      "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/web-checkout"
    },
    "id" : 861184190082,
    "lineItems" : {
      "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/line-items",
      "lineItem" : [ {
        "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/line-items/10288020082",
        "id" : 10288020082,
        "quantity" : 1,
        "product" : {
          "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/products/5363866300",
          "displayName" : "Monthly auto renewal Subscription",
          "thumbnailImage" : null
        },
        "pricing" : {
          "listPrice" : {
            "currency" : "USD",
            "value" : 11.11
          },
          "listPriceWithQuantity" : {
            "currency" : "USD",
            "value" : 11.11
          },
          "salePriceWithQuantity" : {
            "currency" : "USD",
            "value" : 11.11
          },
          "formattedListPrice" : "$11.11",
          "formattedListPriceWithQuantity" : "$11.11",
          "formattedSalePriceWithQuantity" : "$11.11",
          "productTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "shippingTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "feeTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "taxRate" : 0,
          "importTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "formattedImportTax" : "$0.00",
          "importDuty" : {
            "currency" : "USD",
            "value" : 0
          },
          "formattedImportDuty" : "$0.00"
        }
      }, {
        "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/line-items/10288030082",
        "id" : 10288030082,
        "quantity" : 1,
        "product" : {
          "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/products/5400082600",
          "displayName" : "Subscription AddOn 1",
          "thumbnailImage" : null
        },
        "pricing" : {
          "listPrice" : {
            "currency" : "USD",
            "value" : 11
          },
          "listPriceWithQuantity" : {
            "currency" : "USD",
            "value" : 11
          },
          "salePriceWithQuantity" : {
            "currency" : "USD",
            "value" : 11
          },
          "formattedListPrice" : "$11.00",
          "formattedListPriceWithQuantity" : "$11.00",
          "formattedSalePriceWithQuantity" : "$11.00",
          "productTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "shippingTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "feeTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "taxRate" : 0,
          "importTax" : {
            "currency" : "USD",
            "value" : 0
          },
          "formattedImportTax" : "$0.00",
          "importDuty" : {
            "currency" : "USD",
            "value" : 0
          },
          "formattedImportDuty" : "$0.00"
        }
      } ]
    },
    "totalItemsInCart" : 2,
    "businessEntityCode" : "DR_INC-ENTITY",
    "billingAddress" : {
      "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/billing-address"
    },
    "shippingAddress" : {
      "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/shipping-address"
    },
    "payment" : { },
    "paymentSession" : {
      "id" : "2912a240-a65b-4ef5-bd2c-427b342b4dba",
      "clientSecret" : "2912a240-a65b-4ef5-bd2c-427b342b4dba_978f2dd6-eaef-4933-a460-5f6b917d2b35",
      "status" : "requires_source"
    },
    "shippingMethod" : { },
    "shippingOptions" : {
      "uri" : "https://api.digitalriver.com/shop/sites/sub2test/shoppers/me/carts/active/shipping-options"
    },
    "taxInclusive" : "false",
    "landedCostState" : "NOT_ELIGIBLE",
    "pricing" : {
      "subtotal" : {
        "currency" : "USD",
        "value" : 22.11
      },
      "discount" : {
        "currency" : "USD",
        "value" : 0
      },
      "shippingAndHandling" : {
        "currency" : "USD",
        "value" : 0
      },
      "importTaxAndDuty" : {
        "currency" : "USD",
        "value" : 0
      },
      "tax" : {
        "currency" : "USD",
        "value" : 0
      },
      "orderTotal" : {
        "currency" : "USD",
        "value" : 22.11
      },
      "formattedSubtotal" : "$22.11",
      "formattedDiscount" : "$0.00",
      "formattedShippingAndHandling" : "$0.00",
      "formattedImportTaxAndDuty" : "$0.00",
      "formattedTax" : "$0.00",
      "formattedOrderTotal" : "$22.11"
    },
    "termsOfSalesAcceptance" : null
  }
}

Creating or changing a perpetual unit price

Offering flexibility in pricing models is key to customer satisfaction and retention. The ability to set or adjust a perpetual unit price for subscriptions provides a competitive edge by enabling businesses to extend special pricing conditions that remain effective for the duration of a subscription. Whether you're looking to convert a non-perpetual subscription to a perpetual one or adjust an existing perpetual price, the following steps will walk you through the necessary API calls and considerations to ensure a seamless implementation.

curl -X POST \
  https://{host}/v1/subscriptions/{subscription_Id}/perpetual-price \
  -H 'authorization: Basic ****' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'postman-token: 5cb141b9-8077-8b12-3eff-ebb45db3ffa6' \
  -d '{
        "perpetualUnitPrice" : 59.99
      }'

You will receive a 202 Accepted response. The new plan will go into effect on the next renewal.

See for more information.

Use the or the resource to create a cart request. You need to include the perpetual unit price (perpetualUnitPrice) in the subscription override info (subscriptionOverrideInfo).

Apply the shopper and submit the cart using the resource.

Use the resource to apply a forever price for the remaining subscription cycle. You can use it to change a non-perpetual subscription to a perpetual subscription if the supplied subscription is not a perpetual subscription. You need to provide the subscriptionId and the renewalUnitPrice. Note that the renewalUnitPrice cannot be higher than the existing price.

POST /v1/shoppers/me/carts/active
POST /v1/shoppers/me/carts/active/line-items
Shoppers
POST /v1/subscriptions/{subscriptionId}/perpetual-price
query parameters
POST /v1/subscriptions/{subscriptionId}/perpetual-price
Selling subscriptions with add-ons