Recover Billing Schedules Action

Recover one or more billing schedules in the Error or Processing status.

This action uses the ID of the billing schedule record in the Error or Processing status to retrieve the latest generated invoice. This action also retrieves any other billing schedules in the Error or Processing status associated with that invoice.

This action is available in API version 62.0 and later.

Special Access Rules

The Recover Billing Schedules action is available in Enterprise, Unlimited, and Developer Editions where Billing is enabled. To use this action, you need the Manage Errors Using Invoice Error Recovery API permission set.

Supported REST HTTP Methods

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

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`billingScheduleId`	string	Required. ID of the billing schedule record in the `Error` or `Processing` status.

Outputs

Output	Type	Description
`successBillingScheduleIds`	string	Comma-separated list of IDs associated with the parent billing schedule record in the `Error` or `Processing` status.

Example

POST

This example shows a sample request for the Recover Billing Schedules action.

1{
2  "inputs": [
3    {
4      "billingScheduleId": "801xx000003JztvAAC"
5    }
6  ]
7}

This example shows a sample response for the Recover Billing Schedules action.

1{
2  "actionName": "recoverBillingSchedules",
3  "errors": null,
4  "isSuccess": true,
5  "outputValues": {
6    "successBillingScheduleIds": ["4sFDU00000000652AA", 16Pxx0000004NhAEAU]
7  },
8  "sortOrder": -1,
9  "version": 1
10}