Skip to main content
POST
Ask for a refund
The request moves no money. AgentaOS reviews it within 2 business days, usually the same day, and either refunds the whole amount, VAT included, or declines it with a note you read in the dashboard. While it is open, the sale is held out of your payouts. It works in test and live; the key you sign with decides the mode. See Refunds.
Outcome: there is no webhook. The sale’s mor_status on List transactions becomes refunded once the refund is executed. A refund does not cancel a subscription: cancel it separately, and it ends at period end.

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Path Parameters

id
string<uuid>
required

The sale's transaction id: from the transactions list, or a checkout.session.completed event's id without the evt_ prefix.

Response

The request as recorded.

captureId
string<uuid>
required

The sale the request is about.

status
enum<string>
required

requested while AgentaOS reviews it, executed once the buyer was refunded, declined with a note.

Available options:
requested,
executed,
declined
requestedAt
string<date-time>
required
decidedAt
string<date-time> | null
required
note
string | null
required

AgentaOS's reason on a decline, shown to you. Null otherwise.