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

# Cancelar uma assinatura

Use este endpoint para cancelar uma assinatura existente. Essa ação impedirá quaisquer pagamentos recorrentes futuros associados à assinatura.

**Observações importantes:**

* O cancelamento pode não resultar em reembolso pelo período de assinatura restante. Consulte os termos da sua assinatura para obter detalhes sobre reembolsos.
* Certifique-se de cancelar a assinatura antes da próxima data de faturamento para evitar cobranças indesejadas.
* Você pode usar o endpoint [Obter Status da Assinatura](https://docs.localpayment.com/pt-br/reference/transaction-status-error-codes) para verificar o cancelamento.

Este endpoint exige um `subscriptionId` válido. Uma vez cancelada, a assinatura não pode ser reativada. Você precisará criar uma nova assinatura para reativar o serviço.


## OpenAPI

````yaml openapi/pt-br/localpayment.json PATCH /api/payin/subscriptions/{subscriptionId}/status
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/payin/subscriptions/{subscriptionId}/status:
    patch:
      summary: Cancelar uma assinatura
      operationId: cancel-subscription
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
        - name: subscriptionId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  const: CANCEL
                  description: Alterar o status para `CANCELLED`.
              required:
                - status
              x-examples:
                Example 1:
                  status: CANCELLED
            examples:
              CANCELLED:
                value:
                  status: CANCELLED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: >-
                      Um identificador único gerado pelo seu sistema para
                      rastrear a transação (alfanumérico e com hífens).
                      Recomendamos o uso do UUID4 para garantir a unicidade.
                  subscriptionId:
                    type: string
                    description: Identificador único para a assinatura.
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                  totalPayments:
                    type: integer
                    description: Número total de pagamentos associados à assinatura.
                  pendingPayments:
                    type: integer
                    description: >-
                      Número de pagamentos ainda pendentes referentes à
                      assinatura.
                  creationDate:
                    type: string
                    description: >-
                      Data e hora em que a assinatura foi criada. O formato deve
                      seguir uma sequência de data e hora válida (por exemplo,
                      ISO 8601).
                  payments:
                    type: array
                    description: >-
                      Conjunto de objetos representando os pagamentos associados
                      à assinatura.
                    items:
                      type: object
                  retries:
                    type: integer
                    description: >-
                      Número de tentativas de reenvio realizadas para processar
                      os pagamentos da assinatura.
                x-examples:
                  Example 1:
                    externalId: '1623451995'
                    subscriptionId: 498e4a08-13a8-405e-96a5-eccb44345ada
                    status:
                      code: '903'
                      description: CANCELLED
                      detail: The subscription was canceled - merchant request
                    totalPayments: 2
                    pendingPayments: 2
                    creationDate: '2021-06-11T22:53:15.622+00:00'
                    payments: []
                    retries: 0
              examples:
                903 - The subscription was canceled:
                  value:
                    externalId: '1623451995'
                    subscriptionId: 498e4a08-13a8-405e-96a5-eccb44345ada
                    status:
                      code: '903'
                      description: CANCELLED
                      detail: The subscription was canceled - merchant request
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                x-examples:
                  Example 1:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
              examples:
                400 - Invalid operation:
                  value:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
        '404':
          description: Não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                x-examples:
                  Example 1:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Subscription not found
              examples:
                404 - Subscription not found:
                  value:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Subscription not found
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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