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.

Changes

Changed in 16 of the 51 revisions of this API.205548

Jul 1, 2026e24a26de41883See the full diff
- ▲
  removed the required property //////////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////////// from the response with the status
  response-required-property-removed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2025f83e937202596See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Sep 25, 2025eb1ac21ec19c5See the full diff
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ●
  added the new prevented enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new prevented enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new prevented enum value to the //////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e1See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
May 22, 20252df8ec106d357See the full diff
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
May 16, 202534998f9d7d739See the full diff
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Mar 27, 20250d3b125ef9f36See the full diff
- ●
  added the new stripe_balance_payment_debit enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new stripe_balance_payment_debit enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new stripe_balance_payment_debit enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new stripe_balance_payment_debit_reversal enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new stripe_balance_payment_debit_reversal enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new stripe_balance_payment_debit_reversal enum value to the ////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history (16 revisions)