The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
authorizationIduuidRequired
The authorizationId value for this operation. Its accepted type and constraints are listed above and below.
requestIduuidRequired
Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
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"
authorizationobjectRequired
The authorization value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
termsobject | objectRequired
The terms value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
productVersionIduuid | uuidRequired
The productVersionId value for this operation. Its accepted type and constraints are listed above and below.
entitlementVersionIduuid | uuidRequired
The entitlementVersionId value for this operation. Its accepted type and constraints are listed above and below.
currencyenum | enumRequired
Currency code supported by the published price.
maxAmountMinorPerPeriodstring | stringRequired
The maxAmountMinorPerPeriod value for this operation. Its accepted type and constraints are listed above and below.
kind"auto_topup" | "postpaid"Required
The kind value for this operation. Its accepted type and constraints are listed above and below.
thresholdobjectOptional
The threshold value for this operation. Its accepted type and constraints are listed above and below.
maxPurchasesPerDayintegerOptional
The maxPurchasesPerDay value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 1000
purchaseLimitsobjectOptional
The purchaseLimits value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
hourintegerOptional
The hour value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 1000
weekintegerOptional
The week value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 1000
monthintegerOptional
The month value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 1000
purchaseAmountMinorstringOptional
The purchaseAmountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(?:[1-9]\d{0,7}|1\d{8}|200000000)$
purchaseUnitsobjectOptional
The purchaseUnits value for this operation. Its accepted type and constraints are listed above and below.
maxOutstandingMinorstringOptional
The maxOutstandingMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(?:[1-9]\d{0,7}|1\d{8}|200000000)$
cashPriceobjectOptional
The cashPrice value for this operation. Its accepted type and constraints are listed above and below.