List billing

GET/workspaces/{organizationId}/billing

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Query parameters

periodstring

Responses

200

Billing usage for the workspace

organizationIdstringrequired

periodstringrequired

planstringrequired

Allowed:freepaid

statusstringrequired

Allowed:activepast_duecanceled

capintegerrequired

usedintegerrequired

remainingintegerrequired

upgradeRequiredbooleanrequired

upgradeUrlstring

usageobject[]required

Show properties

Array of object

resourcestringrequired

actionstringrequired

countintegerrequired

totalintegerrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*periodquery

Request

curl -X GET 'https://pile.nyc/workspaces/string/billing' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/workspaces/string/billing", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/workspaces/string/billing",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "organizationId": "string",
  "period": "string",
  "plan": "free",
  "status": "active",
  "cap": 0,
  "used": 0,
  "remaining": 0,
  "upgradeRequired": true,
  "upgradeUrl": "string",
  "usage": [
    {
      "resource": "string",
      "action": "string",
      "count": 0
    }
  ],
  "total": 0
}