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

# Apply studio order refund

> Requires refunds:write. Explicit exact confirmation and financial revision required. Pre-syncs Stripe, rechecks role/grant/balance and uses existing refund request/approval/execution engine. Accepted is not succeeded. Retry the same key/preview after interruption. No provider cancellation.



## OpenAPI

````yaml https://api.batchrelay.com/openapi.json post /v1/studios/{studio_id}/refund-requests
openapi: 3.1.0
info:
  description: >-
    Provider-neutral print catalog and prepared-media validation. This document
    covers only routes owned by the Go service; it deliberately excludes
    migration-proxied order lifecycle routes and all provider payloads.
  license:
    name: Proprietary
    url: https://github.com/SENTINELITE/Batch-Relay-Go/blob/main/README.md
  title: Batch Relay API
  version: 1.0.1
servers:
  - url: https://api.batchrelay.com
security: []
tags:
  - description: >-
      Explicitly authorized purchaser context for studio order events. Event
      payloads remain free of contact details.
    name: Event context
  - description: Service health and the public API description.
    name: System
  - description: Test Mode session creation and API credential entry points.
    name: Authentication
  - description: >-
      Provider-neutral canonical catalog resources and platform-owned semantic
      definitions.
    name: Catalog
  - description: Studio-scoped guest checkout-link management.
    name: Checkout links
  - description: >-
      One-way operational event messages. Alert emails contain no message body
      and recipients read messages after Batch Relay authentication.
    name: Studio messages
  - description: >-
      Explicit, reviewable sandbox-to-Live promotion plans for forms, catalog,
      and storefront configuration.
    name: Sandbox promotions
  - description: Provider-neutral validation, quoting, and order lifecycle operations.
    name: Print orders
  - description: Managed fulfillment asset ingestion and metadata.
    name: Managed assets
  - description: Studio-scoped original asset upload sessions and objects.
    name: Studio assets
  - description: Prepared and confirmed event roster team changes.
    name: Event team changes
  - description: Authenticated studio, event, and form-management operations.
    name: Studio management
  - description: >-
      Authenticated studio retail catalog management. Draft and publication
      lifecycles are explicit per product or package.
    name: Studio catalog
  - description: >-
      Authenticated singular storefront assortment management. PATCH atomically
      publishes a new immutable assortment revision; no storefront draft
      lifecycle exists yet.
    name: Storefront
  - description: Managed media used by the studio retail catalog.
    name: Studio catalog assets
  - description: Template rendering job creation and retrieval.
    name: Template renders
  - description: >-
      Published browser-side template packages and short-lived server proof
      renders. Preview artifacts are never fulfillment artwork.
    name: Browser previews
  - description: API account and credential administration.
    name: API accounts
  - description: >-
      Standalone guest purchases; feature disabled by default. Temporary
      merchandise USD0.75 5x7 and USD1.50 8x10, plus authoritative shipping and
      tax.
    name: Consumer printing
paths:
  /v1/studios/{studio_id}/refund-requests:
    parameters:
      - $ref: '#/components/parameters/ClientSurface'
      - $ref: '#/components/parameters/ClientVersion'
      - $ref: '#/components/parameters/InvocationMode'
    post:
      tags:
        - Studio Operations
      summary: Apply studio order refund
      description: >-
        Requires refunds:write. Explicit exact confirmation and financial
        revision required. Pre-syncs Stripe, rechecks role/grant/balance and
        uses existing refund request/approval/execution engine. Accepted is not
        succeeded. Retry the same key/preview after interruption. No provider
        cancellation.
      operationId: applyStudioOrderRefund
      parameters:
        - $ref: '#/components/parameters/StudioDelegatedAuthorization'
        - description: Opaque public studio_id. Private Convex IDs are rejected.
          in: path
          name: studio_id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/StudioRefundIdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StudioRefundApplyRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioRefundRequest'
          description: Authoritative Studio result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioOperationsError'
          description: Invalid credential or expired/revoked delegated token
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioOperationsError'
          description: Wrong Studio, role, action scope or disabled Live effects
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioOperationsError'
          description: Resource unavailable in this Studio and lane
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioOperationsError'
          description: >-
            Stale resource, expired preview, dependency blocker or idempotency
            conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioOperationsError'
          description: Invalid typed request or unsupported query
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudioOperationsError'
          description: Required adapter or delegated verification is not configured
      security:
        - bearerAuth: []
components:
  parameters:
    ClientSurface:
      description: >-
        Untrusted optional analytics hint naming the calling client surface. It
        never affects authorization, routing, pricing, or behavior.
      in: header
      name: X-BatchRelay-Client-Surface
      required: false
      schema:
        maxLength: 100
        minLength: 1
        type: string
    ClientVersion:
      description: >-
        Untrusted optional analytics hint naming the calling client version. It
        never affects authorization, routing, pricing, or behavior.
      in: header
      name: X-BatchRelay-Client-Version
      required: false
      schema:
        maxLength: 100
        minLength: 1
        type: string
    InvocationMode:
      description: >-
        Untrusted optional analytics hint naming the invocation mode. It never
        affects authorization, routing, pricing, or behavior.
      in: header
      name: X-BatchRelay-Invocation-Mode
      required: false
      schema:
        maxLength: 100
        minLength: 1
        type: string
    StudioDelegatedAuthorization:
      description: >-
        Original delegated Clerk OAuth bearer. Go independently verifies
        signature/current revocation, exact resource audience, allowed OAuth
        client and action scope. Caller must match attributed API key creator.
        Never send an unverified subject header.
      in: header
      name: X-BatchRelay-Delegated-Authorization
      required: false
      schema:
        type: string
    StudioRefundIdempotencyKey:
      description: >-
        Durable exact refund preview/request identity. Repeat unchanged after
        interruption.
      in: header
      name: Idempotency-Key
      required: true
      schema:
        maxLength: 80
        minLength: 16
        pattern: ^[A-Za-z0-9_-]{16,80}$
        type: string
  schemas:
    StudioRefundApplyRequest:
      additionalProperties: false
      properties:
        confirmed:
          const: true
          type: boolean
        expected_financial_revision:
          type: string
        preview_id:
          type: string
      required:
        - preview_id
        - expected_financial_revision
        - confirmed
      type: object
    StudioRefundRequest:
      additionalProperties: false
      properties:
        amount_cents:
          format: int64
          type: integer
        blockers:
          items:
            type: string
          type: array
        created_at:
          format: int64
          type: integer
        currency:
          type: string
        customer_id:
          type: string
        environment:
          type: string
        execution_required:
          type: boolean
        id:
          type: string
        order_id:
          type: string
        preview_id:
          type: string
        simulated:
          type: boolean
        status:
          type: string
        studio_id:
          type: string
      required:
        - id
        - preview_id
        - order_id
        - customer_id
        - studio_id
        - environment
        - status
        - amount_cents
        - currency
        - blockers
        - created_at
        - simulated
        - execution_required
      type: object
    StudioOperationsError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: Batch Relay API key or anonymous session
      description: >-
        Batch Relay scoped API key or an anonymous Test Mode session. Scope
        names document required capabilities. Anonymous sessions are
        sandbox-only and do not authorize studio, event, billing, or Live Mode
        operations.
      scheme: bearer
      type: http

````

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