Remotehost Docs
API ReferenceAdd-ons

Cancel an add-on

DELETE
/orgs/{orgId}/addons/{listingId}/purchase

Cancels at the end of the paid period: nothing is refunded or charged, the add-on stays until endsAt, and it does not renew. Allowed while the org's payment is failing too, so a recovery does not renew it. Buying it again before endsAt keeps it with no second charge. Needs billing.manage; allowed whatever the listing's state or the org's policy. Answers 200 only with the cancel in place. Audited.

Authorization

bearerAuth
AuthorizationBearer <token>

A RemoteHost API key (rh_sk_...) or a user session token.

In: header

Path Parameters

orgId*string
listingId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/orgs/string/addons/string/purchase"
{  "purchase": {    "id": "string",    "listingId": "string",    "status": "pending",    "source": "billing",    "quantity": 0,    "pendingQuantity": 0,    "startedAt": "string",    "endsAt": "string",    "endedAt": "string"  },  "confirmationUrl": "string"}

Change an add-on's quantity PATCH

For an add-on sold per unit. An increase is charged now for the rest of the period and applies once paid (`pendingQuantity` meanwhile, with `confirmationUrl` when it needs confirming); a decrease credits the rest of the period and applies at once. Asking again for a change Stripe never received sends it again. Needs `billing.manage`. Audited.

Platform Guide

Give your own users a sandbox each, without giving them a RemoteHost account