Get Credit Grant

GET

credit-grants

{id}

curl https://api.alguna.io/credit-grants/grant_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

const grant = await alguna.creditGrants.get('grant_abc123');

{
  "id": "grant_abc123",
  "wallet_id": "wal_def456",
  "amount": "500.00",
  "description": "Annual credit allocation",
  "expires_at": "2024-12-31T23:59:59Z",
  "payment_id": null,
  "status": "active",
  "created_at": "2024-01-20T10:00:00Z",
  "updated_at": "2024-01-20T10:00:00Z"
}

Retrieve a credit grant by its ID.

string

required

The credit grant ID.

curl https://api.alguna.io/credit-grants/grant_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

const grant = await alguna.creditGrants.get('grant_abc123');

{
  "id": "grant_abc123",
  "wallet_id": "wal_def456",
  "amount": "500.00",
  "description": "Annual credit allocation",
  "expires_at": "2024-12-31T23:59:59Z",
  "payment_id": null,
  "status": "active",
  "created_at": "2024-01-20T10:00:00Z",
  "updated_at": "2024-01-20T10:00:00Z"
}

string

Unique identifier for the credit grant.

string

The wallet this grant belongs to.

string

Grant amount as a decimal string.

string

Grant status: active, approved, pending, exhausted, expired, or voided.

string

ISO 8601 expiration date, if set.

List Credit Grants

⌘I

curl https://api.alguna.io/credit-grants/grant_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

const grant = await alguna.creditGrants.get('grant_abc123');

{
  "id": "grant_abc123",
  "wallet_id": "wal_def456",
  "amount": "500.00",
  "description": "Annual credit allocation",
  "expires_at": "2024-12-31T23:59:59Z",
  "payment_id": null,
  "status": "active",
  "created_at": "2024-01-20T10:00:00Z",
  "updated_at": "2024-01-20T10:00:00Z"
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets