Cancel & Refund
Order API
Cancel & Refund
Cancel a subscription immediately and credit its most recent invoice.
POST
Cancel & Refund
Cancel a subscription immediately and credit the full amount of its most recent paid invoice back to your Stripe billing account balance. Designed for reseller organizations whose end-customer’s payment failed after our subscription had already renewed.
Requirements
- Organization API key only — user-scoped keys receive 403
- The
cancel_refundfeature must be enabled for your organization (contact support) - Must be called within 3 days (72 hours) of the most recent invoice payment
- The order must be active or cancelled (not expired), and not a crypto subscription
Effects
When successful:- The order is marked expired
- The Stripe subscription is cancelled immediately (not at period end)
- The invoice amount is credited to the Stripe customer the order was billed to
- The proxies are queued for deletion right away
Request
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {your_api_key} | Yes |
Path Parameters
The subscription ID from order creation.
The product ID (e.g.,
"captcha").Example Request
Response
Success Response
Response Fields
Status of the request.
Human-readable result message.
The order ID that was processed.
The Stripe subscription that was cancelled.
Amount credited, in dollars.
Amount credited, in cents.
The Stripe invoice that was credited.
Hours between the invoice payment and this request.
Error Responses
403 Forbidden - Not an Organization Key
403 Forbidden - Feature Not Enabled
400 Bad Request - No Billing Account
400 Bad Request - Order Not Processable
400 Bad Request - Crypto Subscription
400 Bad Request - No Paid Invoices
400 Bad Request - Refund Window Passed
404 Not Found
409 Conflict - Already Processed
500 Internal Server Error
Related Endpoints
Delete Order
Schedule a cancellation at period end (no immediate refund).
List Orders
Check an order’s current status.
