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

# List invoices for credit block

`GET /credit_blocks/{block_id}/invoices`

This endpoint returns the credit block and its associated purchasing invoices.

If a credit block was purchased (as opposed to being manually added),
this endpoint returns the invoices that were created to charge the customer for the credit block.
For credit blocks with payment schedules spanning multiple periods (e.g., monthly payments over 12 months),
multiple invoices will be returned.

For credit blocks created by subscription allocation prices, this endpoint returns the subscription
invoice containing the allocation line item that created the block.

If the credit block was not purchased (e.g., manual increment), an empty invoices list is returned.

**Note: This endpoint is currently experimental and its interface may change in future releases.
Please contact support before building production integrations against this endpoint.**

## Path parameters

- `block_id` string, required

## Response `200`

OK

- CreditBlockInvoicesResponse
  - `block` CreditBlock, required — 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' | 'commitment' | 'manual', required — How this credit block was created: `allocation` (a subscription's recurring credit allocation), `top_up` (an automatic balance-threshold top-up), `commitment` (a subscription commitment true-up rolled forward as credit), 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.
    - `credit_commitment` CreditBlockCommitment — The subscription commitment whose true-up rolled forward into this credit block. Present only when `credit_block_source` is `commitment`.
      - `id` string, required — The ID of the subscription commitment this block was rolled forward from.
      - `subscription_id` string, nullable — The subscription the commitment belongs to.
  - `invoices` InvoiceMinified[], required
    - `id` string, required
    - `invoice_number` string, required
    - `status` 'issued' | 'paid' | 'synced' | 'void' | 'draft', required
    - `customer` CustomerMinified, required
      - `id` string, required
      - `external_customer_id` string, nullable, required
    - `subscription` SubscriptionMinified, required
      - `id` string, required

## Other responses

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

---

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