Help improve docs quality by sharing anonymous interaction telemetry (no PII or token data).

GraphQL Queries

Query operation schemas and runnable GraphQL examples.

GraphQL endpoint

https://app.monetizekit.app/api/graphql

Query operations

OBJECT Query

FieldTypeArgumentsComplexityDescriptionDeprecated
planPlankey: String! (required)4Get one plan with entitlementsNo
customers[Customer]first: Int, after: String6List customersNo
entitlementCheckEntitlementDecisioncustomerId: ID! (required), featureKey: String! (required)3Check one entitlement decisionNo
usageCounterUsageCountercustomerId: ID! (required), meterKey: String! (required)3Fetch usage counterNo
creditBalanceCreditBalancecustomerId: ID! (required)3Fetch customer creditsNo

Curated examples

Plan with entitlements

query PlanWithEntitlements($key: String!) {
  plan(key: $key) {
    id
    key
    entitlements {
      featureKey
      value
    }
  }
}

Variables

{
  "key": "starter_monthly"
}

Customers with subscriptions

query CustomersWithSubscriptions($first: Int) {
  customers(first: $first) {
    id
    externalId
    subscriptions {
      id
      planKey
    }
  }
}

Variables

{
  "first": 20
}

Single entitlement check

query SingleEntitlement($customerId: ID!, $featureKey: String!) {
  entitlementCheck(customerId: $customerId, featureKey: $featureKey) {
    allowed
    reason
  }
}

Variables

{
  "customerId": "cust_dev_1001",
  "featureKey": "analytics_export"
}

Usage data

query UsageData($customerId: ID!, $meterKey: String!) {
  usageCounter(customerId: $customerId, meterKey: $meterKey) {
    meterKey
    current
    limit
  }
}

Variables

{
  "customerId": "cust_dev_1001",
  "meterKey": "api_requests"
}

Credit balances

query CreditBalances($customerId: ID!) {
  creditBalance(customerId: $customerId) {
    available
    pending
  }
}

Variables

{
  "customerId": "cust_dev_1001"
}

Loading GraphQL schema...

Sign in to execute GraphQL queries

You can browse schema and examples without logging in. Sign in and provide your own API token to execute live queries.

Endpoint: https://app.monetizekit.app/api/graphql

Query complexity

2/100

Pagination guidance: use first/after or last/before on connection fields to control response size.

Sign in to view live GraphQL responses

Response output is shown after authenticated query execution.

Was this page helpful?