Get the monetary credit balance for a subscription

GET

subscriptions

{id}

credits

balance

Get the monetary credit balance for a subscription

curl --request GET \
  --url https://api.alguna.io/subscriptions/{id}/credits/balance \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

{
  "as_of": "2026-04-01T00:00:00Z",
  "balance": "125.00",
  "credit_type": "monetary",
  "currency": "USD",
  "subscription_id": "sub_abc123"
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Path Parameters

string

required

Unique identifier for the subscription

Query Parameters

as_of

string<date-time>

required

Point in time to evaluate the balance at (RFC3339). Defaults to now.

Example:

"2026-04-01T00:00:00Z"

Response

Success

as_of

string<date-time>

required

The point in time the balance was evaluated at

Example:

"2026-04-01T00:00:00Z"

balance

string

required

Current balance at the evaluated point in time

Example:

"125.00"

credit_type

string

required

Credit type

Example:

"monetary"

currency

string

required

ISO 4217 currency code

Example:

"USD"

subscription_id

string

required

Subscription ID

Example:

"sub_abc123"

Grant credits to a subscriptionCreates a monetary API-granted credit on a subscription. The grant is immediately available for consumption.

⌘I

Get the monetary credit balance for a subscription

curl --request GET \
  --url https://api.alguna.io/subscriptions/{id}/credits/balance \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

{
  "as_of": "2026-04-01T00:00:00Z",
  "balance": "125.00",
  "credit_type": "monetary",
  "currency": "USD",
  "subscription_id": "sub_abc123"
}