Extend Pass Grant

POST /v1/nextexams/passes/grants/{id}/extend

Extend a pass

Adds time from the LATER of now and the pass's current end, so a renewal bought before the end stacks onto it. An expired pass becomes active again; a pass with no end is returned unchanged. Scope passes:write; the role needs passes.grant.

Request

POST https://your-site.example/api/index.php/v1/nextexams/passes/grants/{id}/extend

Parameters

Name	Type	In	Required	Description
`id`	`integer`	`path`	Yes	The record's id. (min 1)

Request body

Content type: application/json

Field	Type	Required	Description
`seconds`	`integer`	No	How long to add. Absent = the plan's duration. (min 1, max 315360000)

{
    "seconds": 259200
}

Responses

`200` — The pass as it now stands.

{
    "data": {
        "id": 1,
        "user_id": 1,
        "user_name": "string",
        "user_email": "string",
        "plan_id": 1,
        "plan_title": "string",
        "source": "string",
        "source_ref": "string",
        "starts_at": "2026-01-01T12:00:00Z",
        "expires_at": "2026-01-01T12:00:00Z",
        "status": "active",
        "created": "2026-01-01T12:00:00Z"
    }
}

Field	Type	Meaning
`data.id`	`integer`
`data.user_id`	`integer`
`data.user_name`	`string\|null`
`data.user_email`	`string\|null`
`data.plan_id`	`integer`
`data.plan_title`	`string\|null`
`data.source`	`string`	`manual`, `api`, or `ext:<element>` for a pass an extension granted.
`data.source_ref`	`string\|null`	The caller's own reference, unique per source.
`data.starts_at`	`string\|null`	ISO 8601 in UTC, or null when not set. (date-time)
`data.expires_at`	`string\|null`	ISO 8601 in UTC, or null when not set. (date-time)
`data.status`	`string`	One of `active`, `expired`, `revoked`.
`data.created`	`string\|null`	ISO 8601 in UTC, or null when not set. (date-time)

Errors

Status	Code	When
`401`	`INVALID_TOKEN`	No token (`MISSING_TOKEN`), or one that is wrong, expired, revoked, or whose owner can no longer sign in (`INVALID_TOKEN`).
`403`	`MISSING_SCOPE`	The token is valid but this request is not allowed, and `code` says why: `MISSING_SCOPE` (the token lacks the scope), `FORBIDDEN` (the owner's role does not allow it), `ACCESS_DENIED` (the owner cannot manage Next Exams), `API_DISABLED` (the API Tokens app is off), `APP_DISABLED` (the feature's app is off — `meta.app` names it), `ACCOUNT_UNUSABLE` (the owner is blocked or must reset their password), `DEMO_LOCKED` (a demo site).
`404`	`NOT_FOUND`	No record has this id.
`422`		The request is well formed but would lose data (`OPTIONS_REQUIRED`).

Examples

curl

curl -s -X POST "https://your-site.example/api/index.php/v1/nextexams/passes/grants/1/extend" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"seconds":259200}'

PHP

<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nextexams/passes/grants/1/extend');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('API_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => '{"seconds":259200}',
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

JavaScript

const API_TOKEN = process.env.API_TOKEN;

const response = await fetch("https://your-site.example/api/index.php/v1/nextexams/passes/grants/1/extend", {
  method: 'POST',
  headers: {
    "Authorization": `Bearer ${API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "seconds": 259200
  }),
});
const data = await response.json();