Pause contract.

Pause a customers contract. The contract pause will commence at the next billing date and will last for a number of complete billing periods.

Response CodeFault CodeFaultSuggested User Message
tbctbcNew API created for 1.5tbc
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The customer ID to locate the contract.

int64
required

The contract ID to pause.

Body Params
int32
required

The number of complete billing periods to pause the contract for.

Headers
string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

string
enum

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json