API Reference
The BuiltByBit endpoints: list purchases, claim a purchase, and the inbound webhook.
The claim and purchases endpoints use your Kora API key (Authorization: Bearer <key>). The webhook
endpoint is called by BuiltByBit, not by you. The server defaults to the demo host; change the host
variable in the playground to your own domain or IP.
Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Query Parameters
Return only the purchase with this BuiltByBit sale id.
Response Body
application/json
curl -X GET "https://example.com/builtbybit/purchases?sale_id=123456"[ { "sale_id": "string", "resource_id": "string", "purchaser_id": "string", "bbb_license_id": "string", "user_id": "string", "product": "string", "license_key": "string", "redeem": "string", "status": "pending", "renewal": true, "price": 0.1, "currency": "string", "purchase_date": "2019-08-24T14:15:22Z" }]Authorization
apiKey Your Kora API key, sent as Authorization: Bearer <key>.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/builtbybit/claim" \ -H "Content-Type: application/json" \ -d '{ "user_id": "string", "redeem": "string" }'{ "success": true, "license": "string", "user_id": "string"}Request Body
application/json
The purchase payload sent by BuiltByBit.
TypeScript Definitions
Use the request body type in TypeScript.
BuiltByBit purchase payload. Fields follow BuiltByBit's webhook format.
Response Body
curl -X POST "https://example.com/builtbybit/webhook" \ -H "Content-Type: application/json" \ -d '{}'