(v2.9.0) Vouchers and Voucher Groups
28 days ago
š¹Whatās new
We're introducing Vouchers and Voucher Groups.
Vouchers let you grant drivers special pricing or access at your locations. A voucher belongs to a voucher group and is uniquely identified by a code. It can be linked to one or more tokens (charge keys) and app users. When a driver starts a session, the voucher is applied automatically if:
- the driver's token is linked to a voucher, or
- the driver's app user (linked to that token) is linked to a voucher,
and the voucher's group is associated with the location where the session starts. When it applies, the voucher can affect pricing or grant access.
Voucher Groups unite several vouchers and tie them to the locations where they're valid, so you can manage entitlements at scale.
š New endpoints:
Vouchers
| Method | Endpoint | Description |
|---|---|---|
GET | /v2/vouchers | Get a paginated, filterable list of vouchers |
POST | /v2/vouchers | Create a new voucher |
GET | /v2/vouchers/{id} | Get a voucher by ID |
PATCH | /v2/vouchers/{id} | Update an existing voucher |
DELETE | /v2/vouchers/{id} | Delete a voucher by ID |
GET | /v2/vouchers/{id}/tokens | Get tokens associated with a voucher |
POST | /v2/vouchers/{id}/tokens/{tokenId} | Associate a token with a voucher |
DELETE | /v2/vouchers/{id}/tokens/{tokenId} | Disassociate a token from a voucher |
Voucher Groups
| Method | Endpoint | Description |
|---|---|---|
GET | /v2/voucher-groups | Get a list of voucher groups |
POST | /v2/voucher-groups | Create a new voucher group |
GET | /v2/voucher-groups/{id} | Get a voucher group by ID |
PATCH | /v2/voucher-groups/{id} | Update an existing voucher group |
DELETE | /v2/voucher-groups/{id} | Delete a voucher group by ID |
GET | /v2/voucher-groups/{id}/vouchers | Get vouchers belonging to a voucher group |
GET | /v2/voucher-groups/{id}/locations | Get the locations associated with a voucher group |
POST | /v2/voucher-groups/{id}/locations/{locationId} | Associate a location with a voucher group |
DELETE | /v2/voucher-groups/{id}/locations/{locationId} | Disassociate a location from a voucher group |
š Next steps
See the full reference in the API documentation for request and response schemas.