Change a contract.

post

https://virtserver.swaggerhub.com/singuladecisions/contracts/1.0.19/customer/{customerId}/contract/{contractId}/change

Change a customers contract to the supplied contract code.

Response Code	Fault Code	Fault	Suggested User Message
400	90029	InvalidStateForCrossgradeFault	Contract cannot be crossgraded
404	90041	NoContractFoundFault	Contract ID does not exist
400	90018	InvalidCrossgradePathFault	Contract cannot be crossgraded to this item
400	90077	VCNCurrencyMismatchFault	Viewing Card is not set for provided currency
400	90063	UnableToCrossgradeFault	Crossgrade cannot be completed
400	90079	VCNRequiredFault	A Viewing Card is required for this purchase
400	90045	PaymentAuthorisationFault	Payment attempt failed
500	90050	PaymentSystemFault	Payment collection cannot be attempted at this time
400	90031	InvalidVCNFault	Viewing Card provided is Invalid
500	90061	SystemFailureFault	System Failure, Please try again later
400	90078	VCNInUseFault	This viewing card is already in use on another record
404	90022	InvalidDiscountCodeFault	Discount does not exist

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

uuid

required

The customer ID to locate the contract.

contractId

int64

required

The contract ID to change.

Body Params

itemCode

string

required

The sales item code for the item to be changed to.

referrerId

string

length ≤ 50

Identifer for any referrer to be associated with the new service. No validation is done on this.

discountCode

object

Details of a discount code.
Can be applied during a crossgrade which may trigger a discount.
Shown as part of the details of a contract if it has an active discount.

downgradeImmediately

boolean

Flag indicating whether a downgrade request should be performed immediately, or left until the next contract charge.

Headers

tenantId

string

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

userId

string

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

source

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

Loading…

Response

Choose an example:

application/json

200Success

400Bad request

404No contract found