HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
APIs
Start typing to search…
These docs are for v2024.02. Click to read the latest docs for v2025.03.01.

Pause contract.

post https://virtserver.swaggerhub.com/singuladecisions/contracts/1.0.19/customer//contract//pause

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 Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
tbc | tbc | New API created for 1.5 | tbc

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

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.

Responses

Updated 11 days ago

Did this page help you?
Language
URL
Choose an example:
application/json

Updated 11 days ago

Did this page help you?