---
title: "POST /api/v1/billing.service-credits.accounts.get"
method: POST
path: "/api/v1/billing.service-credits.accounts.get"
tags: ["Billing"]
---

# POST /api/v1/billing.service-credits.accounts.get

`POST /api/v1/billing.service-credits.accounts.get`

## Request

- Base URL: `https://api.partly.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.partly.com/api/v1/billing.service-credits.accounts.get`
- Auth: none declared. Required headers: `authorization`

Get a service-credit account, by id or by organization and product scope, with its balance and a ledger check recomputed from the journal. Restricted to billing staff.

## Headers

- `authorization` string, required: UTF-8 encoded string

## Request body

- union
  - object
    - `account_id` string, uuid, required: UUID value type
    - `kind` 'id', required
  - object
    - `kind` 'scope', required
    - `organization_id` string, uuid, required: UUID value type
    - `product_scope` string, required: UTF-8 encoded string

## Response `200`

200 OK

- BillingServiceCreditAccountGetResponse
  - `account` BillingServiceCreditAccountDetail, required
    - `created_at` string, date-time, required: DateTime at a given timezone (RFC3339 format)
    - `customer_id` string, uuid, required: UUID value type
    - `id` string, uuid, required: UUID value type
    - `organization_id` string, uuid, required: UUID value type
    - `product_scope` string, required: UTF-8 encoded string
    - `status` union, required
      - 'active'
      - 'held'
    - `status_reason` string, required: UTF-8 encoded string
  - `balance` BillingServiceCreditBalance, required: Quanta by bucket. `spendable` excludes grants past expiry at `as_of`, and `expired_pending` is their value not yet journaled as expired.
    - `as_of` string, date-time, required: DateTime at a given timezone (RFC3339 format)
    - `available` integer, required: 64-bit unsigned integer
    - `consumed` integer, required: 64-bit unsigned integer
    - `expired` integer, required: 64-bit unsigned integer
    - `expired_pending` integer, required: 64-bit unsigned integer
    - `granted` integer, required: 64-bit unsigned integer
    - `open_reservations` integer, required: 64-bit unsigned integer
    - `reserved` integer, required: 64-bit unsigned integer
    - `spendable` integer, required: 64-bit unsigned integer
  - `ledger_check` BillingServiceCreditLedgerCheck, required: The self-check of the balance: it is recomputed from the whole journal, which scans every entry of the account, and set beside the stored projection. `consistent` is true only when they agree and every ledger equation holds. Meant for staff, not for frequent polling.
    - `consistent` boolean, required: Boolean value
    - `ledger` BillingServiceCreditBalance, required: Quanta by bucket. `spendable` excludes grants past expiry at `as_of`, and `expired_pending` is their value not yet journaled as expired.
      - `as_of` string, date-time, required: DateTime at a given timezone (RFC3339 format)
      - `available` integer, required: 64-bit unsigned integer
      - `consumed` integer, required: 64-bit unsigned integer
      - `expired` integer, required: 64-bit unsigned integer
      - `expired_pending` integer, required: 64-bit unsigned integer
      - `granted` integer, required: 64-bit unsigned integer
      - `open_reservations` integer, required: 64-bit unsigned integer
      - `reserved` integer, required: 64-bit unsigned integer
      - `spendable` integer, required: 64-bit unsigned integer
    - `projected` BillingServiceCreditBalance, required: Quanta by bucket. `spendable` excludes grants past expiry at `as_of`, and `expired_pending` is their value not yet journaled as expired.
      - `as_of` string, date-time, required: DateTime at a given timezone (RFC3339 format)
      - `available` integer, required: 64-bit unsigned integer
      - `consumed` integer, required: 64-bit unsigned integer
      - `expired` integer, required: 64-bit unsigned integer
      - `expired_pending` integer, required: 64-bit unsigned integer
      - `granted` integer, required: 64-bit unsigned integer
      - `open_reservations` integer, required: 64-bit unsigned integer
      - `reserved` integer, required: 64-bit unsigned integer
      - `spendable` integer, required: 64-bit unsigned integer

## Other responses

- `default`: Error cases

## Changes

- **2026-10-14** `dcced4ac6ce2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/partly/apis/core-server/changes/api/v1/billing.service-credits.accounts.get/post.md)

---

[API](https://skmtc.dev/partly/apis/core-server.md) · [All operations](https://skmtc.dev/partly/apis/core-server/llms.txt) · [OpenAPI document](https://skmtc.dev/partly/apis/core-server/revisions/0060854f7c86?raw)