Credit grants

List credit grants

Retrieves a list of credit grants.

GET
/credit_grants

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://api.sandbox.billingrails.com/v1/credit_grants"
{
  "credit_grants": [
    {
      "object": "credit_grant",
      "id": "cgr_IhMUl3rrZ3",
      "type": "promotional",
      "account_id": "acc_IhMUl3rrZ3",
      "currency": "USD",
      "status": "granted",
      "payment_status": "comped",
      "grant_amount": 5000,
      "available_amount": 3000,
      "created_at": "2025-02-14T17:33:40.843Z",
      "effective_at": "2025-02-14T17:33:40.843Z",
      "expires_at": "2025-03-14T17:33:40.843Z"
    }
  ],
  "meta": {
    "request_id": "req_IhMUl3rrZ3",
    "current_page": 1,
    "per_page": 20,
    "total_count": 100
  }
}