---
title: "Get a built reward supplier"
method: GET
path: "/v6/reward-suppliers/{reward_supplier_id}/built"
tags: ["Reward Suppliers"]
---

# Get a built reward supplier

`GET /v6/reward-suppliers/{reward_supplier_id}/built`

Returns the fully evaluated (built) runtime form of the specified reward supplier.

## Path parameters

- `reward_supplier_id` string, required

## Response `200`

Successful response

- union — reward supplier after buildtime evaluation. Fields `display_type`, `name`, `display_name`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `enabled`, and `reward_expires_at` are already evaluated.
  - object — custom reward supplier after buildtime evaluation. Fields `name`, `display_name`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `display_type`, `enabled`, and `reward_expires_at` are already evaluated.
    - `cash_back_max` number, required
    - `cash_back_min` number, required
    - `cash_back_percentage` number, required
    - `component_ids` string[], required
    - `component_references` ComponentReferenceResponse[], required
      - `component_id` string
      - `socket_names` string[]
    - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `data` object, required
    - `display_name` string, required
    - `display_type` string, required
    - `enabled` boolean, required
    - `face_value` number, required
    - `face_value_algorithm_type` 'CASH_BACK' | 'FIXED', required
    - `face_value_type` 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD', required
    - `id` string, required
    - `limit_per_day` integer, required
    - `limit_per_hour` integer, required
    - `name` string, required
    - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required
    - `partner_reward_supplier_id` string, required
    - `reward_expires_at` union, required — The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
      - string — Literal reward expires at
      - string — Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
      - string — Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
    - `reward_supplier_type` 'CUSTOM_REWARD', required
    - `state_transitions` object, required
    - `tags` string[], required
    - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `auto_fulfillment_enabled` boolean, required
    - `missing_fulfillment_alert_delay_ms` integer, required
    - `missing_fulfillment_alert_enabled` boolean, required
    - `missing_fulfillment_auto_fail_delay_ms` integer, required
    - `missing_fulfillment_auto_fail_enabled` boolean, required
    - `reward_email_auto_send_enabled` boolean, required
    - `type` 'ACCOUNT_CREDIT' | 'LOYALTY_POINTS', required
  - object — manual coupon reward supplier after buildtime evaluation. Fields `display_type`, `face_value_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `name`, `display_name`, `enabled`, and `reward_expires_at` are already evaluated.
    - `cash_back_max` number, required
    - `cash_back_min` number, required
    - `cash_back_percentage` number, required
    - `component_ids` string[], required
    - `component_references` ComponentReferenceResponse[], required
      - `component_id` string
      - `socket_names` string[]
    - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `data` object, required
    - `display_name` string, required
    - `display_type` string, required
    - `enabled` boolean, required
    - `face_value` number, required
    - `face_value_algorithm_type` 'CASH_BACK' | 'FIXED', required
    - `face_value_type` 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD', required
    - `id` string, required
    - `limit_per_day` integer, required
    - `limit_per_hour` integer, required
    - `name` string, required
    - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required
    - `partner_reward_supplier_id` string, required
    - `reward_expires_at` union, required — The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
      - string — Literal reward expires at
      - string — Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
      - string — Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
    - `reward_supplier_type` 'MANUAL_COUPON', required
    - `state_transitions` object, required
    - `tags` string[], required
    - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `coupon_count_warn_limit` integer, required
    - `default_coupon_expiry_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `minimum_coupon_lifetime` integer, required
  - object — pay pal payouts reward supplier after buildtime evaluation. Fields `display_type`, `name`, `display_name`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `description`, `enabled`, and `reward_expires_at` are already evaluated.
    - `cash_back_max` number, required
    - `cash_back_min` number, required
    - `cash_back_percentage` number, required
    - `component_ids` string[], required
    - `component_references` ComponentReferenceResponse[], required
      - `component_id` string
      - `socket_names` string[]
    - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `data` object, required
    - `display_name` string, required
    - `display_type` string, required
    - `enabled` boolean, required
    - `face_value` number, required
    - `face_value_algorithm_type` 'CASH_BACK' | 'FIXED', required
    - `face_value_type` 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD', required
    - `id` string, required
    - `limit_per_day` integer, required
    - `limit_per_hour` integer, required
    - `name` string, required
    - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required
    - `partner_reward_supplier_id` string, required
    - `reward_expires_at` union, required — The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
      - string — Literal reward expires at
      - string — Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
      - string — Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
    - `reward_supplier_type` 'PAYPAL_PAYOUTS', required
    - `state_transitions` object, required
    - `tags` string[], required
    - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `description` string, required
    - `merchant_token` string, required
  - object — salesforce coupon reward supplier after buildtime evaluation. Fields `display_type`, `face_value_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `name`, `display_name`, `coupon_pool_id`, `enabled`, and `reward_expires_at` are already evaluated.
    - `cash_back_max` number, required
    - `cash_back_min` number, required
    - `cash_back_percentage` number, required
    - `component_ids` string[], required
    - `component_references` ComponentReferenceResponse[], required
      - `component_id` string
      - `socket_names` string[]
    - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `data` object, required
    - `display_name` string, required
    - `display_type` string, required
    - `enabled` boolean, required
    - `face_value` number, required
    - `face_value_algorithm_type` 'CASH_BACK' | 'FIXED', required
    - `face_value_type` 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD', required
    - `id` string, required
    - `limit_per_day` integer, required
    - `limit_per_hour` integer, required
    - `name` string, required
    - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required
    - `partner_reward_supplier_id` string, required
    - `reward_expires_at` union, required — The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
      - string — Literal reward expires at
      - string — Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
      - string — Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
    - `reward_supplier_type` 'SALESFORCE_COUPON', required
    - `state_transitions` object, required
    - `tags` string[], required
    - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `balance_refill_amount` integer, required
    - `coupon_pool_id` string, required
    - `initial_offset` integer, required
    - `settings_id` string, required
  - object — tango reward supplier after buildtime evaluation. Fields `display_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `name`, `display_name`, `description`, `enabled`, and `reward_expires_at` are already evaluated.
    - `cash_back_max` number, required
    - `cash_back_min` number, required
    - `cash_back_percentage` number, required
    - `component_ids` string[], required
    - `component_references` ComponentReferenceResponse[], required
      - `component_id` string
      - `socket_names` string[]
    - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `data` object, required
    - `display_name` string, required
    - `display_type` string, required
    - `enabled` boolean, required
    - `face_value` number, required
    - `face_value_algorithm_type` 'CASH_BACK' | 'FIXED', required
    - `face_value_type` 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD', required
    - `id` string, required
    - `limit_per_day` integer, required
    - `limit_per_hour` integer, required
    - `name` string, required
    - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required
    - `partner_reward_supplier_id` string, required
    - `reward_expires_at` union, required — The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically.
      - string — Literal reward expires at
      - string — Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
      - string — Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts).
    - `reward_supplier_type` 'TANGO_V2', required
    - `state_transitions` object, required
    - `tags` string[], required
    - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `account_id` string, required
    - `brand_description` string, required
    - `brand_disclaimer` string, required
    - `brand_image_url` string, required
    - `brand_name` string, required
    - `description` string, required
    - `utid` string, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `415` — Unsupported Media Type
- `429` — Too Many Requests

---

[API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/revisions/c16e62e66755/schema)