Below are four examples of reward objects. You can navigate through the tabs.
{
"id": 6,
"metric": "amount",
"campaign_id": 4,
"name": "Example Reward",
"status": "active",
"type": {
"label": "Recurring",
"value": "recurring"
},
"recipient": {
"label": "Person Referring",
"value": "person_referring"
},
"method": {
"label": "Issue Yourself",
"value": "manual"
},
"auto_issue": false,
"created_at": "2025-01-13",
"currency": "USD", // only available when metric=amount|commission
"amount": 50, // only available when metric=amount
"period_type": "month", // only available when type.value=recurring
"period_amount": 3, // only available when type.value=recurring
"period_limit": 4, // only available when type.value=recurring
"resumable": false // only available when type.value=recurring
}
{
"id": 3,
"metric": "commission",
"campaign_id": 4,
"name": "Example Commission Reward",
"status": "active",
"type": {
"label": "Standard",
"value": "standard"
},
"recipient": {
"label": "Person Referring",
"value": "person_referring"
},
"method": {
"label": "Issue Yourself",
"value": "manual"
},
"auto_issue": false,
"created_at": "2025-01-08",
"currency": "USD", // only available when metric=amount|commission
"commission": "20", // only available when metric=commission
"commission_cap": 300 // only available when metric=commission
}
{
"id": 7,
"metric": "coupon",
"campaign_id": 4,
"name": "Example Coupon Reward",
"status": "active",
"type": {
"label": "Standard",
"value": "standard"
},
"recipient": {
"label": "Person Referring",
"value": "person_referring"
},
"method": {
"label": "Issue Yourself",
"value": "manual"
},
"auto_issue": false,
"created_at": "2025-01-13",
"limit": 10
}
{
"id": 8,
"metric": "custom",
"campaign_id": 4,
"name": "Example Custom Reward",
"status": "active",
"type": {
"label": "Standard",
"value": "standard"
},
"recipient": {
"label": "Person Invited",
"value": "person_invited"
},
"method": {
"label": "Issue Yourself",
"value": "manual"
},
"auto_issue": false,
"created_at": "2025-01-13",
"metric_amount": 10, // only available when metric=custom
"metric_name": "Points", // only available when metric=custom
"limit": null
}