HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
APIs
These docs are for v2024.01. Click to read the latest docs for v2025.03.01.

Get available crossgrades for a contract, in a structured catalogue form.

Get a structured catalogue containing details of available subscriptions a customer's current contract can be crossgraded to.
Includes an estimated cost to change. i.e. the amount the customer would be immediately charged.
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
400 | 90029 | InvalidStateForCrossgradeFault | Contract cannot be crossgraded
404 | 90041 | NoContractFoundFault | Contract ID does not exist
500 | 90061 | SystemFailureFault | System Failure, Please try again later

Path Params
uuid
required

The customer ID to locate the contract.

int64
required

The contract ID to change.

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

Language
URL
Choose an example:
application/json