Sample - Stripe API
GET/v1/billing/credit_grants

List credit grants

Lists credit grants allocated to customers or customer accounts. Filter the collection with customer or customer_account, and use cursor parameters to paginate through the grants. The response includes grant allocation, applicability, expiration, priority, and metadata fields for each result.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 parameters
customerstringoptional
Return only credit grants allocated to this customer.
customer_accountstringoptional
Return only credit grants allocated to this account representing the customer.
ending_beforestringoptional
An object ID cursor that retrieves the page preceding the specified grant.
expandarray<string>optional
Specifies which response fields to expand.
limitintegeroptional
The number of credit grants to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that retrieves the page following the specified grant.

2 status codes
200Returns a paginated list of credit grants with grant data, a `has_more` indicator, the list object type, and the list URL.
dataarray<CreditGrant>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

limit must be between 1 and 100 when provided, and defaults to 10 when omitted. ending_before and starting_after are pagination cursors that must not exceed 5000 characters; use valid object identifiers for cursor values.