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

# Redeem a voucher code

> Redeems a voucher for the user and returns the product granted by the voucher campaign.



## OpenAPI

````yaml reference/openapi.json POST /drive/v1/users/{userId}/vouchers/{code}/redeem
openapi: 3.1.0
info:
  title: Drive API
  version: 1.0.0
  description: >-
    The Drive API provides comprehensive access to Plugsurfing's charging
    infrastructure network. It enables you to manage users, charging keys,
    search for charging locations, handle payments, and control charging
    sessions.
servers:
  - url: https://{environment}.plugsurfing.com
    variables:
      environment:
        enum:
          - drive-api-stage
        default: drive-api-stage
        description: >-
          API environment - use drive-api-stage for testing and drive-api for
          production
security: []
tags:
  - name: Geosearch
    description: >-
      Search and retrieve detailed information about charging locations and
      stations
  - name: Users
    description: >-
      Manage user accounts including creation, retrieval, updates, and deletion.
      Handles user-specific data and preferences.
  - name: Charging Keys
    description: >-
      Manage physical and virtual charging keys including creation, activation,
      updates, and status management. Essential for user access to charging
      stations.
  - name: Sessions
    description: >-
      Access and manage charging session data including history, status, and
      detailed session information
  - name: Remote Charging
    description: >-
      Control charging sessions remotely including starting and stopping
      sessions, and monitoring session status
  - name: Payment Options
    description: >-
      Manage payment methods and handle transaction processing for charging
      services
  - name: User Groups
    description: Manage user group memberships
  - name: Vouchers
    description: Redeem vouchers
  - name: Charging Key Orders
    description: Handle the ordering and fulfillment process for physical charging keys
  - name: EMP Charging Keys
    description: E-Mobility Provider specific endpoints for managing charging keys
  - name: EMP Geosearch
    description: E-Mobility Provider specific endpoints for location search and information
  - name: EMP Orders
    description: E-Mobility Provider specific endpoints for managing orders
  - name: EMP Sessions
    description: E-Mobility Provider specific endpoints for managing charging sessions
  - name: EMP Fleets
    description: E-Mobility Provider specific endpoints for managing fleets
paths:
  /drive/v1/users/{userId}/vouchers/{code}/redeem:
    post:
      tags:
        - Vouchers
      summary: Redeem a voucher code
      description: >-
        Redeems a voucher for the user and returns the product granted by the
        voucher campaign.
      operationId: redeem
      parameters:
        - name: userId
          in: path
          description: userId
          example: driveUser1
          required: true
          schema:
            type: string
        - name: code
          in: path
          description: Voucher Code
          example: AABBCC11
          required: true
          schema:
            type: string
            pattern: ([a-zA-Z0-9_]+)
      responses:
        '200':
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
              example:
                type: PREPAID
                amountMinorUnits: 1050
                currencyCode: EUR
        '400':
          description: The campaign voucher code is expired, not started yet or exhausted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestErrorResponse'
              example:
                message: Invalid request payload
                details:
                  - field X is required
        '404':
          description: User or voucher not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Resource not found
        '409':
          description: The payment setup is not compatible with vouchers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Resource not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Resource not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Product:
      oneOf:
        - $ref: '#/components/schemas/PrepaidProduct'
        - $ref: '#/components/schemas/UserGroupProduct'
      discriminator:
        propertyName: type
    InvalidRequestErrorResponse:
      title: InvalidRequestErrorResponse
      type: object
      required:
        - message
        - fields
      properties:
        message:
          type: string
        fields:
          type: array
          items:
            title: InvalidField
            type: object
            required:
              - name
              - message
              - rejectedValue
            properties:
              name:
                type: string
              message:
                type: string
                example: UserId is not correct
              rejectedValue:
                type: string
    ErrorResponse:
      title: ErrorResponse
      type: object
      properties:
        message:
          type: string
    PrepaidProduct:
      type: object
      required:
        - type
        - amountMinorUnits
        - currencyCode
      properties:
        type:
          type: string
          enum:
            - PREPAID
        amountMinorUnits:
          type: integer
          format: int64
          description: >-
            Amount in currency minor units. In the example 10.5 Euro is
            represented as 1050.
          example: 1050
        currencyCode:
          type: string
          description: ISO 4217
          example: EUR
    UserGroupProduct:
      type: object
      required:
        - type
        - groupId
      properties:
        type:
          type: string
          enum:
            - USER_GROUP
          description: Type of user-group product.
        customerGroupId:
          type: integer
          description: Identifier of the customer group granted by the product.
      description: Voucher product that grants access to a user group.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````

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