---
title: "Fetch credit block"
method: GET
path: "/credit_blocks/{block_id}"
tags: ["Credit"]
---

# Fetch credit block

`GET /credit_blocks/{block_id}`

This endpoint returns a credit block identified by its block_id.

## Path parameters

- `block_id` string, required

## Response `200`

OK

- CreditBlock — The Credit Block resource models prepaid credits within Orb.
  - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
  - `id` string, required
  - `balance` number, required
  - `effective_date` string, date-time, nullable, required
  - `expiry_date` string, date-time, nullable, required
  - `per_unit_cost_basis` string, nullable, required
  - `status` 'active' | 'pending_payment', required
  - `maximum_initial_balance` number, nullable, required
  - `filters` PriceFilter[], required
    - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on.
    - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
    - `values` string[], required — The IDs or values that match this filter.
  - `credit_block_source` 'allocation' | 'top_up' | 'manual', required — How this credit block was created: `allocation` (a subscription's recurring credit allocation), `top_up` (an automatic balance-threshold top-up), or `manual` (a manual credit ledger increment, including credits voided or expired off another block).
  - `credit_allocation` CreditBlockAllocation — The credit allocation that funded a block. Extends the allocation resource serialized on prices with the catalog-item attribution of the funding price.
    - `currency` string, required
    - `allows_rollover` boolean, required
    - `custom_expiration` CustomExpiration, required
      - `duration` integer, required
      - `duration_unit` 'day' | 'month', required
    - `filters` PriceFilter[]
      - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on.
      - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
      - `values` string[], required — The IDs or values that match this filter.
    - `license_type_id` string, nullable
    - `item_id` string, required — The ID of the catalog item this block was allocated from, derived from the allocation's price.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `409` — Conflict
- `413` — Content Too Large
- `429` — Too Many Requests
- `500` — Internal Server Error

## Changes

- **2026-07-01** `2580a0ee8d4c` — 2 info
  - added the optional property `credit_allocation` to the response with the `200` status
  - added the required property `credit_block_source` to the response with the `200` status
- **2026-02-12** `c92fb451e13f` — 1 info
  - added the required property `metadata` to the response with the `200` status

[Change history](https://skmtc.dev/orbcorp/apis/api-reference/changes/credit_blocks/:block_id/get.md)

---

[API](https://skmtc.dev/orbcorp/apis/api-reference.md) · [All operations](https://skmtc.dev/orbcorp/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/orbcorp/api-reference/revisions/2580a0ee8d4c/schema)