Cancel an unpaid purchase this key created, so its payment link stops working (naturally idempotent; 30 per key per hour)

post/v1/billing/purchases/{id}/cancel

Request

  • Base URL: https://api.roveapi.com
  • URL: https://api.roveapi.com/v1/billing/purchases/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Successful response (Cache-Control: no-store)

idstring uuid required
object'purchase' required
status'created' | 'open' | 'requires_action' | 'processing' | 'paid' | 'refunded' | 'disputed' | 'reversed' | 'expired' | 'canceled' | 'failed' required
livemodeboolean required
actor'owner_web' | 'api_key' | 'auto_topup' | 'legacy_link' required
api_key_idstring uuid nullable required
api_key_namestring nullable required
replayedboolean required
channel'checkout' | 'off_session' required
amount_centsinteger required
currency'usd' required
creditsinteger required

Whole credits the pack grants.

amount_refunded_centsinteger required
millicredits_reversedinteger required
millicredits_heldinteger required
retry'same_key' | 'new_key' nullable required
failure_codestring nullable required
created_atstring date-time required
paid_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.