create customer credit grant

post https://live.kable.io/api/v1/customers/{customerId}/credits/create

Add a credit grant to a customer.

Path Params

customerId

string

required

The customer ID

Body Params

grantAmount

number

required

The number of credits to create in the grant.

chargeAmount

number

An optional amount to charge the customer (in the customer's configured currency) before issuing a credit grant.

When the chargeAmount field is supplied, Kable will attempt to charge the customer immediately through Stripe before issuing the grant. Therefore, when specifying a chargeAmount, the customer must have a Stripe integration defined and have a default payment card on-file.

description

string

A human-readable description that explains why the credit grant is being created.

expiration

date-time

The expiration date of the credit grant.

Headers

Kable-Client-Id

string

required

Your Kable client ID, found in the dashboard of your Kable account.

Kable-Client-Secret

string

required

Your LIVE or TEST secret key.

Responses

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://live.kable.io/api/v1/customers/customerId/credits/create \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Credit grant successfully created

401Unauthorized

500Something went wrong