setCustomerTierOverride

Requires at least one of the permissions settings:customer_tiers:update or settings:tenant:update.

Pins a customer to a tier, which locks it against automatic changes. With no tier given it clears the lock and hands the customer back to automatic tiering. A tier that is not in the ladder is refused. Requires permission to update customer tier or tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SetCustomerTierOverride($input: SetCustomerTierOverrideInput!) {
  setCustomerTierOverride(input: $input) {
    customerId
    customerTier
    locked
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetCustomerTierOverride($input: SetCustomerTierOverrideInput!) {\n  setCustomerTierOverride(input: $input) {\n    customerId\n    customerTier\n    locked\n  }\n}",
  "variables": {
    "input": {
      "customerId": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "customerId": "string"
  }
}

Response:

{
  "data": {
    "setCustomerTierOverride": {
      "customerId": "string",
      "customerTier": "string",
      "locked": true
    }
  }
}

setCustomerTierOverride(
  input: SetCustomerTierOverrideInput!
): CustomerTierStatus!

Arguments

setCustomerTierOverride.input ● SetCustomerTierOverrideInput! non-null input

The customer and the tier to pin. Omit the tier to clear the lock.

Type

CustomerTierStatus object

A customer's tier status after a manual override.