An Incentive Code entity is a single code that can be issued or redeemed.
The following is the JSON representation of an Incentive Code entity within the APIs.
{ "code": "coupon01", "active": true, "issuances": { "total": 2, "unique": 1 }, "redemptions": { "total": 1, "unique": 1 }, "incentive_pool": { "id": 42, "url": "/companies/:id/incentives/pools/:pool_id" }, "created_at: "2017-01-18T17:24:32Z", "updated_at: "2017-01-18T17:24:32Z", "url": "/companies/:id/incentives/codes/:code"} | ||
incentive_pool_id | Integer | Vibes unique identifier for each incentive pool. |
code | String | The name of the incentive pool. |
| active | Boolean | Whether issuance of codes is allowed. |
| issuances | Object | An object describing this code's issuances. |
| issuances.total | Integer | The total number of times this code has been issued. |
| issuances.unique | Integer | The number of unique times this code has been issued. |
| redemptions | Object | An object describing this code's redemptions. |
| redemptions.total | Integer | The total number of times this code has been redeemed. |
| redemptions.unique | Integer | The number of unique times this code has been redeemed. |
| created_at | Timestamp | The date this code was created. |
| updated_at | Timestamp | The date this code was last updated. |
| url | String | The URL to access this resource. |
GET /companies/:id/incentives/codes/:code |