Freeze the real Stripe proration quote for a held plan, target version or seat quantity, retaining sibling plans. Preview makes no payment attempt. Reuse requestId on retry. Aggregated plans currently require a common billing interval.
SDK 0.0.1Updated
Make the request
Freeze the real Stripe proration quote for a held plan, target version or seat quantity, retaining sibling plans. Preview makes no payment attempt. Reuse requestId on retry. Aggregated plans currently require a common billing interval.
Credential
Server API key or customer token. Customer calls cannot select another customer.
Permission
billing: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.
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.
entitlementVersionIduuidOptional
The entitlementVersionId 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.
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"
quoteobject | objectRequired
The quote value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
carryOverBalancesobjectOptional
The carryOverBalances value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
enabledtrueRequired
The enabled value for this operation. Its accepted type and constraints are listed above and below.
featureIdsarrayOptional
The featureIds value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1 · maxItems: 100
carryOverUsagesobjectOptional
The carryOverUsages value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
enabledtrueRequired
The enabled value for this operation. Its accepted type and constraints are listed above and below.
featureIdsarrayOptional
The featureIds value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1 · maxItems: 100
operationIduuid | uuidRequired
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
membershipIduuid | uuidRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
productVersionIduuid | uuidRequired
The productVersionId value for this operation. Its accepted type and constraints are listed above and below.
timingenum | "store"Required
Immediate or end-of-cycle timing, only for supported plan-change actions.
effectiveAtdate-time | nullRequired
The effectiveAt value for this operation. Its accepted type and constraints are listed above and below.
expiresAtdate-time | date-timeRequired
ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.
currencyenum | enumRequired
Currency code supported by the published price.
creditMinorinteger | nullRequired
The creditMinor value for this operation. Its accepted type and constraints are listed above and below.
debitMinorinteger | nullRequired
The debitMinor value for this operation. Its accepted type and constraints are listed above and below.
discountMinorinteger | nullRequired
The discountMinor value for this operation. Its accepted type and constraints are listed above and below.
taxMinorinteger | nullRequired
The taxMinor value for this operation. Its accepted type and constraints are listed above and below.
totalMinorinteger | nullRequired
The totalMinor value for this operation. Its accepted type and constraints are listed above and below.
retainedProductVersionIdsarray | arrayRequired
The retainedProductVersionIds value for this operation. Its accepted type and constraints are listed above and below.
storeobjectOptional
The store value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
providerenumRequired
The provider value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"apple""google"
productIdstringRequired
The productId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 255
catalogAmountMinorintegerRequired
The catalogAmountMinor value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 100000000
policyenumRequired
The policy value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"apple_store""google_full_price"
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.