Base URL
Requirements
- An active Professional subscription. The API rejects any request whose
tenant is not on the Professional tier, or whose subscription is in any
status other than
activeortrialing–past_due,canceled,unpaid, andincompleteall return403, regardless of tier. - An API key created from the in-app Settings → Account → API Keys page.
- One or more scopes assigned to the key. See Scopes.
What is and isn’t documented here
This reference covers the ten endpoints exposed under/api/v1/developer/:
voucher list/get/create/redeem, product list/get, and customer
list/get/create/update.
The following are not part of the public Developer API:
- Outgoing webhooks – VoucherGrid does not publish outbound event webhooks. There is no event subscription, signing secret, or delivery log for partners to consume.
- Bulk endpoints – there are no bulk-create, bulk-redeem, bulk-void, or bulk-resend endpoints. Each operation is one HTTP call against one resource.
- Official SDKs – VoucherGrid does not publish a TypeScript, Python, Ruby,
or PHP SDK. Use the curl /
fetchexamples in each endpoint page as a starting point.
Next steps
- Authentication – how to send your API key.
- Scopes – what each scope unlocks.
- Errors, Rate limits, Idempotency, Pagination.