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.
membershipIduuidRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
purchaseIduuidRequired
The purchaseId value for this operation. Its accepted type and constraints are listed above and below.
linesarrayRequired
The lines value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1 · maxItems: 20
Show child fields
invoiceLineIdstringRequired
The invoiceLineId value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^il_[A-Za-z0-9_]+$
amountMinorintegerRequired
The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
max: 100000000
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.
membershipIduuidRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
purchaseIduuidRequired
The purchaseId value for this operation. Its accepted type and constraints are listed above and below.
invoiceIdstarts_withRequired
The invoiceId value for this operation. Its accepted type and constraints are listed above and below.