Credit grants

Expire credit grant

Expires a credit grant.

POST
/credit_grants/{id}/expire

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

curl -X POST "https://api.sandbox.billingrails.com/v1/credit_grants/cgr_IhMUl3rrZ3/expire"
{
  "credit_grant": {
    "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"
  }
}