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.

Full behavior, validation rules, and side effects

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

GET /subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}

Calculate refund amount preview

cURL

curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}

200

{
  "orderAmount": 45.99,
  "processingFees": 1.5,
  "restockingFee": 0,
  "refundAmount": 44.49,
  "currency": "USD"
}

Path Parameters

id · integer<int64> · required

Billing attempt ID

Query Parameters

subscriptionContractId · integer<int64>

Subscription contract ID for validation

Response

200

application/json

Refund preview calculated successfully