Keygate icon

Keygate

Work with Keygate admin, portal, public license, and release APIs

License → Refund

AI-generated

Summary

Refund an existing license by its ID using Keygate's admin API, optionally specifying related product and plan IDs along with additional request body data.

Inputs

  • ID (required) — The unique identifier of the license to refund.
  • Product Name or ID — Optionally specify the product associated with the license either by selecting from the list or using an expression.
  • Plan Name or ID — Optionally specify the plan associated with the license either by selecting from the list or using an expression.
  • JSON Input — Additional JSON fields to merge into the request body for customizing the refund operation.
  • Response Mode — Choose between 'simplified' output optimized for easier consumption or 'raw' full API response format.

Output shape

a single object

Returns the API response from the refund request as either a simplified object containing key license properties or the raw full response, depending on the 'Response Mode' setting.

Examples

Example 1: Refund a license with ID 'lic-12345' for product 'prod-abc' and plan 'plan-xyz'

Set 'ID' to 'lic-12345', 'Product Name or ID' to 'prod-abc', 'Plan Name or ID' to 'plan-xyz', and choose 'Response Mode' as desired.

Links

Discussion