List credit grants
GET / v1 / billing / credit_grants
Retrieve a list of credit grants.
Parameters
- customer string Only return credit grants for this customer.
- customer _ account string Only return credit grants for this account representing the customer.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
Returns a list of credit grants.
Response
Expire a credit grant
POST / v1 / billing / credit_grants /:id / expire
Expires a credit grant.
Parameters
- id string Required Unique identifier for the object.
Returns
Returns the expired credit grant.
Response
{ "id": "credgr_test_61R9rm9vto9SMMvt041L6nFOS1ekDCim", "object": "billing.credit_grant", "amount": { "monetary": { "currency": "usd", "value": 1000 }, "type": "monetary" }, "applicability_config": { "scope": { "price_type": "metered" } }, "category": "paid", "created": 1726688741, "customer": "cus_QsEHa3GKweMwih", "effective_at": 1726688741, "expires_at": 1726688796, "livemode": false, "metadata": {}, "name": "Purchased Credits", "priority": 50, "test_clock": null, "updated": 1726688796, "voided_at": null}
Void a credit grant
POST / v1 / billing / credit_grants /:id / void
Voids a credit grant.
Parameters
- id string Required Unique identifier for the object.
Returns
Returns the voided credit grant.
Response
{ "id": "credgr_test_61R9rnNTDmZ657a2r41L6nFOS1ekD5Ae", "object": "billing.credit_grant", "amount": { "monetary": { "currency": "usd", "value": 1000 }, "type": "monetary" }, "applicability_config": { "scope": { "price_type": "metered" } }, "category": "paid", "created": 1726688817, "customer": "cus_QsEHa3GKweMwih", "effective_at": 1726688817, "expires_at": null, "livemode": false, "metadata": {}, "name": "Purchased Credits", "priority": 50, "test_clock": null, "updated": 1726688829, "voided_at": 1726688829}