Cancellation

Create a cancellation request for a member.

post

This method forwards the cancellation creation request to our backend. Returns the success status of the request against backend service. Like the other endpoints that make requests against our backend, the changes may not take effect immediately.

Path parameters

idstringRequired

The customer ID number.

Responses

201

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

application/json

messagestringRequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectRequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

400

Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.

application/json

500

Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.

application/json

post

/v2.0/storefront/members/{id}/cancellation

HTTPcURLJavaScriptPython

POST /v2.0/storefront/members/{id}/cancellation HTTP/1.1
Accept: */*

{
  "message": "text",
  "data": {}
}