curl --request DELETE \
--url https://api.gigstack.io/v2/retentions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"motive": "02"
}'{
"message": "Retention canceled successfully",
"data": {
"id": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"uuid": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"status": "canceled",
"document_type": "retenciones",
"retention_key": "26",
"cancellation": {
"motive": "02",
"canceled_at": "2026-03-06T12:00:00.000Z"
}
},
"success": true,
"timestamp": 1767225600000
}Cancel retention
Cancel a stamped tax retention document with the SAT.
Cancellation motives (SAT catalog):
01- Comprobante emitido con errores con relación02- Comprobante emitido con errores sin relación03- No se llevó a cabo la operación04- Operación nominativa relacionada en una factura global
gigstack Connect: Cancel other teams’ retentions using the team parameter.
curl --request DELETE \
--url https://api.gigstack.io/v2/retentions/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"motive": "02"
}'{
"message": "Retention canceled successfully",
"data": {
"id": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"uuid": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"status": "canceled",
"document_type": "retenciones",
"retention_key": "26",
"cancellation": {
"motive": "02",
"canceled_at": "2026-03-06T12:00:00.000Z"
}
},
"success": true,
"timestamp": 1767225600000
}Authorizations
Authentication Method: HTTP Bearer token.
The runtime requires the literal Bearer prefix — a bare token in the
Authorization header is rejected with 401 unauthorized.
Header Format: Authorization: Bearer YOUR_API_KEY
Your API key is a JWT. Live keys operate on live data (livemode: true);
test keys operate on isolated test data (livemode: false).
Get your key at: app.gigstack.pro/settings?tab=api
Errors: credential failures are answered by the authentication layer with a raw
{ "message": … } body, not the standardized envelope — 401 for a missing, malformed or
expired token, 403 for a revoked key or a plan without API access. See the Unauthorized
and AuthForbidden responses.
Path Parameters
Retention UUID
Query Parameters
gigstack Connect: Target team ID for multi-team access.
Requires gigstack Connect enabled on your team and shared billing account.
Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a
team other than the one your API key belongs to return 403 without it.
Only API keys can use it: an OAuth access token sent with another team's id is rejected with
403 Team mismatch with OAuth token.
Optional — omit it entirely unless you are acting on another team. It deliberately
carries no example value so generated snippets do not emit ?team=undefined; when the
parameter is absent, the team is derived from your API key.
Example: ?team=team_xyz789
Body
Response
Retention canceled successfully
Standardized success envelope emitted by sendSuccessResponse.
true true
The operation payload.
Server time in epoch milliseconds (Luxon.now().toMillis()).
1767225600000
Human-readable summary. Present only when the handler supplies one.
"Operation completed successfully"