appInstallationBilling

Requires permission settings:apps:install.

An installed app's billing: its plans, and the subscription that keeps a paid app running.

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 AppInstallationBilling($installationId: ID!) {
  appInstallationBilling(installationId: $installationId) {
    status
    currentPeriodEnd
    installationId
    paid
    pausedByBilling
    plan
    plans {
      name
      handle
      interval
      priceUsdCents
      purchasable
      trialDays
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AppInstallationBilling($installationId: ID!) {\n  appInstallationBilling(installationId: $installationId) {\n    status\n    currentPeriodEnd\n    installationId\n    paid\n    pausedByBilling\n    plan\n    plans {\n      name\n      handle\n      interval\n      priceUsdCents\n      purchasable\n      trialDays\n    }\n  }\n}",
  "variables": {
    "installationId": "id"
  }
}
EOF

Variables:

{
  "installationId": "id"
}

Response:

{
  "data": {
    "appInstallationBilling": {
      "status": "string",
      "currentPeriodEnd": "2025-01-15T00:00:00Z",
      "installationId": "id",
      "paid": true,
      "pausedByBilling": true,
      "plan": "string",
      "plans": [
        {
          "name": "string",
          "handle": "string",
          "interval": "string",
          "priceUsdCents": 0,
          "purchasable": true,
          "trialDays": 0
        }
      ]
    }
  }
}

appInstallationBilling(
  installationId: ID!
): AppInstallationBillingView!

Arguments

appInstallationBilling.installationId ● ID! non-null scalar

The installation.

Type

AppInstallationBillingView object

An installed app's billing: whether it is paid, its plans, and its subscription.