---
title: "Get Credit Liability"
method: GET
path: "/admin/finance/credit-liability"
tags: ["admin"]
---

# Get Credit Liability

`GET /admin/finance/credit-liability`

## Request

- Base URL: `https://api.framesail.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.framesail.com/admin/finance/credit-liability`
- Auth: HTTP bearer

Credits granted / spent / expired per month, and what is still owed.

The monthly rows are a flow bounded by the selected window; the outstanding
totals are an all-time snapshot taken now (what we owe customers doesn't
depend on which dates happen to be on screen).

## Query parameters

- `start` string, date, nullable: Inclusive start date (YYYY-MM-DD)
- `end` string, date, nullable: Inclusive end date (YYYY-MM-DD)

## Response `200`

Successful Response

- CreditLiability
  - `start` string, required
  - `end` string, required
  - `months` CreditMonth[], required
    - `month` string, required
    - `granted_credits` integer, required
    - `granted_subscription` integer, required
    - `granted_topup` integer, required
    - `granted_signup` integer, required
    - `granted_affiliate` integer, required
    - `granted_other` integer, required
    - `topup_value_usd` number, required
    - `spent_credits` integer, required
    - `expired_credits` integer, required
    - `outstanding_credits` integer, required
  - `outstanding_credits` integer, required
  - `outstanding_subscription` integer, required
  - `outstanding_topup` integer, required
  - `outstanding_signup` integer, required
  - `outstanding_affiliate` integer, required
  - `outstanding_other` integer, required
  - `outstanding_topup_value_usd` number, required
  - `expiring_30d_credits` integer, required
  - `never_expires_credits` integer, required
  - `unpriced_topup_grants` integer, required

## Other responses

- `422`: Validation Error

---

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