Skip to main content
GET
Get the monetary credit balance for a subscription

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

id
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"