v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a credit grant

Retrieves a credit grant.

get/v1/billing/credit_grants/{id}

Path parameters

idstring required

Unique identifier for the object.

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

category'paid' | 'promotional' required

The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

customer_accountstring nullable

ID of the account representing the customer receiving the billing credits

effective_atinteger nullable

The time when the billing credits become effective-when they're eligible for use.

expires_atinteger nullable

The time when the billing credits expire. If not present, the billing credits don't expire.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

namestring nullable

A descriptive name shown in dashboard.

object'billing.credit_grant' required

String representing the object's type. Objects of the same type share the same value.

priorityinteger nullable

The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.

updatedinteger required

Time at which the object was last updated. Measured in seconds since the Unix epoch.

voided_atinteger nullable

The time when this credit grant was voided. If not present, the credit grant hasn't been voided.