Return the published Offering Version, original hierarchy, Product candidates and per-Product availability without purchasing. Credentials constrain Customer identity and App/environment.
API v1Updated
Make the request
Return the published Offering Version, original hierarchy, Product candidates and per-Product availability without purchasing. Credentials constrain Customer identity and App/environment.
Credential
Server API key or customer token. Customer calls cannot select another customer.
Permission
entitlements: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 requirement value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
internal_feature_iduuidRequired
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
quantitystringRequired
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})?$
propertiesobjectRequired
Validated pricing properties used to match dimensions and multipliers.
entityIduuidOptional
Entity ID within the current customer scope, for configured entity and license features.
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"
offeringobjectRequired
The offering 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.
offeringIduuidRequired
The offeringId value for this operation. Its accepted type and constraints are listed above and below.
versionintegerRequired
The version value for this operation. Its accepted type and constraints are listed above and below.
max: 9007199254740991
documentobjectRequired
Published schemaVersion 3 design. May be null on a cache hit; direct HTTP callers must hydrate from the matching cache.
Show child fields
lookupKeystringRequired
The lookupKey value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 200
displayNamestringRequired
The displayName value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 1500
itemsarrayRequired
The items value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
Show child fields
type"product" | "group"Required
The type value for this operation. Its accepted type and constraints are listed above and below.
productIduuidOptional
The productId value for this operation. Its accepted type and constraints are listed above and below.
keystringOptional
The key value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,63}$
namestringOptional
Display name of the customer or object; not an identity key.
minLength: 1 · maxLength: 80
itemsarrayOptional
The items value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
metadataobjectRequired
The metadata value for this operation. Its accepted type and constraints are listed above and below.
candidatesarrayRequired
The candidates value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
Show child fields
productIdstringRequired
The productId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1
productVersionIdstringRequired
The productVersionId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1
namestringRequired
Display name of the customer or object; not an identity key.
minLength: 1 · maxLength: 120
actionenumRequired
Business action. Target fields and quantity requirements vary by action; see the request structure and example.
Show allowed values
"purchase""upgrade""addon""topup"
membershipIdstring | nullRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,8})$
intervalenumRequired
The interval value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"free""week""month""year""one_time"
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: 156
availabilityarrayRequired
The availability value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
Show child fields
productVersionIduuidRequired
The productVersionId value for this operation. Its accepted type and constraints are listed above and below.
availablebooleanRequired
The available value for this operation. Its accepted type and constraints are listed above and below.
reasonenum | nullRequired
Rejection reason or ledger operation description; interpret with accepted and status.
checkobject | nullRequired
The check value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
internal_feature_idstringRequired
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1
namestringRequired
Display name of the customer or object; not an identity key.
minLength: 1 · maxLength: 120
kindenumRequired
The kind value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"access""metered""credit"
quantityobjectRequired
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.
allowedbooleanRequired
Whether this feature is allowed at evaluation time. Use for display; your backend still authorizes business operations.
reasonenum | nullRequired
Rejection reason or ledger operation description; interpret with accepted and status.
previewobject | nullRequired
The preview value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
scenarioenumRequired
The scenario value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"feature_flag""usage_limit"
candidatesarrayRequired
The candidates value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
Show child fields
productIdstringRequired
The productId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1
productVersionIdstringRequired
The productVersionId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1
namestringRequired
Display name of the customer or object; not an identity key.
minLength: 1 · maxLength: 120
actionenumRequired
Business action. Target fields and quantity requirements vary by action; see the request structure and example.
Show allowed values
"purchase""upgrade""addon""topup"
membershipIdstring | nullRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^(0|[1-9]\d{0,8})$
intervalenumRequired
The interval value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"free""week""month""year""one_time"
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: 156
Handle errors
Common failures
Code
Recovery
UNAUTHENTICATED
Verify the key or refresh the expired customer token once.
FORBIDDEN
Check current key permissions and customer access.
INVALID_REQUEST
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Use the App and environment bound to the credential.
Common failures
UNAUTHENTICATED
Recovery
Verify the key or refresh the expired customer token once.
FORBIDDEN
Recovery
Check current key permissions and customer access.
INVALID_REQUEST
Recovery
Check field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCH
Recovery
Use the App and environment bound to the credential.