--- title: Get Compensation by Coupon Code slug: get-compensation-by-coupon-code docTags: createdAt: 2025-09-12T20:51:27.706Z --- { "id": "t_KLKKAgpRJZYiWhiRBKG", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.b.preview.loyaltyservices.io/api/v3/compensation/coupons/{couponCode}", "servers": [ { "url": "https://api.b.preview.loyaltyservices.io/api/v3/compensation/coupons/{couponCode}" } ], "name": "Get Compensation by Coupon Code", "description": "Retrieve coupon compensations.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "couponCode", "type": "string", "description": "Unique Coupon Identifier", "minLength": 1, "maxLength": 200 } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

See https://docs.wearephaedon.com/docs/platform-api-authentication

", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://phaedon.oktapreview.com/oauth2/auscfbbmieFBGGOzR1d7/v1/token", "scopes": { "api:custom-data:read": "Grants read access to custom data information", "api:custom-data:modify": "Grants modify access to custom data information", "api:data-codes:read": "Grants read access to data codes", "api:data-codes:modify": "Grants modify access to data codes", "api:coupon-compensation:read": "Grants read access to compensations for coupon code", "api:coupon-compensation:create": "Grants access to create compensations for coupon code", "api:coupon-compensation:modify": "Grants access to edit compensation nights for coupon code", "api:coupon-request:modify": "Grants modify access to create coupons", "api:member:search": "Grants search access to member information", "api:member:verify": "Grants verify access to member information", "api:member:merge": "Grants access to merge members", "api:member:enroll": "Grants access to enroll members", "api:member:modify": "Grants modify access to member information", "api:member:read": "Grants read access to member information", "api:member:close": "Grants access to close member account", "api:member:migrate": "Grants access to migrate member accounts", "api:member-address:read": "Grants read access to member address information", "api:member-address:modify": "Grants modify access to member address information", "api:member-alias:read": "Grants read access to member alias information", "api:member-alias:modify": "Grants modify access to member alias information", "api:member-badge:read": "Grants read access to member badge information", "api:member-badge:modify": "Grants modify access to member badge information", "api:member-bonus:add": "Grants access to add a bonus to a member", "api:member-bonus:read": "Grants read access to member bonus information", "api:member-comments:read": "Grants read access to member comments information", "api:member-comments:modify": "Grants modify access to member comments information", "api:member-communication:read": "Grants read access to member communication information", "api:member-communication:modify": "Grants modify access to member communication information", "api:member-coupon:read": "Grants read access to member coupon information", "api:member-coupon-use:cancel": "Grants access to cancel member coupon uses", "api:member-coupon:transfer": "Grants access to transfer a member coupon", "api:member-coupon-use:update": "Grants access to update member coupon uses", "api:member-currency:read": "Grants read access to member currency information", "api:member-currency:adjust": "Grants access to adjust member currency", "api:member-currency:migrate": "Grants access to migrate member currency", "api:member-currency-conversion:convert": "Grants access to convert member currency", "api:member-email:read": "Grants read access to member email information", "api:member-email:modify": "Grants modify access to member email information", "api:member-event:read": "Grants read access to member events", "api:member-event:modify": "Grants modify access to member events", "api:event-rule:read": "Grants read access to event rules", "api:event-rule:modify": "Grants access to modify event rule", "api:event-rule:admin": "Grants full admin access to event rules", "api:member-list:read": "Grants read access to member list information", "api:member-list:modify": "Grants modify access to member list information", "api:member-partner-link:read": "Grants read access to member partner link information", "api:member-partner-link:modify": "Grants modify access to member partner link information", "api:member-payment-card:read": "Grants read access to member payment card information", "api:member-payment-card:modify": "Grants modify access to member payment card information", "api:member-phone:read": "Grants read access to member phone information", "api:member-phone:modify": "Grants modify access to member phone information", "api:member-preference:read": "Grants read access to member preference information", "api:member-preference:modify": "Grants modify access to member preference information", "api:member-promotion:read": "Grants read access to member promotion information", "api:member-promotion:register": "Grants access to register a member into a promotion", "api:member-redemption:create": "Grants redeem access to member redemption information", "api:member-redemption:over-redeem": "Grants access to over redeem", "api:member-redemption:read": "Grants read access to member redemption information", "api:member-redemption:cancel": "Grants access to cancel member redemptions", "api:member-redemption:migrate": "Allows migration of member redemption information", "api:member-redemption:patch": "Grants patching access to member redemption", "api:member-tier:read": "Grants read access to member tier information", "api:member-tier:adjust": "Grants access to adjust member tiers", "api:member-tier:migrate": "Grants access to migrate member tiers", "api:member-transaction:read": "Grants read access to transaction information", "api:member-transaction:cancel": "Grants access to cancel transactions", "api:member-transaction:clone": "Grants access to clone transactions", "api:member-transfer:transfer": "Grants access to do member to member transfers", "api:preference:read": "Grants read access to preference information", "api:promotion:read": "Grants read access to promotion information", "api:tier:read": "Grant read access to tier information", "api:promotion:register": "Grants access to register a member into a promotion using token", "api:promotion-token:manage": "Grants access to generate promotion token", "api:redemption:read": "Grants read access to redemption information", "api:redemption:modify": "Grants access to modify redemption information", "api:bonus-rule:read": "Grants read access to bonus rule configuration", "api:bonus-rule:modify": "Grants access to modify bonus rule configuration", "api:bonus-rule:manage": "Grants limited admin access to bonus rule configuration", "api:bonus-rule:admin": "Grants full admin access to bonus rules", "api:promotion-rule:read": "Grants read access to promotion rule configuration", "api:promotion-rule:modify": "Grants access to modify promotion rule configuration", "api:promotion-rule:manage": "Grants limited admin access to promotion rule configuration", "api:promotion-rule:admin": "Grants full admin access to promotion rules", "api:reports:under-investigation": "Grants access to under investigation report", "api:transaction:submit": "Grants access to submit transactions", "api:transaction:migrate": "Grants access to migrate transactions", "api:user:read": "Grants access to read user information", "api:user:modify": "Grants access to create user", "api:user-task:read": "Grants read access to user tasks", "api:user-task:modify": "Grants modify access to user tasks", "api:user-role:read": "Grants read access to user roles", "api:user-role:modify": "Grants modify access to user roles", "api:compensation:read": "Grants read access to hotel summary information", "api:compensation:modify": "Grants modify access to hotel summary information", "api:member-referral:read": "Grants read access to member referral information", "api:member-referral:modify": "Grants modify access to member referral information", "api:member-referral-codes:read": "Grants read access to member referral codes", "api:member-referral-codes:create": "Grants access to create member referral codes", "api:outbound-notification:modify": "Grants access to send outbound notification", "api:outbound-notification:read": "Grants access to read outbound notification types", "api:background-task:read": "Grants read access to background task information", "api:async-task:create": "Grants access to submit operations for background processing", "api:async-task:read": "Grants read access to background processing results", "api:audit-configuration:read": "Grants read access to audit configuration information", "api:audit-configuration:modify": "Grants modify access to audit configuration information", "api:badge:read": "Grant read access to badge information", "api:broadcast-messages:read": "Grant Read access to broadcast messages", "api:expression-config:read": "Grant read access to expression builder configuration", "api:managed-entity:read": "Grant read access to managed entity data", "api:customer-satisfaction:modify": "Grants modify access to customer satisfaction metrics", "api:member-linked-account:modify": "Grant modify access to member linked account", "api:member-linked-account:read": "Grants access to read linked member accounts", "api:enroll-codes:read": "Grants access to read enroll codes", "api:contact-us:modify": "Grants access to submit Contact Us inquiry", "api:data-release:read": "Grants read access to data releases", "api:points-pool:read": "Grants read access to points pools", "api:points-pool:modify": "Grants modify access to points pools", "api:segment:read": "Grants read access to segments", "api:segment:modify": "Grants modify access to segments", "api:communication-type:read": "Grants read access to communication types", "api:communication-type:modify": "Grants modify access to communication types", "api:member-status-match:read": "Grants read access to status match eligibility and submitted images/applications", "api:member-status-match:create": "Grants access to upload status match images and submit applications" } } }, "requiredScopes": [ "api:coupon-compensation:read" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "CompensationsResponse", "schema": [ { "name": "compensations", "kind": "optional", "type": "array", "description": "List of compensations for coupon", "modelRef": "#/components/schemas/CompensationDetail", "customType": "CompensationDetail[]", "schema": [ { "name": "accountingPeriod", "kind": "optional", "type": "integer", "description": "

Year and month of the period calculated. Format: YYYYMM

", "format": "int32" }, { "name": "runStatus", "kind": "optional", "type": "string", "description": "Code of Invoice Status", "example": "Processed" }, { "name": "type", "kind": "optional", "type": "string", "description": "Code of Invoice Type", "example": "Calculated" }, { "name": "reason", "kind": "optional", "type": "string", "description": "

Code of Reason why coupon was not invoiced (if Invoice Type is Error or Ineligible)

", "example": "NORULE" }, { "name": "couponCode", "kind": "optional", "type": "string", "description": "Unique Coupon Identifier" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "Total Compensation Amount" }, { "name": "compensationDetails", "kind": "optional", "type": "array", "description": "Optional details about every compensation for the given coupon code", "modelRef": "#/components/schemas/CompensationDetailItem", "customType": "CompensationDetailItem[]", "schema": [ { "name": "couponUseAmount", "kind": "optional", "type": "number", "description": "Amount compensated for a coupon usage" }, { "name": "confirmationNumber", "kind": "optional", "type": "string", "description": "Event confirmation number" }, { "name": "startDateTime", "kind": "optional", "type": "string", "description": "Start date of the event where the coupon was used", "format": "date-time" }, { "name": "endDateTime", "kind": "optional", "type": "string", "description": "End date of the event where the coupon was used", "format": "date-time" }, { "name": "customData", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CustomData", "customType": "CustomData", "schema": [ { "name": "ace01", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace01Description field.

" }, { "name": "ace01Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace01 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace02", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace02Description field.

" }, { "name": "ace02Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace02 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace03", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace03Description field.

" }, { "name": "ace03Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace03 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace04", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace04Description field.

" }, { "name": "ace04Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace04 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace05", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace05Description field.

" }, { "name": "ace05Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace05 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace06", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace06Description field.

" }, { "name": "ace06Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace06 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace07", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace07Description field.

" }, { "name": "ace07Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace07 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace08", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace08Description field.

" }, { "name": "ace08Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace08 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace09", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace09Description field.

" }, { "name": "ace09Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the ace09 code value. Use this field to interpret the meaning of ace09 within the context of the client program.

" }, { "name": "ace10", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace10Description field.

" }, { "name": "ace10Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the ace10 code value. Use this field to interpret the meaning of ace10 within the context of the client program.

" }, { "name": "ace11", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace11Description field.

" }, { "name": "ace11Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace11 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace12", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace12Description field.

" }, { "name": "ace12Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace12 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace13", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace13Description field.

" }, { "name": "ace13Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace13 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace14", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace14Description field.

" }, { "name": "ace14Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace14 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" }, { "name": "ace15", "kind": "optional", "type": "string", "description": "

Client-defined custom attribute. Value is program-specific; valid values are defined in the client program's custom data configuration. To get the human-readable label, refer to the paired ace15Description field.

" }, { "name": "ace15Description", "kind": "optional", "type": "string", "description": "

Human-readable label for the corresponding ace15 code value. Use this field to interpret the meaning of the paired ACE code within the context of the client program.

" } ] } ] } ] } ], "modelRef": "#/components/schemas/CompensationsResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "errors", "kind": "optional", "type": "array", "description": "List of errors", "modelRef": "#/components/schemas/ValidationError", "customType": "ValidationError[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code assigned to this violation" }, { "name": "fieldName", "kind": "optional", "type": "string", "description": "

Name of field that violated validation constraint (optional)

" }, { "name": "message", "kind": "optional", "type": "string", "description": "Internal message describing the error" }, { "name": "messageParameters", "kind": "optional", "type": "array", "description": "Error message parameters", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "sLF-dI8f3EyB0HMLBn-o0", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.b.preview.loyaltyservices.io/api/v3/compensation/coupons/{couponCode} \\\n --header 'accept: application/json'" }, { "id": "CnnXmQdqvgXFWsYe4B7Gr", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.b.preview.loyaltyservices.io/api/v3/compensation/coupons/{couponCode}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "-4f6TtLgvAGcSfX5w3xa8", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.b.preview.loyaltyservices.io/api/v3/compensation/coupons/{couponCode}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "SWxdsu-svNHcEddDknP2q", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api.b.preview.loyaltyservices.io/api/v3/compensation/coupons/{couponCode}\")\n .method(\"GET\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "sLF-dI8f3EyB0HMLBn-o0" }, "results": { "languages": [ { "id": "KzSfFaskCeHQSzgCtle5w", "language": "200", "code": "// Success\n{\n \"compensations\": [\n {\n \"accountingPeriod\": \"\",\n \"runStatus\": \"Processed\",\n \"type\": \"Calculated\",\n \"reason\": \"NORULE\",\n \"couponCode\": \"\",\n \"totalAmount\": 0,\n \"compensationDetails\": [\n {\n \"couponUseAmount\": 0,\n \"confirmationNumber\": \"\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"customData\": {\n \"ace01\": \"\",\n \"ace01Description\": \"\",\n \"ace02\": \"\",\n \"ace02Description\": \"\",\n \"ace03\": \"\",\n \"ace03Description\": \"\",\n \"ace04\": \"\",\n \"ace04Description\": \"\",\n \"ace05\": \"\",\n \"ace05Description\": \"\",\n \"ace06\": \"\",\n \"ace06Description\": \"\",\n \"ace07\": \"\",\n \"ace07Description\": \"\",\n \"ace08\": \"\",\n \"ace08Description\": \"\",\n \"ace09\": \"\",\n \"ace09Description\": \"\",\n \"ace10\": \"\",\n \"ace10Description\": \"\",\n \"ace11\": \"\",\n \"ace11Description\": \"\",\n \"ace12\": \"\",\n \"ace12Description\": \"\",\n \"ace13\": \"\",\n \"ace13Description\": \"\",\n \"ace14\": \"\",\n \"ace14Description\": \"\",\n \"ace15\": \"\",\n \"ace15Description\": \"\"\n }\n }\n ]\n }\n ]\n}" }, { "id": "h06j0EmG6ILtrq5FkGieW", "language": "400", "code": "// Bad request\n{\n \"errors\": [\n {\n \"code\": \"\",\n \"fieldName\": \"\",\n \"message\": \"\",\n \"messageParameters\": [\n {}\n ]\n }\n ]\n}" }, { "id": "SE8HRsAHdQHBIr2XtNXP8", "language": "401", "code": "// Unauthorized\n" }, { "id": "S0Mfjl1TbgZcxZwevENsn", "language": "403", "code": "// Forbidden\n" }, { "id": "kR7yFi92mQkcNd4bIX6Qf", "language": "500", "code": "// Internal error\n" } ], "selectedLanguageId": "KzSfFaskCeHQSzgCtle5w" } }, "children": [ { "text": "" } ] }