Billing & Payments
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
GET
/
subscriptions
/
cp
/
api
/
subscription-billing-attempts
/
refund-preview
/
{id}
Calculate refund amount preview
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}import requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}';
const options = {method: 'GET'};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"currency": "USD",
"orderAmount": 45.99,
"processingFees": 1.5,
"refundAmount": 44.49,
"restockingFee": 0
}{}{}⌘I
Calculate refund amount preview
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}import requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}';
const options = {method: 'GET'};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://www.myshop.com/apps/subscriptions/cp/api/subscription-billing-attempts/refund-preview/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"currency": "USD",
"orderAmount": 45.99,
"processingFees": 1.5,
"refundAmount": 44.49,
"restockingFee": 0
}{}{}