Skip to content

Change Tier

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

Operations

Change a member's tier

Request

This endpoint allows merchants to upgrade or downgrade a customer by specifying a new tierId.

Security
api_key
Path
idstringrequired

The customer ID number.

Bodyapplication/jsonrequired
tierIdstringrequired

The ID of the tier to which the customer will be moved.

nextBillingDatestringrequired

The next billing date can be specified if the customer is changed to a paid tier. Format: YYYY-MM-DD

curl -i -X POST \
  'https://public.inveterateapi.com/v2.0/admin/members/{id}/change-tier' \
  -H 'Content-Type: application/json' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "tierId": "string",
    "nextBillingDate": "string"
  }'

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"
  }
}