cURL
curl --request POST \ --url https://sandbox-api.billingrails.com/v1/credit_grants \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "account_id": "<string>", "type": "paid", "grant_amount": 1, "currency": "<string>", "asset_code": "<string>", "name": "<string>", "description": "<string>", "expires_at": "2023-11-07T05:31:56Z", "invoice_after_payment": true, "metadata": {}, "with_payment_link": true, "integration_id": "<string>", "allowed_payment_methods": [ "<string>" ], "callback_url": "<string>" }'
{ "credit_grant": { "object": "credit_grant", "id": "cgr_IhMUl3rrZ3", "created_at": "2025-02-14T17:33:40.843Z", "account_id": "acc_IhMUl3rrZ3", "type": "promotional", "status": "granted", "payment_status": "comped", "currency": "NGN", "grant_amount": 5000, "available_amount": 3000, "expires_at": "2025-03-14T17:33:40.843Z", "effective_at": "2025-02-14T17:33:40.843Z" } }
Creates a credit grant.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Credit grant payload
The body is of type object.
object
Credit grant created
The response is of type object.