Read current feature models, prices and markups in this App/environment. Saved configuration applies to new calls; frozen quotes retain original prices.
API v1Updated
Make the request
Read current feature models, prices and markups in this App/environment. Saved configuration applies to new calls; frozen quotes retain original prices.
Credential
Server API key only. Call from your trusted backend.
Permission
credits: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
internal_feature_iduuidRequired
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
customerIduuidOptional
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
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"
internal_feature_iduuidRequired
The internal_feature_id value for this operation. Its accepted type and constraints are listed above and below.
configobjectRequired
The config value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
schemaarrayRequired
The schema value for this operation. Its accepted type and constraints are listed above and below.
minItems: 0 · maxItems: 0
Show child fields
metered_feature_idstring | stringRequired
The metered_feature_id value for this operation. Its accepted type and constraints are listed above and below.
feature_amountnumber | numberOptional
The feature_amount value for this operation. Its accepted type and constraints are listed above and below.
dimensionsobject | objectOptional
The dimensions value for this operation. Its accepted type and constraints are listed above and below.
multipliersobject | objectOptional
The multipliers value for this operation. Its accepted type and constraints are listed above and below.
credit_amountnumber | objectOptional
The credit_amount value for this operation. Its accepted type and constraints are listed above and below.
tier_behaviorobject | "graduated"Optional
The tier_behavior value for this operation. Its accepted type and constraints are listed above and below.
tiersobject | arrayOptional
The tiers value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
tonumber | "inf"Required
The to value for this operation. Its accepted type and constraints are listed above and below.
credit_amountnumberRequired
The credit_amount value for this operation. Its accepted type and constraints are listed above and below.
invoice_creditbooleanOptional
The invoice_credit value for this operation. Its accepted type and constraints are listed above and below.
usage_typeenumRequired
The usage_type value for this operation. Its accepted type and constraints are listed above and below.
default: "single_use"
Show allowed values
"single_use""continuous_use"
default_markupnumberOptional
The default_markup value for this operation. Its accepted type and constraints are listed above and below.
min: -100
provider_markupsobject | nullOptional
The provider_markups value for this operation. Its accepted type and constraints are listed above and below.
model_markupsobject | nullOptional
The model_markups value for this operation. Its accepted type and constraints are listed above and below.
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.