Activate a pending charge through the REST API
This topic explains how to activate a pending charge using the REST API by performing an Update Product order action.
To activate a pending charge, use the Create an order operation to perform an Update Product order action 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.
specificTriggerDateThe actual specific start date for the pending charge. Specify a date value in the
specificTriggerDatefield. The value must be a date within the subscription term. - Use the "Create an order" operation to activate a pending charge:
Request
POST /v1/orders/Request Body
{ "orderNumber": null, "orderDate": "2024-03-01", "status":"Completed", "existingAccountNumber": "A00000001", "subscriptions": [ { "subscriptionNumber": "A-S00000011", "orderActions": [ { "type": "UpdateProduct", "triggerDates": [ { "name": "ContractEffective", "triggerDate": "2024-11-21" }, { "name": "ServiceActivation", "triggerDate": "2024-11-21" },{ "name": "CustomerAcceptance", "triggerDate": "2024-11-21" } ], "updateProduct":{ "ratePlanId":"f5cf073041c9445e4b444616989d0009", "chargeUpdates":[{ "chargeNumber":"C-00000023", "effectiveDate":{ "specificTriggerDate":"2024-10-27" } }] } } ] } ] }