VIvideogen
Billing

Request credit purchase refund

Changed on

Sensitive write. Record a support-reviewed refund request for a paid order. A requested refund is not an approved or completed refund.

post/v1/billing/orders/{orderId}/refund

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

Path parameters

orderIdstring uuid required

Request body

reasonstring required

Why the purchaser wants a refund. Must be non-empty.

Response

Current account or order state.

orderIdstring uuid required
state'requires_approval' | 'requires_action' | 'processing' | 'paid_pending_fulfillment' | 'fulfilled' | 'failed' | 'canceled' | 'expired' required
revisioninteger required
teamIdstring required
teamNamestring required
seller'VideoGen' required
product'credits' required
creditsinteger required
currencystring required
subtotalMinorinteger required
discountMinorinteger required
taxMinorinteger required
feesMinorinteger required
totalMinorinteger required
expiresAtinteger required

Unix seconds when this quote expires.

termsVersionstring required
refundTermsstring required
refundStatus'none' | 'requested' | 'processing' | 'succeeded' | 'failed' required
verificationUrlstring nullable

Secure VideoGen verification continuation when required. Sign in as the purchaser on the same team. This is not a checkout link.

receiptUrlstring nullable required
retryGuidancestring required
paymentHandlerobject required

Seller payment handler and merchant identity for a compatible native wallet. This does not attest to host acceptance.

Changes