Create a credit grant on a subscription | Afternoon

import { AfternoonClient } from "afternoon-sdk";
async function main() {
    const client = new AfternoonClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.subscriptions.createCreditGrant("cm5x9z8nv0000h85r7l9p2k1m", {
        name: "Onboarding credits",
        amount: 1000,
    });
}
main();

{
  "success": true,
  "credit_grant": {
    "id": "cm5x9z8nv0004h85r7l9p2k5m",
    "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
    "subscription_id": "cm5x9z8nv0000h85r7l9p2k1m",
    "account_type": "pricing_unit",
    "name": "Onboarding credits",
    "amount": "1000",
    "balance": "1000",
    "status": "active",
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T10:30:00.000Z"
  },
  "request_id": "req_abc123"
}

Grants credits to a subscription. Provide either pricing_unit_id for pricing-unit credits or currency_code for currency credits.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Path parameters

idstringRequiredformat: "cuid"

Request

This endpoint expects an object.

namestringRequired>=1 character

Display name for the credit grant

amountdouble or stringRequired

Credit amount (positive value). Accepts a number or numeric string.

pricing_unit_codestringOptional

Pricing unit code (e.g. “gpu_sec”, “token”). Required when granting pricing-unit credits.

currency_codestringOptional

Currency code (e.g. “usd”). Required when granting currency credits.

expires_atdatetime or nullOptional

ISO 8601 expiration date, or null for no expiry

Response

Credit grant created

successboolean

credit_grantobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error