The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
requestIduuid | uuidRequired
Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
productVersionIduuid | uuidRequired
The productVersionId value for this operation. Its accepted type and constraints are listed above and below.
internal_feature_iduuid | uuidRequired
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
currencyenum | enumRequired
Currency code supported by the published price.
kind"auto_topup" | "postpaid"Required
The kind value for this operation. Its accepted type and constraints are listed above and below.
thresholdstringOptional
The threshold value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^-?(0|[1-9]\d{0,11})(\.\d{1,6})?$
quantitystringOptional
Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.
pattern: ^(0|[1-9]\d{0,11})(\.\d{1,6})?$
purchaseLimitobjectOptional
The purchaseLimit value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
intervalenumRequired
The interval value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"hour""day""week""month"
intervalCountintegerRequired
Charging interval count: up to 156 weeks, 36 months or 3 years; omitted means 1. Not accepted for free or one_time. Allowance resets remain independent.
min: 1 · max: 12
limitintegerRequired
Maximum records per page, subject to the contract limit.
min: 1 · max: 1000000
maxAmountMinorPerPeriodstringOptional
The maxAmountMinorPerPeriod value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(?:[1-9]\d{0,7}|1\d{8}|200000000)$
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)$
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"
preparedobjectRequired
The prepared value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
authorizationIduuidRequired
The authorizationId 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.
internal_feature_iduuid | uuidRequired
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
currencyenum | enumRequired
Currency code supported by the published price.
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.
quantityobjectOptional
Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.
purchaseLimitobjectOptional
The purchaseLimit value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
intervalenumRequired
The interval value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"hour""day""week""month"
intervalCountintegerRequired
Charging interval count: up to 156 weeks, 36 months or 3 years; omitted means 1. Not accepted for free or one_time. Allowance resets remain independent.
min: 1 · max: 12
limitintegerRequired
Maximum records per page, subject to the contract limit.
min: 1 · max: 1000000
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.
maxAmountMinorPerPeriodstringOptional
The maxAmountMinorPerPeriod value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(?:[1-9]\d{0,7}|1\d{8}|200000000)$
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.