Perform Account’s Bill Cycle Change

The PerformAccountBillCycleChange API in OCS.io allows for performing 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 executed. After the change is executed, the account’s billing cycle will transition to the new billing cycle as planned and cannot be canceled.

API Overview

Fields Required for Performing Account’s Billing Cycle Change

The following table lists and describes the fields required to cancel an account’s billing cycle change through the PerformAccountBillCycleChange 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 executing 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.

Perform Account’s Bill Cycle Change Example

Use the following request’s body to perform 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 performed immediately and cannot be canceled.