APIBilling
Get billing summary
Get a billing summary for the current organization, including plan, balance, and cycle information.
Query Parameters
organizationId?string
Organization to query billing for. Auto-filled from CLI and SDK context when omitted. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).
Length
1 <= lengthResponse Body
application/json
curl -X GET "https://example.com/billing/summary"{ "billingModel": "credit-balance-v1", "billable": true, "nonBillableReason": "string", "status": "string", "planName": "string", "planSlug": "string", "currency": "string", "currentBalance": "string", "targetCreditBalance": "string", "currentCycle": { "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "billableStartsAt": "2019-08-24T14:15:22Z" }, "currentPeriodEstimate": { "subscriptionChargeAmount": "string", "creditDeficitAmount": "string", "creditDeficitChargeAmount": "string", "totalAmount": "string", "currency": "string" }, "pendingDowngrade": { "billingSubscriptionChangeId": "string", "effectiveAt": "2019-08-24T14:15:22Z", "planSlug": "string", "planName": "string", "price": "string", "currency": "string", "targetCreditBalance": "string" }, "subscription": { "id": "string", "status": "string", "billingPlanId": "string", "cycleType": "string", "cancelAt": "2019-08-24T14:15:22Z", "canceledAt": "2019-08-24T14:15:22Z" }, "currentPlan": { "slug": "string", "name": "string", "price": "string", "currency": "string", "targetCreditBalance": "string", "subscriptionStatus": "string", "cycleStartsAt": "2019-08-24T14:15:22Z", "cycleEndsAt": "2019-08-24T14:15:22Z", "renewalAt": "2019-08-24T14:15:22Z", "pendingSwitch": { "billingSubscriptionChangeId": "string", "effectiveAt": "2019-08-24T14:15:22Z", "planSlug": "string", "planName": "string", "price": "string", "currency": "string", "targetCreditBalance": "string" }, "pendingCancellation": { "effectiveAt": "2019-08-24T14:15:22Z" } }}