Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Update Contract in Billing System Action

Update contract status, end date, or status reason in an external billing system for service change or termination scenarios.

This action is available in API version 60.0 and later.

Special Access Rules

The Update Contract in Billing System action is available in Enterprise and Unlimited Editions with Energy and Utilities Cloud. The org must have an external billing system integration configured.

Supported REST HTTP Methods

URI: /services/data/v60.0/actions/standard/updateContractInBillingSystem
Formats: JSON, XML
HTTP Methods: PATCH
Authentication: Authorization: Bearer token

Inputs

Input	Details
updateContractParams	Type Object[] Description Required. List of contract update parameters. Maximum of 50 items. Each item contains these fields. externalContractId (string, required) External contract identifier. endDate (date, optional) New contract end date. status (string, optional) New contract status. statusReason (string, optional) Reason for the status change.

Outputs

Output	Details
message	Type string Description Success message returned by the external billing system.
success	Type string Description Success description returned by the external billing system.

Example

PATCH

This sample request is for the Update Contract in Billing System action.

1{
2  "inputs": [
3    {
4      "updateContractParams": [
5        {
6          "externalContractId": "CTR-100234",
7          "endDate": "2026-12-31",
8          "status": "Cancelled",
9          "statusReason": "Customer moved out"
10        }
11      ]
12    }
13  ]
14}

This sample response is for the Update Contract in Billing System action.

1[
2  {
3    "actionName": "updateContractInBillingSystem",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "success": "true",
9      "message": "Contract updated successfully"
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]

Energy and Utilities Cloud Developer Guide