The trusted server quotes a full or partial refund of the customer's paid Stripe invoice and whether to end the plans it paid for. The quote holds the amount and does not initiate a refund.
API v1Updated
Make the request
The trusted server quotes a full or partial refund of the customer's paid Stripe invoice and whether to end the plans it paid for. The quote holds the amount and does not initiate a refund.
Credential
Server API key only. Call from your trusted backend.
Permission
billing:read
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
requestIduuidRequired
Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
invoiceIduuidRequired
The invoiceId value for this operation. Its accepted type and constraints are listed above and below.
modeenumRequired
The mode value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"full""partial"
amountMinorintegerOptional
The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
max: 200000000
entitlementActionenumRequired
The entitlementAction value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"retain""revoke"
customerIduuidRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
Response fields
Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.
HTTP 200 · application/json
requestIduuidRequired
Server-generated HTTP request UUID. Include it when reporting a failed request.
scopeobjectRequired
The App and environment of this response. Headers only verify scope; they cannot switch key scope.
Show child fields
projectIdstringRequired
App ID bound to the credential.
minLength: 1
environmentenumRequired
Separate data scope: sandbox or live.
Show allowed values
"sandbox""live"
quoteobjectRequired
The quote value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
operationIduuidRequired
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
invoiceIduuidRequired
The invoiceId value for this operation. Its accepted type and constraints are listed above and below.
providerInvoiceIdstringRequired
The providerInvoiceId value for this operation. Its accepted type and constraints are listed above and below.