List credit grants
LogsGET /credit-grants
List the utility's credit grants, such as those waiting for approval
Requires invoices:read. Newest first, one cursor page at a time.
Parameters
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
statusReturn only grants in this status: pending_approval, active, exhausted, expired or rejected; any other value returns 400.
one of
pending_approval,active,exhausted,expired,rejectedaccount_idReturn only grants made to this account ID.
Returns
200 Grant page
Show attributes
dataShow child attributes
idtenant_idaccount_idcampaign_idfundingone of
cash,grantedsourceamount_minorremaining_minorcurrencyapplies_tocharge_kindsexpires_atstatusone of
pending_approval,active,exhausted,expired,rejectedproposed_byapproved_byrejection_reasonreasoncreated_atupdated_at
has_morenext_cursor
Errors 400
Permissions invoices:read · Roles: admin, analyst, billing_clerk, customer_service, finance, owner, viewer
curl -X GET "$BUSINESS_API/credit-grants" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/credit-grants", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/credit-grants",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/credit-grants", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "cre_2cmf76oNbMmjnic9ZsClLOiDDwu",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"campaign_id": "cam_2WQBFWMJR6y3LeY1tCERReuZREk",
"funding": "cash",
"source": "source",
"amount_minor": 125000,
"remaining_minor": 1,
"currency": "MZN",
"applies_to": [
"2026-11-19"
],
"charge_kinds": [
"charge kind"
],
"expires_at": "2026-11-19T09:30:00Z",
"status": "pending_approval",
"proposed_by": "proposed by",
"approved_by": "approved by",
"rejection_reason": "rejection reason",
"reason": "Leitura confirmada no local.",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}