customerTierStatus

Requires at least one of the permissions customers:customer:read or settings:customer_tiers:read.

Returns one customer's tier and whether that tier is locked against automatic changes. Fails if the customer does not exist. Requires permission to read customer tier settings or customers.

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

query CustomerTierStatus($customerId: String!) {
  customerTierStatus(customerId: $customerId) {
    customerId
    customerTier
    locked
  }
}

cURL

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

Variables:

{
  "customerId": "string"
}

Response:

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

customerTierStatus(
  customerId: String!
): CustomerTierStatus!

Arguments

customerTierStatus.customerId ● String! non-null scalar

The ID of the customer.

Type

CustomerTierStatus object

A customer's tier status after a manual override.