Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.66 KB

Reward.md

File metadata and controls

41 lines (25 loc) · 1.66 KB

Reward

Properties

Name Type Description Notes
id String Unique reward ID, assigned by Voucherify.
name String Reward name.
stock Integer Configurable for material rewards. The number of units of the product that you want to share as reward. [optional]
redeemed Integer Defines the number of already invoked (successful) reward redemptions. [optional]
attributes RewardAttributes [optional]
metadata Object The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format.
type TypeEnum Reward type.
parameters RewardType [optional]
createdAt OffsetDateTime Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format.
updatedAt OffsetDateTime Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format. [optional]
_object ObjectEnum The type of the object represented by the JSON. This object stores information about the reward.

Enum: TypeEnum

Name Value
CAMPAIGN "CAMPAIGN"
COIN "COIN"
MATERIAL "MATERIAL"

Enum: ObjectEnum

Name Value
REWARD "reward"