Get organization billing summary

GET/v1/billing/organization/summary

Get the active organization's authoritative budget snapshot, mirrored ledger summary, reservation diagnostics, and recent ledger activity.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
None.
Query parameters
NameLocationTypeRequiredDescription
activityLimitqueryintegerNo

Body schema

This endpoint does not require a request body.

None.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Organization billing summaryapplication/json
FieldTypeRequiredDescription
successbooleanNoWhether the request succeeded.
modelegacy_budget_authoritativeNo
organizationIdstringNo
userIdstringNoUser ID.
actorUserIdstringNo
budgetobjectNo
budget.tierstringNo
budget.subscriptionStatusstringNo
budget.subscriptionSourcestringNo
budget.periodStartDatestringNo
budget.periodEndDatestringNo
budget.balancenumberNo
budget.balanceUsdnumberNo
budget.legacyBalancenumberNo
budget.legacyBalanceUsdnumberNo
budget.topUpBalancenumberNo
budget.topUpBalanceUsdnumberNo
budget.topUpTotalPurchasednumberNo
budget.topUpTotalPurchasedUsdnumberNo
budget.currentPeriodUsagenumberNo
budget.currentPeriodUsageUsdnumberNo
budget.usagePercentagenumberNo
budget.tierQuotanumberNo
budget.tierQuotaUsdnumberNo
budget.includedTierQuotanumberNo
budget.includedTierQuotaUsdnumberNo
budget.remainingIncludedQuotanumberNo
budget.remainingIncludedQuotaUsdnumberNo
budget.availableBudgetnumberNo
budget.availableBudgetUsdnumberNo
budget.usageBillingEnabledbooleanNo
budget.monthlyResourceSpendLimitnumberNoMonthly persistent-resource spend cap in USD.
budget.monthlyResourceSpendLimitUsdnumberNoMonthly persistent-resource spend cap in USD.
budget.pauseOnLimitbooleanNo
budget.resourceEmailAlertsbooleanNo
budget.monthlyResourceSpendnumberNo
budget.monthlyResourceSpendUsdnumberNo
budget.monthlyMeteredResourceUsagenumberNo
budget.monthlyMeteredResourceUsageUsdnumberNo
budget.createdAtstringNoISO 8601 timestamp.
budget.updatedAtstringNoISO 8601 timestamp.
ledgerobjectNo
ledger.walletobjectNo
ledger.reservationStatsobjectNo
ledger.pendingReservationHoldUsdnumberNo
ledger.activityobjectNo
ledger.activity.organizationIdstringNo
ledger.activity.creditGrantsobject[]No
ledger.activity.usageEventsobject[]No
ledger.activity.ledgerEntriesobject[]No
ledger.activity.reservationsobject[]No
ledger.activity.limitintegerNo
ledger.reconciliationobjectNo
ledger.reconciliation.legacyAvailableUsdnumberNo
ledger.reconciliation.ledgerBalanceUsdnumberNo
ledger.reconciliation.differenceUsdnumberNo
ledger.reconciliation.mismatchbooleanNo
updatedAtstringNoISO 8601 timestamp.
Get organization billing summary
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow