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

# Apply a subscription discount in place

> Give a subscription 1–99 percent off its next 1–24 rebills, or every rebill with rebills: null. A trial-end charge counts as rebill 1. No charge occurs now. With retentionOfferId (1–100 characters), source is retention; otherwise source is manual. replaceRunning defaults to false: a running discount answers 409. With true, the old row ends as replaced and the new one starts. Supports Idempotency-Key. An unknown subscription or one of another account answers 404; a store without Subscriptions V3 answers 412 because its rebill does not read discounts; a canceled subscription answers 409. An open renewal charge answers 409 (RENEWAL_IN_PROGRESS); retry after it settles.



## OpenAPI

````yaml /openapi.json post /api/public/v1/subscriptions/apply-discount
openapi: 3.0.3
info:
  title: TagadaPay API
  description: >-

    # TagadaPay API Documentation


    Welcome to the TagadaPay API. This REST API lets you process payments,
    manage subscriptions, handle customers, deploy plugins, and orchestrate
    checkout funnels — all programmatically.


    ## Authentication


    Authenticate every request with a Bearer token. Get your API key from the
    [TagadaPay Dashboard](https://app.tagada.io).


    ```

    Authorization: Bearer your-api-key

    ```


    All requests must be made over HTTPS with `Content-Type: application/json`.


    ## Rate Limits


    | Plan | Requests/min | Burst |

    |------|-------------|-------|

    | Standard | 100 | 150 |

    | Premium | 500 | 750 |


    Exceeding the limit returns `429 Too Many Requests`.


    ## Errors


    | Code | Meaning |

    |------|---------|

    | 400 | Bad request — invalid parameters |

    | 401 | Unauthorized — missing or invalid API key |

    | 403 | Forbidden — insufficient permissions |

    | 404 | Not found |

    | 409 | Conflict |

    | 429 | Rate limited |

    | 500 | Server error |


    ## Support


    - Email: api-support@tagada.io

    - Docs: [docs.tagadapay.com](https://docs.tagadapay.com)
        
  version: 1.0.0
servers:
  - url: https://api.tagada.io/
    description: Production
  - url: https://api.tagada.dev/
    description: Sandbox / Development
security:
  - bearerAuth: []
tags:
  - name: auth
    description: Test your API key and verify authentication.
  - name: stores
    description: Create and manage stores within your account.
  - name: products
    description: Create products with variants, prices, and currency options.
  - name: customers
    description: Manage customer records, addresses, and payment instruments.
  - name: orders
    description: List and retrieve orders with line items, payments, and metadata.
  - name: payments
    description: Process, list, refund, void, and dispute payments.
  - name: subscriptions
    description: >-
      Create and manage recurring subscriptions — billing, cancellation,
      rebilling, and processor changes.
  - name: payment-flows
    description: Configure payment routing strategies with cascading processor fallbacks.
  - name: payment-instruments
    description: >-
      Manage stored payment methods — cards, bank accounts, and tokenized
      instruments.
  - name: processors
    description: List connected payment processors (Stripe, NMI, Checkout.com, etc.).
  - name: promotions
    description: Create and manage discount promotions with rules and conditions.
  - name: promotion-codes
    description: Generate and manage reusable promotion/coupon codes.
  - name: block-rules
    description: >-
      Configure fraud prevention rules to block transactions by IP, email, card
      BIN, country, etc.
  - name: webhooks
    description: Register webhook endpoints to receive real-time event notifications.
  - name: events
    description: Query application events, statistics, and audit logs.
  - name: domains
    description: Add, verify, and manage custom domains for your checkout and funnels.
  - name: funnels
    description: >-
      Create and manage checkout funnels with routing, A/B testing, and CDN
      deployment.
  - name: funnel-sessions
    description: Retrieve funnel session data for analytics and debugging.
  - name: funnel-tracking
    description: Track funnel step events for conversion analytics.
  - name: plugins
    description: Deploy, manage, and configure checkout plugins.
  - name: plugins-v2
    description: >-
      V2 plugin system — deploy, mount, split-test, fork, promote, and manage
      plugin instances.
  - name: checkout
    description: >-
      Initialize checkout sessions and process payments through the hosted
      checkout.
  - name: 3ds
    description: >-
      3D Secure authentication — create sessions, authenticate, and handle
      challenges.
  - name: builder
    description: Generate and validate builder session tokens for the visual page editor.
  - name: health
    description: API health check endpoint.
paths:
  /api/public/v1/subscriptions/apply-discount:
    post:
      tags:
        - subscriptions
      summary: Apply a subscription discount in place
      description: >-
        Give a subscription 1–99 percent off its next 1–24 rebills, or every
        rebill with rebills: null. A trial-end charge counts as rebill 1. No
        charge occurs now. With retentionOfferId (1–100 characters), source is
        retention; otherwise source is manual. replaceRunning defaults to false:
        a running discount answers 409. With true, the old row ends as replaced
        and the new one starts. Supports Idempotency-Key. An unknown
        subscription or one of another account answers 404; a store without
        Subscriptions V3 answers 412 because its rebill does not read discounts;
        a canceled subscription answers 409. An open renewal charge answers 409
        (RENEWAL_IN_PROGRESS); retry after it settles.
      operationId: post-api-public-v1-subscriptions-apply-discount
      parameters:
        - name: Idempotency-Key
          in: header
          schema:
            type: string
          description: >-
            Reuse the same key and body to replay the original response after a
            lost response.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subscriptionId:
                  type: string
                  minLength: 1
                percent:
                  type: integer
                  minimum: 1
                  maximum: 99
                rebills:
                  type: integer
                  minimum: 1
                  maximum: 24
                  nullable: true
                retentionOfferId:
                  type: string
                  minLength: 1
                  maxLength: 100
                replaceRunning:
                  type: boolean
                  default: false
              required:
                - subscriptionId
                - percent
                - rebills
              additionalProperties: false
            examples:
              nextRebill:
                summary: Half off the next charge, replacing any running offer
                value:
                  subscriptionId: sub_123
                  percent: 50
                  rebills: 1
                  retentionOfferId: nextmonth_50off
                  replaceRunning: true
              lifetime:
                summary: Half off every rebill
                value:
                  subscriptionId: sub_123
                  percent: 50
                  rebills: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscriptionId:
                    type: string
                  discount:
                    type: object
                    properties:
                      id:
                        type: string
                      percent:
                        type: number
                      rebillsLeft:
                        type: number
                        nullable: true
                      rebillsGranted:
                        type: number
                        nullable: true
                      rebillsUsed:
                        type: number
                        nullable: true
                      source:
                        type: string
                        enum:
                          - retention
                          - manual
                      addedBy:
                        type: object
                        properties:
                          name:
                            type: string
                            nullable: true
                          email:
                            type: string
                            nullable: true
                        required:
                          - name
                          - email
                        additionalProperties: false
                        nullable: true
                      createdAt:
                        type: string
                        format: date-time
                      endedAt:
                        type: string
                        format: date-time
                        nullable: true
                      endReason:
                        type: string
                        enum:
                          - exhausted
                          - replaced
                          - removed
                          - subscription_canceled
                        nullable: true
                    required:
                      - id
                      - percent
                      - rebillsLeft
                      - rebillsGranted
                      - rebillsUsed
                      - source
                      - addedBy
                      - createdAt
                      - endedAt
                      - endReason
                    additionalProperties: false
                required:
                  - subscriptionId
                  - discount
                additionalProperties: false
              examples:
                success:
                  summary: The running discount
                  value:
                    subscriptionId: sub_123
                    discount:
                      id: sdisc_123
                      percent: 50
                      rebillsLeft: 1
                      rebillsGranted: 1
                      rebillsUsed: 0
                      source: retention
                      addedBy: null
                      createdAt: '2026-10-30T10:30:00.000Z'
                      endedAt: null
                      endReason: null
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth: []
components:
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                    - message
                  additionalProperties: false
            required:
              - message
              - code
            additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Enter your API key as: `Bearer your-api-key`'

````

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