GraphQL Explorer

GraphQL endpoint

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

Schema

OBJECT Query

OBJECT Mutation

OBJECT Subscription

OBJECT Customer

OBJECT Plan

OBJECT Entitlement

OBJECT EntitlementDecision

OBJECT UsageCounter

OBJECT CreditBalance

OBJECT SubscriptionPlan

OBJECT UsageEventResult

INPUT_OBJECT CreateCustomerInput

INPUT_OBJECT UsageEventInput

OBJECT Webhook

OBJECT Meter

OBJECT Feature

OBJECT LegacyPlan

INTERFACE Node

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

Shared query seed

Shared: Plan Health

query SharedPlanHealth($key: String!) {
  plan(key: $key) {
    id
    key
    name
  }
}

Shared: Usage Check

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