Skip to main content
GET
/
promotion-code
/
{id}
Get Promotion Code
curl --request GET \
  --url https://uat-api.clinkbill.com/api/promotion-code/{id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "code": 200,
  "msg": "success",
  "data": {
    "couponId": "<string>",
    "promotionCodeId": "<string>",
    "code": "<string>",
    "status": "active",
    "firstOrderOnly": true,
    "redemptionCount": 123,
    "maxRedemptionLimit": 123,
    "validPeriodEnd": 1754819711382,
    "createTime": 1754819711382,
    "mirroring": true,
    "customers": [
      {
        "customerId": "<string>",
        "name": "<string>",
        "email": "<string>"
      }
    ],
    "perCustomerRedemptionLimit": 123,
    "minimumSpend": {},
    "currency": "<string>",
    "amount": 123
  }
}

Authorizations

X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

X-Timestamp
string
header
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Path Parameters

id
string
required

Unique identifier of the promotion code

Response

Promotion code details retrieved successfully

Body of the response message

code
integer<int32>

Response status code, 200 when success

Example:

200

msg
string

Brief description of what happened, 'success' when happy case

Example:

"success"

data
object