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

# Send invoice reminder

> Sends a payment reminder for an invoice through the requested channel.



## OpenAPI

````yaml /openapi.yaml post /v1/invoices/{id}/reminders
openapi: 3.0.3
info:
  title: Quentli REST API
  version: 1.0.0
  description: OpenAPI spec for Quentli REST endpoints.
servers:
  - url: https://api.quentli.com
    description: Production API
  - url: https://api.staging.quentli.com
    description: Staging API for production-like validation
  - url: https://api.demo.quentli.com
    description: Demo API hostname served by staging
security:
  - organizationApiKey: []
tags:
  - name: Auth
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
paths:
  /v1/invoices/{id}/reminders:
    post:
      tags:
        - Invoices
      summary: Send invoice reminder
      description: Sends a payment reminder for an invoice through the requested channel.
      operationId: invoices_send_reminder
      parameters:
        - schema:
            type: string
            description: Identifier of the invoice.
          required: true
          description: Identifier of the invoice.
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendPaymentReminderArgs'
      responses:
        '200':
          description: Invoice reminder sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendPaymentReminderPayload'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '404':
          description: Invoice not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
components:
  schemas:
    SendPaymentReminderArgs:
      type: object
      properties:
        input:
          type: object
          properties:
            channel:
              type: string
              enum:
                - EMAIL
                - SMS
                - WHATSAPP
              description: Channel used to send the reminder.
              example: WHATSAPP
          required:
            - channel
          additionalProperties: false
      required:
        - input
      additionalProperties: false
      description: >-
        Request body for sending a payment reminder (invoice id is provided in
        the URL path).
    SendPaymentReminderPayload:
      type: object
      properties:
        paymentReminder:
          $ref: '#/components/schemas/PaymentReminder'
      required:
        - paymentReminder
      description: Response after sending a payment reminder.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
    PaymentReminder:
      type: object
      nullable: true
      properties:
        id:
          type: string
          description: Unique identifier of the reminder.
          example: rem_1234567890abcdefghij
        createdAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the reminder was created.
        updatedAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
          description: When the reminder was last updated.
        scheduledAt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
            - nullable: true
          description: Scheduled sending time, if any.
          example: null
        invoiceId:
          type: string
          description: Invoice associated with this reminder.
          example: inv_1234567890abcdefghij
        authLinkId:
          type: string
          nullable: true
          description: Auth link included in this reminder.
          example: null
        type:
          type: string
          nullable: true
          enum:
            - NEAR_DUE
            - DUE
            - NEAR_OVERDUE
            - FAILED_ATTEMPT
            - CUSTOM
            - null
          description: Reminder type.
          example: DUE
        outboundMessageId:
          type: string
          nullable: true
          description: Outbound message identifier.
          example: null
        messageId:
          type: string
          nullable: true
          description: Conversation message identifier.
          example: null
        templateId:
          type: string
          nullable: true
          description: Message template identifier.
          example: null
        sentById:
          type: string
          nullable: true
          description: User that sent the reminder.
          example: null
      required:
        - id
        - createdAt
        - updatedAt
        - scheduledAt
        - invoiceId
        - authLinkId
        - type
        - outboundMessageId
        - messageId
        - templateId
        - sentById
      description: Payment reminder sent for an invoice.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'

````