Remove the current tier from a customer
This endpoint removes the current tier association from the customer and moves them back to the base tier of the program (if one exists).
Some important remarks
- If the customer does not exist, the API returns an error with the
Customer_NotFounderror code. - If the customer does not have any tier assigned, the response
MessageResultwill be"The consumer does not have a tier to remove.". - If the customer is already on the base tier, the tier cannot be removed. The response
MessageResultwill be"The consumer is on the base tier and does not have a tier to remove". - On success, the customer is automatically assigned to the base tier and the response
MessageResultwill be"Tier removed successfully.".
Response
The response contains:
MessageResult: a description of the outcome (success, no tier to remove, or base tier cannot be removed)OldTierName: the name of the tier the customer was in before the removal (only present on success)
Authorizations
Use API Basic Auth Keys
Path Parameters
Id from the client's store, usually email address or document
Response
The result of the removal including MessageResult and OldTierName, or an error response
Standard response envelope used by the External API.
Error message returned when the request fails validation or processing.
For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.
Legacy numeric error code derived from internal API errors when available.
This field is relevant only for error flows that use ApiResponseErrorDescription.
Business payload returned by the endpoint.
Endpoint-specific business code formatted as a two-digit string, such as 03 or 07.
This field is available for success, warning and error outcomes.
Symbolic enum name associated with Code, such as CheckoutNotFound.
Final severity of the response.
Success means the action completed as expected, Warning means the request was valid but the business outcome is informational or non-ideal, and Error means the request should be treated as a failure.
0, 1, 2 Convenience flag that is true when Severity is Warning.
Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.
Indicates whether the request failed and should be handled as an error response.
This flag is reserved for real API errors; warnings must keep this property as false.