Deprecation Notice
Api V3 is being deprecated on July 1st, 2023. Please consider updating to V5
Reward
A reward is an incentive for a campaign.
{
"id": 1,
"name": "Fingerstache vhs paleo tattooed echo cold-pressed.",
"description": "Chuck Norris can access the DB from the UI.",
"amount": 43,
"kind": "virtual",
"quantity": null,
"remaining": null,
"fairMarketValue": 88,
"currency": "USD",
"shippingAddressRequired": false,
"shippingNote": null,
"image": {
"src": "",
"alt": "Chuck Norris can access the DB from the UI.",
"width": 270,
"height": 176
},
"active": true,
"startsAt": 0,
"createdAt": 1498169329000,
"updatedAt": 1498249889000
}
Fields
| key | description |
|---|---|
| id integer |
This is the id of the reward. |
| name string |
The name of the reward. |
| description md-string |
The description of the reward in markdown format. |
| amount integer |
The required donation amount for the reward. |
| kind string |
The type of reward. (product, virtual, or physical) |
| quantity integer |
The quantity of rewards available. |
| remaining integer |
The quantity of rewards remaining. |
| fairMarketValue integer |
The fair market value of the reward. |
| currency string |
The currency the reward is in. |
| shippingAddressRequired boolean |
Denotes if a reward requires shipping information. |
| shippingNote string |
Customized note related to shipping. |
| image image |
An image object for the reward. |
| active boolean |
Whether the reward is toggled to be visible. |
| startsAt date |
When the reward unlocks. |
| createdAt date |
Date of reward creation. |
| updatedAt date |
Date of last change to reward data. |