Create a credit grant
Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.
Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Body
Request body for creating a credit grant
The display name for the credit grant
255The credit amount to grant
The type of credit grant (PAID, PROMOTIONAL)
PAID, PROMOTIONAL The customer ID to grant credits to (required)
1 - 255^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$The credit currency ID (required)
1 - 255^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$The priority of the credit grant (lower number = higher priority)
0 <= x <= 100The date when the credit grant becomes effective
The date when the credit grant expires
Additional metadata for the credit grant
The monetary cost of the credit grant
An optional comment on the credit grant
255The resource ID to scope the grant to
1 - 255^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$The payment collection method (CHARGE, INVOICE, NONE)
CHARGE, INVOICE, NONE Whether to wait for payment confirmation before returning (default: true)
Billing information for the credit grant
Response
The newly created credit grant object.
Response object
Credit grant object representing allocated credits for a customer
