Docs
Billing

Get plan and usage summary

Get the organization plan and usage summary

GET
/v2/workspaces/{workspaceId}/billing/summary

Path Parameters

workspaceIdnumber

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/billing/summary"
{
  "data": {
    "plan": {
      "id": 2,
      "name": "growth",
      "parentId": 6
    },
    "status": "TRIALING",
    "trial": {
      "startedAt": "2026-05-01T00:00:00.000Z",
      "endsAt": "2026-05-15T00:00:00.000Z",
      "daysLeft": 7
    },
    "emailAccounts": {
      "used": 5,
      "limit": 10
    },
    "warmupDaily": {
      "limit": 500,
      "used": 137,
      "remaining": 363,
      "unlimited": false,
      "resetsAt": "2026-08-01T00:00:00.000Z",
      "workspace": {
        "workspaceId": 100,
        "workspaceName": "Default",
        "limit": 200,
        "used": 12
      }
    },
    "banner": {
      "kind": "PAYMENT_FAILED",
      "graceEndsAt": "2026-07-20T00:00:00.000Z",
      "trialExtensionAvailable": true,
      "message": "Your last payment failed."
    },
    "scheduledChange": {
      "action": "cancel",
      "effectiveAt": "2027-07-24T00:00:00.000Z"
    },
    "scheduledResumeAt": "2026-12-12T00:00:00.000Z",
    "usage": [
      {
        "code": "EMAIL_ACCOUNTS",
        "used": 17,
        "limit": 20,
        "pct": 85,
        "tier": "WARNING"
      }
    ],
    "usageBanner": {
      "kind": "USAGE_CRITICAL",
      "code": "EMAIL_ACCOUNTS",
      "used": 19,
      "limit": 20,
      "pct": 95,
      "message": "You've used 95% of your connected mailboxes."
    }
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}