API Reference
Free-offer availability
List free offers available for a zone.
GET /api/portal/free-offer/{companyReference}Access: Public
Portal use case
The portal calls this endpoint to determine which free offers are available before displaying the claim form.
Parameters
- companyReference (path, required)
Response body
{
"active": true,
"offers": [
{
"planId": "plan_uuid",
"name": "Free discovery",
"description": "Limited free access",
"type": "smart-device-based",
"frequency": "once_per_day",
"durationHours": 2
}
]
}| Attribute | Type | Description |
|---|---|---|
offers | array | Available free offers. |
active | boolean | Whether at least one offer is available. |
offers[].planId | string | Free plan identifier. |
offers[].name | string | Plan name. |
offers[].description | string or null | Plan description. |
offers[].type | string | Plan type, including smart-device-based or period-based. |
offers[].frequency | string or null | unlimited, once_per_day, once_per_week, once_per_month, or once_per_year. |
offers[].durationHours | number | Offer duration in hours. |
Status codes
- 200 OK
- 400 Bad Request (invalid reference)
- 404 Not Found (zone not found)