Create Credit Grant

POST

credit-grants

curl -X POST https://api.alguna.io/credit-grants \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_id": "wal_def456",
    "amount": "500.00",
    "description": "Annual credit allocation",
    "expires_at": "2024-12-31T23:59:59Z"
  }'

const grant = await alguna.creditGrants.create({
  wallet_id: 'wal_def456',
  amount: '500.00',
  description: 'Annual credit allocation',
  expires_at: '2024-12-31T23:59:59Z'
});

{
  "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"
}

Create a new credit grant for a wallet. Credit grants represent individual credit additions with optional expiration.

string

required

The wallet ID to grant credits to.

string

required

Amount to grant as a decimal string (e.g., “100.00”).

string

Optional description of the credit grant.

string

Optional ISO 8601 expiration date. Credits expire and become unavailable after this date.

string

Optional payment ID if the grant is tied to a payment.

curl -X POST https://api.alguna.io/credit-grants \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_id": "wal_def456",
    "amount": "500.00",
    "description": "Annual credit allocation",
    "expires_at": "2024-12-31T23:59:59Z"
  }'

const grant = await alguna.creditGrants.create({
  wallet_id: 'wal_def456',
  amount: '500.00',
  description: 'Annual credit allocation',
  expires_at: '2024-12-31T23:59:59Z'
});

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

Description of the grant.

string

ISO 8601 expiration date, if set.

string

Associated payment ID, if any.

string

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

string

ISO 8601 timestamp of creation.

string

ISO 8601 timestamp of last update.

Get Credit Grant

⌘I

curl -X POST https://api.alguna.io/credit-grants \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_id": "wal_def456",
    "amount": "500.00",
    "description": "Annual credit allocation",
    "expires_at": "2024-12-31T23:59:59Z"
  }'

const grant = await alguna.creditGrants.create({
  wallet_id: 'wal_def456',
  amount: '500.00',
  description: 'Annual credit allocation',
  expires_at: '2024-12-31T23:59:59Z'
});

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