Subscription Updates with Nue Self-Service APICopied!

The Nue Self-Service API provides robust capabilities for updating existing subscriptions throughout their lifecycle. This functionality allows customers to modify their subscription settings and manage their recurring services effectively.

How to Update SubscriptionsCopied!

Required Information

To update subscriptions, you need:

• Subscription ID: The unique identifier for the subscription you want to modify

• Update Parameters: The specific fields and values you want to change

Update Parameters

The subscription update endpoint supports modifying specific subscription attributes:

• autoRenew: Boolean flag to control automatic renewal

• Custom Fields: Additional subscription-specific attributes (e.g., RubyCustom_Field_c)

Update Process

When you send an update request to the /subscriptions/{subscriptionId} endpoint, the system:

• Authenticates and authorizes the request

• Validates the subscription ID

• Applies the requested changes

• Returns the updated subscription details

Update Response

The response includes comprehensive information about the updated subscription:

• Basic Subscription Details: ID, name, status, created/modified dates

• Subscription Terms: Start/end dates, renewal settings

• Financial Information: List prices, sales prices, total amounts

• Tracking Details: Version information and modification timestamps

• System Information: Creation and modification user IDs

Subscription Update Lifecycle

The subscription update functionality supports several key modification scenarios:

• Renewal Management: Toggle auto-renewal settings

• Custom Attribute Updates: Modify business-specific fields

• Version Tracking: Monitor subscription changes

• Audit Trail: Track modification history

Use Cases for Subscription Updates

This functionality is essential for several self-service scenarios:

• Renewal Control: Enable customers to manage their renewal preferences

• Configuration Changes: Update subscription-specific settings

• Business Process Integration: Maintain custom field values

• Subscription Management: Control subscription behavior

Best Practices for Subscription Updates

• Validate changes before submission

• Implement proper error handling

• Maintain update history

• Provide clear confirmation messages

• Ensure consistent state management

Error Handling

The update process should account for various scenarios:

• Invalid Subscription IDs

• Unauthorized Modifications

• Validation Failures

• System Errors

• Concurrent Update Conflicts

By implementing effective subscription updates, you enable customers to maintain control over their subscription settings while ensuring proper tracking and management of these changes throughout the subscription lifecycle.