Actions96
- Addon Actions
- Analytics Actions
- API Key Actions
- Audit Log Actions
- Invite Actions
- License Actions
- Plan Actions
- Portal Seat Actions
- Product Actions
- Public License Actions
- Release Actions
- Release Feed Actions
- Setting Actions
- Signing Key Actions
- System Actions
- Team Actions
- User Actions
- Webhook Actions
License → Suspend
AI-generatedSummary
Suspend an existing license by its unique ID via the Keygate admin API, optionally specifying related product and plan IDs and merging additional JSON fields into the request body.
Inputs
- ID (required) — The unique identifier of the license to suspend.
- Product Name or ID — Optionally select the product related to the license from a loaded list or specify an ID using an expression.
- Plan Name or ID — Optionally select the plan related to the license from a loaded list or specify an ID using an expression.
- JSON Input — Additional JSON fields to merge into the request body for this operation.
- Response Mode — Choose between receiving a simplified, compact response or the raw full response from the API.
Output shape
a single record representing the suspended license's details
The output returns the license data after suspension. If 'Response Mode' is set to 'simplified', the output includes a subset of relevant fields; if set to 'raw', the full API response is returned. Errors during execution return a structured error if 'Continue on Fail' is enabled, or throw otherwise.
Examples
Example 1: Suspend a license
Provide the license 'ID' to suspend, optionally define 'Product Name or ID' and 'Plan Name or ID' to scope the operation, and execute the suspend operation to update the license status.