Cancel contract.

post

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

Cancel a customers contract.

Response Code	Fault Code	Fault	Suggested User Message
400	90016	InvalidCancellationDateFault	Cancellation date provided is invalid
404	90041	NoContractFoundFault	Contract ID does not exist
400	90017	InvalidContractStateFault	Contract cannot be changed at this time
500	90061	SystemFailureFault	System Failure, Please try again later
400	90025	InvalidPaymentMethodFault	Payment method provided is incorrect
400	90006	ContractCancellationFault	Failed to cancel contract

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 cancel.

Body Params

cancelDate

date

full-date

Date to schedule for cancellation of contract, format must be [YYYY-MM-DD]. If no date is specified, the contract will be cancelled at the end of the minimum term or, if any minimum term has passed, on the next billing date.

cancelReason

string

The reason code for the contract cancellation

paymentMethodId

number

The ID of the payment method to be used to clear any outstanding balance at the time of cancellation.

writeOffDebt

boolean

Indicates whether any outstanding balance at time of cancelltion is to be written off. If true and cancelling within the minimum term, outstanding minimum term charges will also not be added. Defaults to false.

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