Skip to content

Cancellation

Server-to-server Cancellation endpoints, authenticated with your private API key.

Operations

Request a membership cancellation

Request

Security
api_key
Path
idstringrequired

The customer ID number.

Query
overrideCancelPolicyboolean

Whether or not to override the default merchant cancellation policy. Defaults to true, meaning the customer will be immediately cancelled.

Default:true
sourcestring

The source of the cancellation, either "MERCHANT" or "FAILURE". Defaults to "MERCHANT".

Default:"MERCHANT"
Enum:"FAILURE""MERCHANT"
curl -i -X POST \
  'https://public.inveterateapi.com/v2.0/admin/members/{id}/cancellation?overrideCancelPolicy=true&source=FAILURE' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE'

Responses

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.

Bodyapplication/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.

Response
{
  "message": "Request sent successfully",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}