Redeem credit coupon

veryfront__redeem_credit_coupon

Requires account.billing.manage.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
codestringYesProvide the code. Minimum length: 1. Maximum length: 100.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__redeem_credit_coupon",
    "arguments": {
      "code": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
statusstringYesCoupon redemption result. A replay of a redeemed code returns already_redeemed. Values: "redeemed", "already_redeemed".
credits_grantedintegerYesThe credits granted returned by the tool. Minimum: 0.
balanceobjectYesStructured balance details returned by the tool.
transaction_idstring or nullYesThe transaction id returned by the tool.

Full schemas

json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Provide the code."
    }
  },
  "required": [
    "code"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the redeem_credit_coupon tool."
}
json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "redeemed",
        "already_redeemed"
      ],
      "description": "Coupon redemption result. A replay of a redeemed code returns `already_redeemed`."
    },
    "credits_granted": {
      "type": "integer",
      "minimum": 0,
      "description": "The credits granted returned by the tool."
    },
    "balance": {
      "type": "object",
      "properties": {
        "tier": {
          "type": "number",
          "description": "The tier returned by the tool."
        },
        "purchased": {
          "type": "number",
          "description": "The purchased returned by the tool."
        },
        "total": {
          "type": "number",
          "description": "The total returned by the tool."
        }
      },
      "required": [
        "tier",
        "purchased",
        "total"
      ],
      "additionalProperties": false,
      "description": "Structured balance details returned by the tool."
    },
    "transaction_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The transaction id returned by the tool."
    }
  },
  "required": [
    "status",
    "credits_granted",
    "balance",
    "transaction_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the redeem_credit_coupon tool."
}