Create Coupon Code
POST {{baseUrl}}/api/coupon-codes/
Synchronously creates a coupon code for the given coupon.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
coupon-codes:write
Request Body
{"data"=>{"type"=>"coupon-code", "attributes"=>{"unique_code"=>"<string>", "expires_at"=>"<dateTime>"}, "relationships"=>{"coupon"=>{"data"=>{"type"=>"coupon", "id"=>"<string>"}}}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":{"type":"coupon-code","id":"\u003cstring\u003e","attributes":{"unique_code":"\u003cstring\u003e","expires_at":"\u003cdateTime\u003e","status":"PROCESSING"},"links":{"self":"\u003curi\u003e"},"relationships":{"coupon":{"data":{"type":"coupon","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"profile":{"data":{"type":"profile","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}