Suspend Billing Action

Suspend or resume the billing of an account to handle billing disputes.

Specify the account ID and a date when billing must be suspended. Optionally, specify the date when billing must be resumed. The action suspends billing for the account from the suspension date and, if provided, resumes billing on the resumption date.

This action is available in API version 66.0 and later.

Special Access Rules

The Suspend Billing Action is available in Enterprise, Developer, and Unlimited Editions where Dispute Management is enabled in Billing.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/blngSvcSuspendBilling

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`accountId`	string	ID of the account for which billing must be suspended.
`resumptionDate`	date	Date when the billing must be resumed.
`suspensionDate`	date	Date when the billing must be suspended.

Outputs

Output	Type	Description
`additionalInformation`	string	Any additional information to be included in the response.
`isSuccess`	boolean	Indicates whether the billing related to the specified account was suspended (`true`) or not (`false`). The default value is `false`.

Example

POST

This sample request is for the Suspend Billing action.

1{
2  "inputs": [
3    {
4      "accountId": "001xx000003GYexAAG",
5      "suspensionDate": "2025-03-01",
6      "resumptionDate": "2025-03-15"
7    }
8  ]
9}

This sample response is for the Suspend Billing action.

1[
2  {
3    "actionName": "blngSvcSuspendBilling",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "isSuccess": true,
10      "additionalInformation": "{\"status\":\"Billing suspended successfully\"}"
11    },
12    "sortOrder": -1,
13    "version": 1
14  }
15]