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

# Issue a credit to a subscriber

> 🚧 **Under development.** Not available today.

Issue a customer credit balance that will be applied to future charges. Use for CS goodwill, refund-in-kind, or motion save offers.




## OpenAPI

````yaml /api-reference/openapi.yaml post /subscribers/{subscriberId}/credit
openapi: 3.1.0
info:
  title: Recurr API
  version: 1.0.0
  description: >
    Recurr's webhook event API. Subscription, payment, motion, and ticket

    events delivered as signed HTTP POSTs to your registered endpoints.


    See the [Overview](/api-reference/overview) for delivery model, HMAC

    authentication, idempotency, retry policy, and schema versioning.


    REST endpoints (Replay, Destination management) are documented as

    `paths` for completeness but are roadmap. See
    [Replay](/api-reference/replay)

    and [Destinations](/api-reference/destinations) for status.
  contact:
    email: hello@recurr.dev
    url: https://recurr.dev
  license:
    name: Proprietary
servers:
  - url: https://api.recurr.dev/v1
    description: Production (roadmap)
security:
  - BearerAuth: []
tags:
  - name: Subscribers
    description: Read subscriber state, history, and tags. Update metadata.
  - name: Subscriptions
    description: Subscription state + admin overrides (pause, resume, cancel, plan change).
  - name: Events
    description: Query historical webhook events for audit + debugging.
  - name: Cohorts
    description: >-
      Manage cohort definitions + view members. Used by Recurr motions for
      targeting.
  - name: Motions
    description: Inspect motion performance + manually trigger for specific subscribers.
  - name: Metrics
    description: Aggregate metrics — MRR, churn, recovery, cohort retention.
  - name: Payments
    description: Charge detail + refund / customer-credit operations.
  - name: Tickets
    description: Read subscriber-submitted billing tickets.
  - name: Replay
    description: Re-send historical webhook events to a destination.
  - name: Destinations
    description: Manage webhook delivery endpoints.
paths:
  /subscribers/{subscriberId}/credit:
    post:
      tags:
        - Payments
      summary: Issue a credit to a subscriber
      description: >
        🚧 **Under development.** Not available today.


        Issue a customer credit balance that will be applied to future charges.
        Use for CS goodwill, refund-in-kind, or motion save offers.
      operationId: issueSubscriberCredit
      parameters:
        - $ref: '#/components/parameters/SubscriberId'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditIssue'
      responses:
        '201':
          description: Credit issued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credit'
      security:
        - BearerAuth: []
components:
  parameters:
    SubscriberId:
      name: subscriberId
      in: path
      required: true
      schema:
        type: string
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >
        Idempotency key for safe retries on write operations. Pass a unique key
        per logical request;

        Recurr returns the original response for duplicate keys within a 24-hour
        window.
      schema:
        type: string
        maxLength: 255
  schemas:
    CreditIssue:
      type: object
      required:
        - amount
        - currency
        - reason
      properties:
        amount:
          type: integer
          description: Credit amount in smallest currency unit.
        currency:
          type: string
          example: USD
        reason:
          type: string
          enum:
            - goodwill
            - refund_in_kind
            - save_offer
            - manual
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: Optional expiry; null = no expiry.
    Credit:
      type: object
      required:
        - id
        - subscriber_id
        - amount
        - currency
        - balance
        - created_at
      properties:
        id:
          type: string
          example: cred_01HQX...
        subscriber_id:
          type: string
        amount:
          type: integer
          description: Original credit amount issued.
        balance:
          type: integer
          description: Current unused balance.
        currency:
          type: string
        reason:
          type: string
        expires_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rk_live_… / rk_test_…
      description: |
        Your Recurr **secret API key** as a Bearer token:
        `Authorization: Bearer rk_live_…`.

        Keys are **environment-scoped** — `rk_live_` operates on live data,
        `rk_test_` on isolated test data (see
        [Test mode](/api-reference/test-mode)). Create, scope, and rotate keys
        in your dashboard (**Settings → API keys**, `developer` role). Secret
        keys are server-side only — never ship them in an app binary or client
        JavaScript.

````