Update the price of a pending charge for a ramped subscription through the REST API
This topic explains how to update the price of a pending charge for a ramped subscription using the REST API by performing an Update Product order action for each ramp interval.
To update the price of a pending charge for a ramped subscription, use the Create an order operation to perform an Update Product order action for each ramp interval as follows:
- Determine the values of the following fields:
Variable
Description
statusThe status of the order. To create an active subscription with pending charges, you must specify the
statusfield toCompleted.ContractEffectiveThe date of the contract that governs the subscription. To create an active subscription with pending charges, you must specify this field.
ServiceActivationThe date on which the services or products within a subscription have been activated and access has been provided to the customer. To create an active subscription with pending charges, you must specify this field.
CustomerAcceptanceThe date on which the services or products within a subscription have been accepted by the customer. To create an active subscription with pending charges, you must specify this field.
estimatedStartDateThe estimated start date for the pending charge. Set the
estimatedStartDatefield as you want and note that this date must be a date within the subscription term. The system will then automatically calculate and determine the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. - Use the "Create an order" operation to update the prices of the pending charges for an active ramped subscription:
Request
POST /v1/orders/Request Body
{ "orderNumber": null, "orderDate": "2024-01-01", "status":"Completed", "existingAccountNumber": "A00000001", "subscriptions": [ { "subscriptionNumber": "A-S00000012", "orderActions": [ { "type": "UpdateProduct", "triggerDates": [ { "name": "ContractEffective", "triggerDate": "2024-07-01" }, { "name": "ServiceActivation", "triggerDate": "2024-07-01" },{ "name": "CustomerAcceptance", "triggerDate": "2024-07-01" } ], "updateProduct":{ "ratePlanId":"f5cf07304089445e4b4446255bec0007", "chargeUpdates":[{ "chargeNumber":"C-00000025", "estimatedStartDate":"2024-07-01", "pricing":{ "recurringFlatFee":{ "listPrice":200 } } }] } },{ "type": "UpdateProduct", "triggerDates": [ { "name": "ContractEffective", "triggerDate": "2024-10-01" }, { "name": "ServiceActivation", "triggerDate": "2024-10-01" },{ "name": "CustomerAcceptance", "triggerDate": "2024-10-01" } ], "updateProduct":{ "ratePlanId":"f5cf07304089445e4b4446255bec0007", "chargeUpdates":[{ "chargeNumber":"C-00000025", "estimatedStartDate":"2024-10-01", "pricing":{ "recurringFlatFee":{ "listPrice":300 } } }] } } ] } ] }