> ## 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 una suscripción

Utiliza este endpoint para cancelar una suscripción existente. Esta acción impedirá cualquier pago recurrente futuro asociado a la suscripción.

**Notas importantes:**

* La cancelación podría no dar derecho a un reembolso por el período de suscripción restante. Consulta los términos de tu suscripción para obtener más información sobre reembolsos.
* Asegúrate de cancelar la suscripción antes de la próxima fecha de facturación para evitar cargos no deseados.
* Puedes utilizar el endpoint [Obtener estado de la suscripción](https://docs.localpayment.com/es/reference/transaction-status-error-codes) para verificar la cancelación.

Este endpoint requiere un `subscriptionId` válido. Una vez cancelada una suscripción, no se puede reactivar. Si deseas reactivar el servicio, deberás crear una nueva suscripción.


## OpenAPI

````yaml openapi/es/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 una suscripción
      operationId: cancel-subscription
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acceso Bearer para la autenticación. Este token se obtiene
            de los endpoints [Get Access Token](/es/reference/get-token) o
            [Refresh Access Token](/es/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: Cambiar el estado a `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: >-
                      Un identificador único generado por tu sistema para
                      rastrear la transacción (alfanumérico y con guiones).
                      Recomendamos usar UUID4 para garantizar su unicidad.
                  subscriptionId:
                    type: string
                    description: Identificador único para la suscripción.
                  status:
                    type: object
                    title: status
                    description: Estado de la operación.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          estado](/es/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descripción del
                          estado](/es/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Información de estado adicional.
                  totalPayments:
                    type: integer
                    description: Número total de pagos asociados a la suscripción.
                  pendingPayments:
                    type: integer
                    description: >-
                      Número de pagos que aún están pendientes de la
                      suscripción.
                  creationDate:
                    type: string
                    description: >-
                      Fecha y hora de creación de la suscripción. El formato
                      debe seguir una cadena de fecha y hora válida (por
                      ejemplo, ISO 8601).
                  payments:
                    type: array
                    description: >-
                      Conjunto de objetos que representan los pagos asociados a
                      la suscripción.
                    items:
                      type: object
                  retries:
                    type: integer
                    description: >-
                      Número de intentos de reintento realizados para procesar
                      los pagos de la suscripción.
                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: Solicitud incorrecta.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: status
                    description: Estado de la operación.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          estado](/es/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descripción del
                          estado](/es/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Información de estado adicional.
                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: No autorizado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Información adicional sobre la respuesta.
                  code:
                    type: string
                    description: Código de estado.
                  messages:
                    type: array
                    description: Lista de mensajes.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Clase de token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensaje con información adicional.
                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: No encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: status
                    description: Estado de la operación.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          estado](/es/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descripción del
                          estado](/es/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Información de estado adicional.
                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.