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

# Cancel a recurring charge series



## OpenAPI

````yaml /openapi.json put /api/v1/recurring-charges/{id}/cancel
openapi: 3.0.0
info:
  title: Payable API
  description: >-
    REST API for integrating with Payable programmatically. Authenticate with
    Clerk JWT (web app) or API keys (`esk_live_` / `esk_test_`). Test keys
    operate in sandbox mode without wallet charges or real WhatsApp. Request
    bodies and query parameters are documented from class-validator /
    class-transformer DTOs. Every error is RFC 9457 `application/problem+json`;
    branch on `code`, not `detail`.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.payable.run
    description: Production
  - url: https://localhost:3000
    description: Local
security: []
tags: []
paths:
  /api/v1/recurring-charges/{id}/cancel:
    put:
      tags:
        - recurring-charges
      summary: Cancel a recurring charge series
      operationId: RecurringChargeController_cancel
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringChargeResponseDto'
        default:
          description: RFC 9457 problem details. Inspect `code` for programmatic handling.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - bearer: []
components:
  schemas:
    RecurringChargeResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        clientId:
          type: string
          format: uuid
        organizationId:
          type: string
          format: uuid
        productName:
          type: string
        amount:
          type: number
        frequency:
          type: string
          example: monthly
        dayOfMonth:
          type: number
        startDate:
          type: string
          example: '2026-03-15'
        endDate:
          type: object
          nullable: true
        maxOccurrences:
          type: object
          nullable: true
        occurrenceCount:
          type: number
        nextDueDate:
          type: string
        nextRunAt:
          type: string
        status:
          type: string
          enum:
            - active
            - paused
            - cancelled
            - completed
        createdAt:
          type: object
        updatedAt:
          type: object
      required:
        - id
        - clientId
        - organizationId
        - productName
        - amount
        - frequency
        - dayOfMonth
        - startDate
        - occurrenceCount
        - nextDueDate
        - nextRunAt
        - status
        - createdAt
        - updatedAt
    ProblemDetails:
      type: object
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - requestId
      properties:
        type:
          type: string
          format: uri
          example: https://docs.payable.run/errors/validation_error
        title:
          type: string
          example: Bad Request
        status:
          type: integer
          example: 400
        detail:
          type: string
          example: One or more request fields are invalid.
        instance:
          type: string
          example: /api/v1/clients
        code:
          type: string
          example: VALIDATION_ERROR
        requestId:
          type: string
          format: uuid
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              field:
                type: string
              message:
                type: string
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API Key or JWT
      type: http
      description: >-
        Use `Authorization: Bearer esk_live_...` or `esk_test_...` for API
        access

````

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