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

# Calculate refund amount preview

> Calculates the refund amount that would be issued if a specific subscription order fulfillment were refunded. This provides a preview without actually processing the refund.

**What it calculates:**
- Total refund amount (order amount minus processing fees)
- Restocking fees (if applicable)
- Gateway fees that cannot be refunded
- Net refund amount customer will receive

**Use Cases:**
- Show customer how much they'll get back before confirming refund
- Display refund breakdown in customer portal
- Validate refund eligibility

**Important Notes:**
- This is a preview only - does not process refund
- Refund amount may vary based on payment gateway
- Some gateways don't refund processing fees
- Refunds can only be issued for fulfilled orders

**Authentication:** Customer must be logged in and own the subscription



## OpenAPI

````yaml /subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for the customer-facing subscription portal.
    These APIs enable customers to manage their subscriptions, update billing
    information, modify delivery schedules, and access their account details
    through your storefront.


    **Important**: These APIs must be called from your shop's domain (e.g.,
    https://www.myshop.com/apps/subscriptions/cp/api/**) and require customer
    authentication. Unauthenticated requests will return a 401 Unauthorized
    error.
  title: Storefront APIs
  version: 0.0.1
servers:
  - url: https://www.myshop.com/apps
security: []
tags:
  - description: >-
      Core customer portal APIs for managing customer account settings,
      authentication, and portal configurations.
    name: Customer Portal
  - description: >-
      APIs for customers to view and manage their subscription contracts
      including status updates, frequency changes, and cancellations.
    name: Subscription Management
  - description: >-
      APIs for retrieving and updating subscription contract details — delivery
      schedules, line items, addresses, billing cycles.
    name: Subscription Contracts
  - description: >-
      APIs for retrieving available subscription plans and selling plan
      configurations exposed to customers.
    name: Subscription Plans
  - description: >-
      APIs for managing one-time add-on products that can be purchased alongside
      recurring subscription items.
    name: Subscription One-Time Products
  - description: >-
      APIs for retrieving aggregated subscription data and account-level
      subscription information for the signed-in customer.
    name: Subscription Data
  - description: >-
      APIs for managing customizable product boxes and bundles where customers
      can select multiple items.
    name: Build-a-Box & Bundles
  - description: >-
      APIs for managing payment methods, billing information, and processing
      subscription payments.
    name: Billing & Payments
  - description: >-
      APIs for retrieving product information, selling plans, variant data, and
      subscription-enabled products available to customers.
    name: Product Catalog
  - description: >-
      APIs for managing delivery schedules, shipping addresses, delivery
      methods, and tracking order status.
    name: Delivery & Shipping
  - description: >-
      APIs for handling subscription cancellations, retention activities, and
      customer feedback management.
    name: Customer Retention
  - description: >-
      APIs for integrating loyalty programs with subscriptions including points
      redemption and earning options.
    name: Loyalty Integration
  - description: >-
      APIs for accessing portal customization settings, translations, and theme
      configurations.
    name: Customization
  - description: >-
      APIs for retrieving promotional campaigns shown in the customer portal,
      tracking banner engagement, and redeeming campaign offers.
    name: Campaigns
  - description: >-
      APIs for local pickup and click-and-collect — listing pickup locations and
      resolving eligible pickup dates and time slots.
    name: Store Pickup
paths:
  /subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}:
    get:
      tags:
        - Billing & Payments
      summary: Calculate refund amount preview
      description: >-
        Calculates the refund amount that would be issued if a specific
        subscription order fulfillment were refunded. This provides a preview
        without actually processing the refund.


        **What it calculates:**

        - Total refund amount (order amount minus processing fees)

        - Restocking fees (if applicable)

        - Gateway fees that cannot be refunded

        - Net refund amount customer will receive


        **Use Cases:**

        - Show customer how much they'll get back before confirming refund

        - Display refund breakdown in customer portal

        - Validate refund eligibility


        **Important Notes:**

        - This is a preview only - does not process refund

        - Refund amount may vary based on payment gateway

        - Some gateways don't refund processing fees

        - Refunds can only be issued for fulfilled orders


        **Authentication:** Customer must be logged in and own the subscription
      operationId: calculateRefundPreview
      parameters:
        - description: Billing attempt ID
          in: path
          name: id
          required: true
          schema:
            format: int64
            type: integer
        - description: Subscription contract ID for validation
          in: query
          name: subscriptionContractId
          required: false
          schema:
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              example:
                currency: USD
                orderAmount: 45.99
                processingFees: 1.5
                refundAmount: 44.49
                restockingFee: 0
          description: Refund preview calculated successfully
        '400':
          content:
            '*/*':
              schema:
                additionalProperties:
                  type: object
                type: object
          description: Order cannot be refunded (not fulfilled, already refunded, etc.)
        '401':
          content:
            '*/*':
              schema:
                additionalProperties:
                  type: object
                type: object
          description: Customer not logged in or doesn't own this subscription

````