Get billing status and usage
get_billing_statusFetch the organization's plan, subscription status, post usage, and limits — and, for a subscription paid by Pix (subscription.paymentMethod: pix), the amount and deadlines of the invoice waiting to be paid. The Pix code itself is not returned: paying happens in the PostRite app, under Settings → Billing. Requires the organization owner role.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_billing_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| organizationId | No | Organization to act in — an id from list_organizations. Required when this connection was authorized for more than one organization; omit it when there is only one. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| usage | No | Counters for the current period | |
| limits | No | The plan's limits | |
| isTrial | No | ||
| pixPayment | No | The Pix that pays the open invoice of a subscription paid by Pix (`subscription.paymentMethod` is `pix`); null for card subscriptions and when nothing is owed. `dueAt` is when the organization is restricted if it stays unpaid; `payableUntil` is the invoice's due date, until which it can still be paid (paying lifts the restriction) and after which the subscription is canceled; `isExpired` means no code is payable any more and a new Pix must be generated. The Pix code and QR code are not returned here: the owner pays in the PostRite app, under Settings → Billing | |
| currentPrice | No | ||
| isAdminTrial | No | ||
| isIncomplete | No | ||
| isRestricted | No | ||
| subscription | No | ||
| isTrialExpired | No | ||
| isInGracePeriod | No | ||
| trialDaysRemaining | No |