Refund amount calculation

POST

/subscriptions/{subscriptionId}/refunds/calculate

Calculates the refundable amount for an active subscription based on the provided effective date. The API determines the eligible refund.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🔴500ErrorResponse

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-sandbox.saaslogic.io/v1/subscriptions//refunds/calculate' \
--header 'Authorization: Bearer ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "effectiveDate": "2026-07-20T00:00:00"
}'

Response Example

200 - Example 1

{
    "subscriptionRefId": "fb921cbc6bc74c34b39ef11eab752f",
    "invoiceRefIds": [
        "eb65d589-6094-44f1-b1fb-809f13d5abd3"
    ],
    "isEligibleForRefund": true,
    "effectiveDate": "2026-07-16T04:00:00",
    "currencyCode": "USD",
    "maxRefundAmount": 520.0,
    "refundBreakdown": [
        {
            "type": "PAYMENT_GATEWAY",
            "maximumRefundAmount": 170.0,
            "requiresMerchantAction": false
        },
        {
            "type": "MANUAL",
            "maximumRefundAmount": 150.0,
            "requiresMerchantAction": true
        },
        {
            "type": "CREDIT",
            "maximumRefundAmount": 200.0,
            "requiresMerchantAction": false
        }
    ],
    "proratedRefund": {
        "refundAmount": 520.0,
        "billingCycleStartDate": "2026-07-16T04:00:00",
        "billingCycleEndDate": "2026-07-18T04:00:00"
    }
}

Cancel the subscription

Create a product subscription