Update Contract

put

https://api.helloextend.com/contracts/{contractId}

This endpoint updates a contract using the Contract ID. Information that can be updated for a contract includes coverage, customer, plan, and product details associated with the contract.

Given the new contract type of shipping protection, there are two different bodies that can be used to perform the contract update. When a shipping protection contract needs to be updated, the body will include tracking/shipment information and a list of products covered under the shipping protection plan instead of the one product that would be applicable with extended warranty contracts. Additional details on the various fields that can be updated are outlined in the options below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contractId

uuid

required

Unique identifier for Extend contract.

Body Params

comment

string

currency

string

enum

Currency code used when contract was purchased. NOTE - This is an ISO-4217 currency code.

customer

object

isTest

boolean

Flag that tracks whether the transaction was created as a test or not. NOTE - This is defaulted to false and should be used only under special circumstances.

listPrice

number

Expected retail price of the Extend plan associated to the contract purchased.

purchaseDate

number

Purchase date of the contract. NOTE - This field is formatted as a 13 digit Epoch timestamp.

purchasePrice

number

Purchase price of the product purchased.

plan

object

product

object

sellerId

string

Unique identifier for the merchant’s Extend store (i.e. the merchant’s Extend Store ID).

status

string

enum

Contract status.

Allowed:

transactionId

string

Unique identifier provided by the merchant of the transaction when the contract is purchased.

Headers

Content-Type

string

required

Used to indicate the original media type of the resource (prior to any content encoding applied for sending).

X-Extend-Access-Token

string

required

An Extend private API key used to authenticate requests.

string

required

Indicates which content types, expressed as MIME types, the client is able to understand, as well as identifies which API version to use in the request.

Responses

200Successful contract update. Note - This is an example response for an extended warranty contract.

400The request to the endpoint was invalid

404The specified resource was not found

422Unprocessable entity