Cancel Account’s Bill Cycle Change

The CancelAccountBillCycleChange API in OCS.io allows for canceling a planned change to an account’s billing cycle. This API is particularly useful when a change to an account’s billing cycle needs to be canceled before it is executed.

API Overview

Fields Required for Cancelling Account’s Billing Cycle Change

The following table lists and describes the fields required to cancel an account’s billing cycle change through the CancelAccountBillCycleChange API:

Field Description

account

ID (Ref ID / External ID) of the Account.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when cancelling an account’s bill cycle change:

  • Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.

  • The account must have a bill cycle change in progress.

Cancel Account’s Bill Cycle Change Example

Use the following request’s body to cancel an account’s bill cycle change:

{
  "requestId": "{{$guid}}",
  "account": {
    "externalId": "account_external_id"
  }
}

The outcome of the API call is as follows:

  • The planned change to the account’s billing cycle is canceled.