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

# Redeem Credits

> Consumes credits from a plan account after processing a request.



## OpenAPI

````yaml POST /protocol/plans/redeem
openapi: 3.1.0
info:
  title: Nevermined API
  description: >-
    API for managing AI agents, payment plans, and x402 payments in the
    Nevermined ecosystem.


    ## Prerequisites


    You need a Nevermined API Key to authenticate. Get one at
    [nevermined.app](https://nevermined.app) under **Settings > API Keys**.


    See the [5-Minute Setup Guide](/docs/integrate/quickstart/5-minute-setup)
    for detailed instructions.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.sandbox.nevermined.app/api/v1
    description: Sandbox (Testing) - Base Sepolia
  - url: https://api.live.nevermined.app/api/v1
    description: Live (Production) - Base Mainnet
security:
  - bearerAuth: []
tags:
  - name: Protocol - Agents
    description: Endpoints for registering and managing AI agents
  - name: Protocol - Plans
    description: Endpoints for creating and managing payment plans
  - name: Protocol - Credits
    description: Endpoints for minting and redeeming credits
  - name: Protocol - Access
    description: Endpoints for access tokens and request validation
  - name: X402 - Permissions
    description: Endpoints for x402 delegated permissions
paths:
  /protocol/plans/redeem:
    post:
      tags:
        - Protocol - Credits
      summary: Redeem Credits
      description: Consumes credits from a plan account after processing a request.
      operationId: redeemCredits
      requestBody:
        description: Redeem request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedeemCreditsRequest'
            example:
              planId: did:nv:abc123...
              holderAddress: 0xUserAddress
              amount: 5
              proof: 0xSignatureProof...
      responses:
        '200':
          description: Credits redeemed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedeemCreditsResponse'
        '401':
          description: Unauthorized
        '402':
          description: Insufficient credits
components:
  schemas:
    RedeemCreditsRequest:
      type: object
      required:
        - planId
        - holderAddress
        - amount
        - proof
      properties:
        planId:
          type: string
        holderAddress:
          type: string
        amount:
          type: integer
        proof:
          type: string
    RedeemCreditsResponse:
      type: object
      properties:
        success:
          type: boolean
        creditsRedeemed:
          type: integer
        remainingBalance:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Nevermined API Key (starts with 'nvm:'). Get one at
        [nevermined.app](https://nevermined.app) under **Settings > API Keys**.

````