Skip to main content
GET
/
instances
/
{instanceId}
/
coupon-schedules
List coupon schedules
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId}/coupon-schedules \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "name": "Daily Guest Passes",
    "instance_id": "9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
    "count": 20,
    "recurrence_type": "daily",
    "day_of_week": 1,
    "day_of_month": 15,
    "valid_for_in_minutes": 480,
    "timezone": "Australia/Sydney",
    "notification_group_id": "ng_a1b2c3d4e5f6",
    "last_run_at": "2025-10-29T08:00:00Z",
    "next_run_at": "2025-10-30T08:00:00Z",
    "tokens_used_since_last_run": 5,
    "tokens_generated_since_last_run": 20,
    "tokens_available_since_last_run": 15,
    "created_at": "2025-10-20T14:30:00Z"
  }
]

Authorizations

โ€‹
Authorization
string
header
required

API Key authentication. Provide your token in the 'Authorization' header. Example: Authorization: Bearer <YOUR_TOKEN>

Path Parameters

โ€‹
instanceId
string<uuid>
required

The unique identifier for the captive portal instance.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

Response

A list of coupon schedules.

โ€‹
id
string<uuid>

The unique identifier for the coupon schedule.

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

โ€‹
name
string

A human-readable name for the schedule.

Example:

"Daily Guest Passes"

โ€‹
instance_id
string<uuid>

The ID of the instance this schedule belongs to.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

โ€‹
count
integer

The number of coupons to generate each time the schedule runs.

Example:

20

โ€‹
recurrence_type
enum<string>

How often the schedule should run.

Available options:
daily,
weekly,
monthly
Example:

"daily"

โ€‹
day_of_week
integer | null

Required for 'weekly' recurrence. The day of the week to run (0=Sunday, 6=Saturday).

Example:

1

โ€‹
day_of_month
integer | null

Required for 'monthly' recurrence. The day of the month to run (1-31).

Example:

15

โ€‹
valid_for_in_minutes
integer

The number of minutes each generated coupon will be valid for after its creation.

Example:

480

โ€‹
timezone
string

The timezone in which the schedule should be evaluated (e.g., 'America/New_York').

Example:

"Australia/Sydney"

โ€‹
notification_group_id
string

The ID of a notification group to receive the generated coupons.

Example:

"ng_a1b2c3d4e5f6"

โ€‹
last_run_at
string<date-time> | null

The timestamp of the last time this schedule was successfully run.

Example:

"2025-10-29T08:00:00Z"

โ€‹
next_run_at
string<date-time> | null

The calculated timestamp of the next scheduled run.

Example:

"2025-10-30T08:00:00Z"

โ€‹
tokens_used_since_last_run
integer

The number of coupons from the last run that have been redeemed.

Example:

5

โ€‹
tokens_generated_since_last_run
integer

The total number of coupons generated in the last run.

Example:

20

โ€‹
tokens_available_since_last_run
integer

The number of valid, unredeemed coupons remaining from the last run.

Example:

15

โ€‹
created_at
string<date-time>

The timestamp when the schedule was created.

Example:

"2025-10-20T14:30:00Z"