> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Redeem credit coupon

> Redeem a coupon code for credits on an account; returns the credits granted and the new balance, or already_redeemed for a code the account used before.

`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

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `code` | `string` | Yes | Provide 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](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "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.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `status` | `string` | Yes | Coupon redemption result. A replay of a redeemed code returns `already_redeemed`. Values: `"redeemed"`, `"already_redeemed"`. |
| `credits_granted` | `integer` | Yes | The credits granted returned by the tool. Minimum: `0`. |
| `balance` | `object` | Yes | Structured balance details returned by the tool. |
| `transaction_id` | `string or null` | Yes | The transaction id returned by the tool. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "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 title="output-schema.json" theme={null}
{
  "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."
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__redeem_credit_coupon` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run this tool with these arguments.

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.