post https://api.fastspring.com/returns
Issue one or more full order returns. To issue a partial return, we recommend using the FastSpring App.
Returning a subscription does not cancel the subscription. We recommend calling DELETE / subscriptions/{subscription_Id} to cancel the subscription as well.
{
"returns":[
{
"order":"17VblT1XR1aAnIIScCgpfw", // order ID OR order reference to be returned
"reason":"DUPLICATE_ORDER", // refund reason; see table for possible values
"note":"As requested by customer", // optional, customer-visible note explaining the return reason
"notification":"ORIGINAL" // notify the customer of the return via email? "ORIGINAL" = yes; "NONE" = no
}
]
}
Values for the reason
key
reason
keyThe reason
key in the request body accepts the following 10 unique values:
Possible key values | Reason |
---|---|
TAX_REFUND | Tax return |
PRODUCT_NOT_RECEIVED | Product not received |
PRODUCT_DIFFERENCE | Product not as expected |
FRAUDULENT | Fraudulent transaction |
ORDER_ERROR | Incorrect order or order error |
DISCOUNT | Discount or coupon |
DUPLICATE_ORDER | Duplicate order |
COMPATIBILITY_ISSUE | Compatibility issue |
OTHER | Other reason |
NULL | None |
If your payload contains a value that doesn't match those in this table, FastSpring will still create the return but insert None
as the reason for the return.
For example, if your reason value is TAX_RETURN
instead of TAX_REFUND
, the order would display None
as the refund reason.