Skip to main content
POST
Cancel & Refund
Cancel a subscription immediately and credit what you paid on its most recent invoice (card charge plus any account balance applied, up to the invoice total) to your Stripe billing account balance. Designed for reseller organizations whose end-customer’s payment failed after our subscription had already renewed.
This cancels the subscription immediately (not at period end) and queues the proxies for deletion right away. The order is marked expired.

Requirements

  • Organization API key only — user-scoped keys receive 403
  • The cancel_refund feature 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:
  1. The order is marked expired
  2. The Stripe subscription is cancelled immediately (not at period end)
  3. The amount paid on the invoice is credited to the Stripe customer the order was billed to
  4. The proxies are queued for deletion right away

Request

Headers

Path Parameters

string
required
The subscription ID from order creation.
string
required
The product ID (e.g., "captcha").

Example Request

Response

Success Response

Response Fields

string
Status of the request.
string
Human-readable result message.
string
The order ID that was processed.
string
The Stripe subscription that was cancelled.
number
Amount credited, in dollars.
integer
Amount credited, in cents.
string
The Stripe invoice that was credited.
number
Hours between the invoice payment and this request.
boolean
Present and true only when an earlier request already cancelled and credited this order.

Retrying a Completed Request

If the order was already cancelled and credited, the same call returns 200 with already_processed: true and the original credit details. You are not credited a second time.

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

400 Bad Request - Nothing to Credit

404 Not Found

409 Conflict - Request In Progress

Another cancel-refund request for this order is still running. Wait a moment and retry.

500 Internal Server Error

Delete Order

Schedule a cancellation at period end (no immediate refund).

List Orders

Check an order’s current status.