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

# Cancelar assinatura

> Cancela uma assinatura.

Cancela uma assinatura. Use quando o cliente pede para parar de ser cobrado.

A assinatura fica `CANCELLED` com `cancellation_reason: USER_ACTION`. Faturas `open` passam a `void`.

Funciona em `TRIAL`, `PENDING`, `ACTIVE` ou `PAST_DUE`.

Se o cliente já cancelou, a API devolve o mesmo resultado. Se o cancelamento foi por falha de pagamento, responde `409`. Se o status não permitir cancelamento, responde `422`.

Erros comuns: `401`/`403` (credenciais ou produto Recorrência), `404` (não encontrada), `409` (já cancelada por falha de pagamento), `422` (status não permite cancelamento).


## OpenAPI

````yaml POST /v1/subscriptions/{subscriptionId}/cancel
openapi: 3.0.0
info:
  title: UvviPay Public API
  description: >-
    Endpoints públicos da plataforma UvviPay para integração de subcontas
    (submerchants).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.uvvipay.com.br
    description: Produção
  - url: https://api-staging.uvvipay.com.br
    description: Staging
security:
  - client-id: []
    client-secret: []
tags: []
paths:
  /v1/subscriptions/{subscriptionId}/cancel:
    post:
      tags:
        - Assinaturas
      summary: Cancelar assinatura
      description: Cancela uma assinatura.
      operationId: cancelSubscription
      parameters:
        - name: client-id
          in: header
          description: ID público da credencial do merchant
          required: true
          schema:
            type: string
        - name: client-secret
          in: header
          description: Secret da credencial do merchant
          required: true
          schema:
            type: string
        - name: subscriptionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Assinatura cancelada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelSubscriptionResponseDto'
        '401':
          description: Credenciais inválidas ou ausentes
        '403':
          description: Produto `recurrency` não habilitado para o merchant
        '404':
          description: Assinatura não encontrada
        '409':
          description: Já cancelada por falha de pagamento (ALREADY_CANCELLED)
        '422':
          description: Status da assinatura não permite cancelamento (INVALID_STATUS)
components:
  schemas:
    CancelSubscriptionResponseDto:
      type: object
      properties:
        subscription_id:
          type: string
          format: uuid
          description: Identificador da assinatura cancelada.
        subscription_status:
          type: string
          enum:
            - CANCELLED
          description: Status resultante (CANCELLED).
        cancellation_reason:
          type: string
          nullable: true
          example: USER_ACTION
        cancelled_at:
          type: string
          format: date-time
          nullable: true
          description: Data do cancelamento.
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````

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