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

# Create a refill configuration.



## OpenAPI

````yaml /openapi/ledgerup-engine.json post /v2/refill-configurations
openapi: 3.1.0
info:
  title: LedgerUp API
  version: 0.1.0
  description: OpenAPI contract for the LedgerUp API.
servers: []
security: []
tags:
  - name: Health
  - name: Customers
  - name: Accounts
  - name: Grants
  - name: Currencies
    description: Currencies discovered from reported usage events.
  - name: Metrics
  - name: Refill Configurations
    description: Automatic balance refill thresholds and targets for an account and metric.
  - name: Events
    description: >-
      Individual usage events reported against an account and either a metric or
      currency.
  - name: Test
    description: Endpoints for test environment maintenance.
  - name: Products
    x-group: Billing
    description: Sellable catalog objects. Products can map to Stripe products.
  - name: Prices
    x-group: Billing
    description: >-
      Simple commercial terms for a product. Contract lines can reference a
      price or a rate card, but not both.
  - name: Rate Cards
    x-group: Billing
    description: Reusable rating policies that convert engine facts into billable amounts.
  - name: Contracts
    x-group: Billing
    description: >-
      Subscription-like commercial agreements. Contracts own contract lines and
      cancellation state.
  - name: Invoice Preview
    x-group: Billing
    description: Read-only preview of LedgerUp invoice lines before any Stripe write.
paths:
  /v2/refill-configurations:
    post:
      tags:
        - Refill Configurations
      summary: Create a refill configuration.
      operationId: createRefillConfiguration
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefillConfigurationRequest'
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefillConfiguration'
        '400':
          $ref: '#/components/responses/BadRequestText'
        '401':
          $ref: '#/components/responses/UnauthorizedText'
        '403':
          $ref: '#/components/responses/ForbiddenText'
        '408':
          $ref: '#/components/responses/RequestTimeoutText'
        '409':
          $ref: '#/components/responses/ConflictText'
        '413':
          $ref: '#/components/responses/PayloadTooLargeText'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeText'
        '422':
          $ref: '#/components/responses/UnprocessableText'
        '429':
          $ref: '#/components/responses/RateLimitedText'
        '500':
          $ref: '#/components/responses/InternalServerErrorText'
      security:
        - LedgerUpApiKey: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        description: >-
          Non-empty idempotency key for deduplicating write requests on the same
          route.
        example: 6f31c20e-725c-4be8-96f4-835042f67602
      description: >-
        Optional. Duplicate keys within the same company namespace and route
        return 409.
  schemas:
    RefillConfigurationRequest:
      type: object
      additionalProperties: false
      properties:
        account_id:
          type: string
          description: LedgerUp account identifier.
          example: account_0194f4e3a2b77c6aa91c4f6b4db2a980
          pattern: ^account_[0-9a-f]{32}$
        metric_id:
          type: string
          description: LedgerUp metric identifier.
          example: metric_0194f4e3a2b77c6aa91c4f6b4db2a980
          pattern: ^metric_[0-9a-f]{32}$
        minimum_balance:
          type: string
          description: Decimal balance serialized as a string.
          example: '100.0'
          pattern: ^-?\d+(\.\d+)?$
        target_balance:
          type: string
          description: Decimal balance serialized as a string.
          example: '100.0'
          pattern: ^-?\d+(\.\d+)?$
        is_active:
          type: boolean
          description: Whether automatic refills are enabled.
          example: true
      required:
        - account_id
        - metric_id
        - minimum_balance
        - target_balance
        - is_active
      description: >-
        Create-refill-configuration request. target_balance must be greater than
        minimum_balance. Unknown JSON fields are rejected.
    RefillConfiguration:
      type: object
      additionalProperties: false
      properties:
        account_id:
          type: string
          description: LedgerUp account identifier.
          example: account_0194f4e3a2b77c6aa91c4f6b4db2a980
          pattern: ^account_[0-9a-f]{32}$
        metric_id:
          type: string
          description: LedgerUp metric identifier.
          example: metric_0194f4e3a2b77c6aa91c4f6b4db2a980
          pattern: ^metric_[0-9a-f]{32}$
        minimum_balance:
          type: string
          description: Decimal balance serialized as a string.
          example: '100.0'
          pattern: ^-?\d+(\.\d+)?$
        target_balance:
          type: string
          description: Decimal balance serialized as a string.
          example: '100.0'
          pattern: ^-?\d+(\.\d+)?$
        is_active:
          type: boolean
          description: Whether automatic refills are enabled.
          example: true
        created_at:
          $ref: '#/components/schemas/UnixTimestamp'
        updated_at:
          $ref: '#/components/schemas/UnixTimestamp'
      required:
        - account_id
        - metric_id
        - minimum_balance
        - target_balance
        - is_active
        - created_at
        - updated_at
    UnixTimestamp:
      type: integer
      format: int64
      description: Unix timestamp in seconds.
      example: 1767225600
  responses:
    BadRequestText:
      description: >-
        Bad request, invalid header, invalid amount/quantity/currency, or text
        validation failure.
      content:
        text/plain:
          schema:
            type: string
    UnauthorizedText:
      description: Missing or invalid API key.
      content:
        text/plain:
          schema:
            type: string
            example: Invalid API key
    ForbiddenText:
      description: >-
        API key lacks the required permission, or reset was attempted outside
        the test namespace.
      content:
        text/plain:
          schema:
            type: string
    RequestTimeoutText:
      description: Request exceeded the 30 second timeout.
      content:
        text/plain:
          schema:
            type: string
    ConflictText:
      description: Duplicate idempotency key, uniqueness conflict, or foreign-key conflict.
      content:
        text/plain:
          schema:
            type: string
    PayloadTooLargeText:
      description: Request body exceeded the 256 KiB limit.
      content:
        text/plain:
          schema:
            type: string
    UnsupportedMediaTypeText:
      description: Write request content type was not application/json.
      content:
        text/plain:
          schema:
            type: string
    UnprocessableText:
      description: >-
        Semantically invalid request, such as a service period with start
        greater than end.
      content:
        text/plain:
          schema:
            type: string
    RateLimitedText:
      description: Rate limit exceeded.
      content:
        text/plain:
          schema:
            type: string
            example: rate limit exceeded
    InternalServerErrorText:
      description: Internal server error or queue failure.
      content:
        text/plain:
          schema:
            type: string
  securitySchemes:
    LedgerUpApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: LedgerUp API Key.
      x-displayName: LedgerUp API Key

````