Record a benefit claim

POST

/v1/benefits

Call this after you grant a benefit so future checks can see it.

Authorization

apiKey

headerAuthorizationBearer <token>

Your secret API key, for example az_live_.... Use az_test_... keys against the sandbox.

application/json

identity*

Everything you know about the person making the request. Send as much as you can.

type*BenefitType

Value in"free_trial""credit""coupon""referral"

checkId?string

The check that approved this benefit.

amount?number

The benefit was recorded.

application/json

id*string

type*BenefitType

Value in"free_trial""credit""coupon""referral"

amount?number

checkId?string

claimedAt*string

Formatdate-time

Example Request

curl -X POST 'https://api.abusezero.com/v1/benefits' \
  -H 'Content-Type: application/json' \
  -d '{
  "identity": {},
  "type": "free_trial"
}'

Example Request

curl -X POST 'https://api.abusezero.com/v1/benefits' \  -H 'Content-Type: application/json' \  -d '{  "identity": {},  "type": "free_trial"}'

Example ResponseSchema

{
  "id": "string",
  "type": "free_trial",
  "amount": 0,
  "checkId": "string",
  "claimedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "type": "free_trial",  "amount": 0,  "checkId": "string",  "claimedAt": "2019-08-24T14:15:22Z"}