GuideReference

Retrieve Subscription Data for Client Side Pricing Engine

Local Pricing Engine Data RetrievalCopied!

The Nue Self-Service API provides robust capabilities for retrieving local pricing engine data to enable real-time client-side pricing calculations for subscription changes. This functionality allows customers to preview pricing updates instantly before submitting changes. See here for more details.

How to Retrieve Local Pricing DataCopied!

Required Information

To retrieve local pricing data, you need:

  • Customer IDs: The unique identifier(s) for the customers whose subscription pricing data you want to retrieve

Query Parameters

The pricing engine data retrieval endpoint supports:

  • customerIds: JSON-encoded array of customer IDs to fetch pricing data for

Retrieval Process

When you request pricing data using the /subscriptions/pricing-engine-input endpoint, the system:

  • Authenticates and authorizes the request

  • Retrieves subscription and pricing data for the specified customers

  • Returns structured data needed for client-side calculations

Response Structure

The response includes comprehensive information organized by subscription:

  • Changes History: Previous modifications and their pricing impacts

  • Order Product Details: Current subscription configuration

  • Product Information: Associated product details and pricing rules

  • Unit of Measure: Quantity and term measurement specifications

Data Components

The pricing engine data supports several key components:

  • Change Calculations: Data for computing price changes

  • Product Configuration: Current subscription setup

  • Pricing Rules: Terms and conditions affecting costs

  • Measurement Units: How quantities and terms are measured

Use Cases for Local Pricing

This functionality is essential for several self-service scenarios:

  • Real-time Price Updates: Calculate changes instantly

  • Change Preview: Show cost impacts before submission

  • Quantity Modifications: Compute scaling costs

  • Term Changes: Calculate term-based pricing

  • Bundle Updates: Handle complex product combinations

Best Practices

  • Cache pricing data appropriately

  • Validate calculations client-side

  • Handle rounding properly

  • Show clear pricing breakdowns

  • Maintain data freshness

By implementing effective local pricing capabilities, you enable customers to make informed decisions about subscription changes with immediate visibility into cost impacts.