API ReferenceCoupons
Create
Authorization
AppApiKey AppApiSecret X-Api-Key<token>
Per-app API key. Sent together with the X-Api-Secret header. The key's mode (TEST or LIVE) selects the data partition — it is never taken from the request body.
In: header
X-Api-Secret<token>
Per-app API secret that pairs with X-Api-Key. Both headers are required on every app-facing call.
In: header
Header Parameters
Idempotency-Key?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
*/*
curl -X POST "https://example.com/api/v1/coupons" \ -H "Content-Type: application/json" \ -d '{ "code": "string", "name": "string", "type": "PERCENT", "value": 0, "duration": "ONCE" }'{
"data": {
"id": 0,
"code": "string",
"name": "string",
"type": "PERCENT",
"value": 0,
"duration": "ONCE",
"durationCycles": 0,
"active": true,
"expiresAt": "2019-08-24T14:15:22Z",
"mode": "TEST",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"meta": {
"success": true,
"message": "string",
"errorCode": "RESOURCE_NOT_FOUND",
"timestamp": "2019-08-24T14:15:22Z"
},
"pagination": {
"page": 0,
"size": 0,
"totalElements": 0,
"totalPages": 0
}
}