---
title: "Get summaries"
method: GET
path: "/api/v1/billing/summaries/{id}"
tags: ["billing"]
---

# Get summaries

`GET /api/v1/billing/summaries/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/billing/summaries/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Read the organization's billing summary: subscription and its recurring lines, standing and notices, card on file, invoice history, and credit grants. The id is the organization id; invoices page by cursor.

## Path parameters

- `id` string, required

## Query parameters

- `invoiceCursor` string
- `creditGrantPage` integer

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- BillingSummariesGetResponse
  - `subscription` object, nullable, required
    - `id` string, required
    - `status` 'onboarding' | 'active' | 'trial' | 'past_due' | 'canceled' | 'paused', required
    - `cancelAtPeriodEnd` boolean, required
    - `currentPeriodStart` string, date-time, nullable, required
    - `currentPeriodEnd` string, date-time, nullable, required
    - `renewsOn` string, date-time, nullable, required
    - `endsOn` string, date-time, nullable, required
    - `cancellable` boolean, required
    - `baseAmountCents` integer, nullable, required
    - `hasUsageLine` boolean, required
  - `marketplace` object, nullable, required
    - `provider` 'aws_marketplace' | 'microsoft_marketplace' | 'google_cloud_marketplace', required
    - `buyerAccountId` string, required
    - `purchaseId` string, nullable, required
    - `status` 'active' | 'waiting' | 'ending' | 'suspended', required
    - `termEnd` string, date-time, nullable, required
    - `autoRenew` boolean, required
    - `manageUrl` string, uri, required
  - `cardRemovalRefusal` 'card_required_while_subscribed' | 'card_required_while_usage_settles', nullable, required
  - `pendingCommand` object, nullable, required
    - `billingProfileId` string, required
    - `operationId` string, required
    - `generation` integer, required
    - `command` 'subscribe' | 'cancel_at_period_end' | 'undo_cancel' | 'add_alpha' | 'remove_alpha', nullable, required
    - `status` 'pending' | 'running' | 'reconcile_required' | 'payment_action_required' | 'blocked', required
    - `customerActionCapability` 'product.run' | 'billing.manage', nullable, required
  - `refusal` 'no_subscription' | 'subscription_paused' | 'subscription_canceled' | 'billing_past_due' | 'billing_suspended' | 'billing_closed', nullable, required
  - `paymentDisputeHold` boolean, required
  - `invoiced` boolean, required
  - `notice` union, required
    - object
      - `kind` 'ending', required
      - `on` string, date-time, nullable, required
    - object
      - `kind` 'grace', required
      - `until` string, date-time, nullable, required
      - `invoiced` boolean, required
    - object
      - `kind` 'payment_action_required', required
  - `collectionMethod` 'charge_automatically' | 'send_invoice', required
  - `invoiceTerms` object, required
    - `request` object, nullable, required
      - `status` 'requested' | 'approved' | 'declined' | 'withdrawn', required
      - `requestedAt` string, date-time, required
      - `decidedAt` string, date-time, nullable, required
      - `declineReason` string, nullable, required
      - `application` 'applying' | 'applied' | 'not_applied', nullable, required
    - `daysUntilDue` integer, nullable, required
    - `creditLimitCents` integer, nullable, required
    - `openBalanceCents` integer, nullable, required
    - `pending` boolean, required
  - `card` object, nullable, required
    - `brand` string, nullable, required
    - `last4` string, nullable, required
    - `expMonth` integer, nullable, required
    - `expYear` integer, nullable, required
    - `walletType` string, nullable, required
  - `tax` object, nullable, required
    - `locationStatus` 'supported' | 'not_collecting' | 'unrecognized_location' | 'failed', nullable, required
    - `locationRequired` boolean, required
    - `exempt` 'none' | 'exempt' | 'reverse', required
  - `hasBillingProfile` boolean, required
  - `invoices` object[], required
    - `id` string, required
    - `description` string, required
    - `status` 'open' | 'paid' | 'void' | 'uncollectible', required
    - `amountPaidCents` integer, required
    - `amountDueCents` integer, required
    - `creditAppliedCents` integer, required
    - `periodEnd` string, date-time, nullable, required
    - `hostedInvoiceUrl` string, nullable, required: Stripe's hosted page: pay an open invoice, or read a settled one. Anyone holding the link can open it, so only a dashboard session receives it; null for API key, OAuth, and MCP callers.
    - `createdAt` string, date-time, required
    - `number` string, nullable, required
    - `collectionMethod` 'charge_automatically' | 'send_invoice', nullable, required
    - `dueAt` string, date-time, nullable, required
    - `amountRemainingCents` integer, nullable, required
    - `taxCents` integer, nullable, required
  - `invoiceBeingFinalized` object, nullable, required
    - `periodStart` string, date-time, nullable, required
    - `periodEnd` string, date-time, nullable, required
  - `creditGrants` object[], required
    - `id` string, required
    - `code` string, nullable, required
    - `creditCents` integer, required
    - `redeemedAt` string, date-time, required
    - `appliedAt` string, date-time, nullable, required
  - `creditBalanceCents` integer, required
  - `basePriceCents` integer, required
  - `hasMoreInvoices` boolean, required
  - `nextInvoiceCursor` string, nullable, required
  - `hasMoreCreditGrants` boolean, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)
