> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yuko.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Customer Reward Object

A customer reward represents a reward issued to a customer in Yuko. Rewards can take different forms depending on the source — a discount coupon from redeeming loyalty points, a store credit, or a benefit from reaching a VIP tier. Each record tracks the reward's discount code, its value, and its current usage status.

**id**

**integer**

Unique integer identifier for the customer reward.

Example:

`4`

**uuid**

**string\<uuid>**

Unique UUID identifier for the customer reward.

Example:

`"1fd80ced-326f-4082-951b-21a38632a603"`

**org\_uuid**

**string\<uuid>**

The UUID of the organisation this reward belongs to.

Example:

`"4f016742-bda6-4586-a3c1-e78f6291b1cf"`

**customer\_uuid**

**string\<uuid>**

The UUID of the customer this reward was issued to.

Example:

`"a02a4ad4-22c3-4f46-95fb-497e10f3e7d3"`

**source\_type**

**enum\<string>**

The source that generated this reward.

Available options:

`loyalty_rewards`,

`loyalty_tier_benefits`,

`loyalty_campaigns`,

`users`,

`external`

Example:

`"loyalty_rewards"`

**source\_uuid**

**string\<uuid> | null**

The UUID of the specific source record (e.g. the reward definition or tier benefit) that generated this customer reward.

Example:

`"90424fa7-e8a9-4ef4-b43a-72c9b2028db5"`

**discount\_code**

**string**

The discount or coupon code issued to the customer. This is the code the customer applies at checkout.

Example:

`"YUKO-TVJ-BL1"`

**platform\_discount\_id**

**string | null**

The discount identifier in the external ecommerce platform (e.g. Shopify or WooCommerce).

Example:

`"1121797341367"`

**discount\_amount**

**number**

The value of the discount applied to the customer's order, in the store's currency.

Example:

`5.00`

**presentment\_discount\_amount**

**number**

The discount amount in the currency presented to the customer at checkout (may differ from `discount_amount` when using multi-currency).

Example:

`5.00`

**order\_uuid**

**string\<uuid> | null**

The UUID of the order where this reward was used. `null` if the reward has not been used yet.

Example:

`"8cde36f7-dd34-405b-9d25-0e4c5d2b54d7"`

**status**

**enum\<string>**

The current status of the customer reward.

Available options:

`active`,

`used`,

`inactive`,

`expired`,

`deleted`,

`revert`

Example:

`"used"`

**issued\_at**

**string\<date-time> | null**

The date and time when the reward was issued to the customer.

Example:

`"2025-12-17T12:36:33.000Z"`

**expire\_at**

**string\<date-time> | null**

The date and time when the reward expires. `null` if the reward does not expire.

Example:

`null`

**used\_at**

**string\<date-time> | null**

The date and time when the reward was used by the customer. `null` if not yet used.

Example:

`"2025-12-17T12:37:55.000Z"`

**metadata**

**object | null**

Additional details about how the reward was generated and applied.

Show child attributes

**metadata.entry\_type**

**string**

Whether the associated points transaction was a debit or credit.

Example:

`"debit"`

**metadata.used\_point**

**integer**

The number of loyalty points spent to generate this reward.

Example:

`10`

**metadata.earning\_type**

**enum\<string>**

The type of reward issued.

Available options:

`points`,

`store_credit`,

`coupon`

Example:

`"points"`

**metadata.currency\_code**

**string**

The ISO 4217 currency code for the discount value.

Example:

`"USD"`

**metadata.discount\_code**

**string**

The discount code included in the metadata for reference.

Example:

`"YUKO-TVJ-BL1"`

**metadata.discount\_type**

**enum\<string>**

The type of discount applied.

Available options:

`fixed`,

`percentage`

Example:

`"fixed"`

**metadata.discount\_value**

**number**

The monetary or percentage value of the discount.

Example:

`5`

**metadata.transaction\_uuid**

**string\<uuid>**

The UUID of the associated points transaction.

Example:

`"c87fa6a9-c89c-4f85-b839-6677312bdfc5"`

**metadata.point\_ledger\_uuid**

**string\<uuid>**

The UUID of the points ledger entry associated with this reward.

Example:

`"a9209405-c3aa-4db4-91ab-5496fc70ac3b"`

**metadata.platform\_discount\_id**

**string**

The platform discount identifier, duplicated in metadata for reference.

Example:

`"1121797341367"`

**metadata.platform\_discount\_code\_id**

**string**

The platform-specific discount code ID.

Example:

`"20819720994999"`

**created\_at**

**string\<date-time>**

The date and time when the customer reward was created.

Example:

`"2025-12-17T12:36:33.000Z"`

**updated\_at**

**string\<date-time>**

The date and time when the customer reward was last updated.

Example:

`"2025-12-17T12:37:55.000Z"`

**deleted\_at**

**string\<date-time> | null**

The date and time when the customer reward was deleted. `null` if not deleted.

Example:

`null`