Plan, usage and limits

Retrieve the organisation's plan, usage, and allowed features.

GET/v1/organizations/{organizationId}/billing

Request

curl --request GET \
  --url 'https://studio.grid82.app/v1/organizations/<organizationId>/billing' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://studio.grid82.app/v1/organizations/<organizationId>/billing"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/organizations/<organizationId>/billing", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/organizations/<organizationId>/billing");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://studio.grid82.app/v1/organizations/<organizationId>/billing", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/organizations/<organizationId>/billing"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/organizations/<organizationId>/billing")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "organizationId": "<string>",
    "plan": "free",
    "planStatus": "<string>",
    "renewsAt": null,
    "hasPaymentMethod": true,
    "usage": {
      "suites": 123,
      "apps": 123,
      "users": 123,
      "builders": 123,
      "storageBytes": 123,
      "customDomains": 123
    },
    "limits": {
      "builders": 123,
      "suites": 123,
      "apps": 123,
      "users": 123,
      "rowsPerApp": 123,
      "storageBytes": 123,
      "customDomains": 123,
      "assistantCredits": 123
    },
    "addons": {},
    "subscription": {
      "live": true,
      "interval": "monthly",
      "cancelAt": null,
      "pendingChange": {
        "plan": "free",
        "interval": "monthly",
        "effectiveAt": null
      }
    },
    "checkout": {
      "connected": true,
      "reason": null,
      "purchasable": [
        {
          "plan": "free",
          "interval": "monthly"
        }
      ]
    },
    "grants": {
      "availableCredits": 123.45,
      "pendingCredits": 123.45
    },
    "pricingIsPlaceholder": true
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

plan is the id: free is the plan named Solo. Limits are counted against the organisation that pays; suites are never billed for existing.

Requires the account:read scope. Operation billing.get. MCP tool billing_get. CLI: grid82 billing get (npx grid82).

Path parameters

Name	Type	Required	Description
`organizationId`	string	yes

Response

application/json

Success

dataobjectrequired

Show child attributes

data.organizationIdstringrequired

data.planenum<string>requiredone of: free, starter, pro, custom

data.planStatusstringrequired

data.renewsAtstringnullrequired

data.hasPaymentMethodbooleanrequired

data.usageobjectrequired

Show child attributes

data.usage.suitesintegerrequired

data.usage.appsintegerrequired

data.usage.usersintegerrequired

data.usage.buildersintegerrequired

data.usage.storageBytesinteger

data.usage.customDomainsinteger

data.limitsobjectrequired

Show child attributes

data.limits.buildersinteger | nullrequired

data.limits.suitesinteger | nullrequired

data.limits.appsinteger | nullrequired

data.limits.usersinteger | nullrequired

data.limits.rowsPerAppinteger | nullrequired

data.limits.storageBytesinteger | nullrequired

data.limits.customDomainsinteger | nullrequired

data.limits.assistantCreditsinteger | nullrequired

data.addonsRecord<string, integer>required

data.subscriptionobjectrequired

Show child attributes

data.subscription.livebooleanrequired

data.subscription.intervalenum<string> | nullrequired

data.subscription.cancelAtstringnullrequired

data.subscription.pendingChangeobject | nullrequired

Show child attributes

data.subscription.pendingChange.planenum<string>requiredone of: free, starter, pro, custom

data.subscription.pendingChange.intervalenum<string> | nullrequired

data.subscription.pendingChange.effectiveAtstringnullrequired

data.checkoutobjectrequired

Show child attributes

data.checkout.connectedbooleanrequired

data.checkout.reasonstringnullrequired

data.checkout.purchasableobject[]required

Show child attributes

data.checkout.purchasable.planenum<string>requiredone of: free, starter, pro, custom

data.checkout.purchasable.intervalenum<string>requiredone of: monthly, yearly

data.grantsobjectrequired

Show child attributes

data.grants.availableCreditsnumberrequired

data.grants.pendingCreditsnumberrequired

data.pricingIsPlaceholderbooleanrequired

{ "data": { "organizationId": "<string>", "plan": "free", "planStatus": "<string>", "renewsAt": null, "hasPaymentMethod": true, "usage": { "suites": 123, "apps": 123, "users": 123, "builders": 123, "storageBytes": 123, "customDomains": 123 }, "limits": { "builders": 123, "suites": 123, "apps": 123, "users": 123, "rowsPerApp": 123, "storageBytes": 123, "customDomains": 123, "assistantCredits": 123 }, "addons": {}, "subscription": { "live": true, "interval": "monthly", "cancelAt": null, "pendingChange": { "plan": "free", "interval": "monthly", "effectiveAt": null } }, "checkout": { "connected": true, "reason": null, "purchasable": [ { "plan": "free", "interval": "monthly" } ] }, "grants": { "availableCredits": 123.45, "pendingCredits": 123.45 }, "pricingIsPlaceholder": true } }

Plan, usage and limits

Path parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown