Read the purchase status of a quote without creating a second purchase. Customer tokens supply the verified identity; server keys must specify the customer.
API v1Updated
Make the request
Read the purchase status of a quote without creating a second purchase. Customer tokens supply the verified identity; server keys must specify the customer.
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.
The response is illustrative, not the result of a live request.
Request parameters
JSON body
operationIduuidRequired
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
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"
operationobjectRequired
The operation value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
operationIduuidRequired
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
orderIduuidRequired
The orderId value for this operation. Its accepted type and constraints are listed above and below.
appendbooleanOptional
The append value for this operation. Its accepted type and constraints are listed above and below.
invoiceModebooleanOptional
The invoiceMode value for this operation. Its accepted type and constraints are listed above and below.
statusenumRequired
The status value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"pending""complete""cancelled""failed"
executorenumRequired
The executor value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"indiana""merchant"
checkoutUrluri | nullRequired
The checkoutUrl value for this operation. Its accepted type and constraints are listed above and below.
executionobject | nullRequired
The execution value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
invoiceModeobjectOptional
The invoiceMode value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
enabledbooleanRequired
The enabled value for this operation. Its accepted type and constraints are listed above and below.
enable_plan_immediatelybooleanRequired
The enable_plan_immediately value for this operation. Its accepted type and constraints are listed above and below.
default: false
finalizebooleanRequired
The finalize value for this operation. Its accepted type and constraints are listed above and below.
default: true
invoice_template_idstringOptional
The invoice_template_id value for this operation. Its accepted type and constraints are listed above and below.
net_terms_daysintegerOptional
The net_terms_days value for this operation. Its accepted type and constraints are listed above and below.
max: 9007199254740991
appendobjectOptional
The append value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
subscriptionIdstringRequired
The subscriptionId value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^sub_[A-Za-z0-9]+$
customerIdstringRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
pattern: ^cus_[A-Za-z0-9]+$
sourceItemsarrayRequired
The sourceItems value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1 · maxItems: 100
prorationDateintegerRequired
The prorationDate value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 9007199254740991
amountMinorintegerRequired
The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
max: 9007199254740991
periodStartMsnumberRequired
The periodStartMs value for this operation. Its accepted type and constraints are listed above and below.
periodEndMsnumberRequired
The periodEndMs value for this operation. Its accepted type and constraints are listed above and below.
provider"stripe"Required
The provider value for this operation. Its accepted type and constraints are listed above and below.
executorenumRequired
The executor value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"indiana""merchant"
accountIdstringRequired
The accountId value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^acct_[A-Za-z0-9]+$
modeenumRequired
The mode value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"payment""subscription"
lineItemsarrayRequired
The lineItems value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1 · maxItems: 100
Show child fields
pricestring | nullRequired
Price in the requested or existing billing currency; null when unavailable, without currency substitution.
quantityintegerRequired
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.
min: 1 · max: 10000
priceIduuidRequired
The priceId value for this operation. Its accepted type and constraints are listed above and below.
productNamestringRequired
The productName value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 80
amountMinorintegerRequired
The amountMinor value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 100000000
currencystringRequired
Currency code supported by the published price.
pattern: ^[a-z]{3}$
intervalenumRequired
The interval value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"week""month""year""one_off"
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: 52
slotenumRequired
The slot value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"stripe_price_id""stripe_empty_price_id"
tiersobject | nullRequired
The tiers value for this operation. Its accepted type and constraints are listed above and below.
discountsarrayRequired
The discounts value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 1
Show child fields
couponstringRequired
The coupon value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^[A-Za-z0-9_-]{1,200}$
termsobjectRequired
The terms value for this operation. Its accepted type and constraints are listed above and below.
trialPeriodDaysinteger | nullRequired
The trialPeriodDays value for this operation. Its accepted type and constraints are listed above and below.
metadataobjectRequired
The metadata value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
grooveCheckoutIduuidRequired
The grooveCheckoutId value for this operation. Its accepted type and constraints are listed above and below.
grooveCustomerIduuidRequired
The grooveCustomerId value for this operation. Its accepted type and constraints are listed above and below.
expiresAtdate-timeRequired
ISO 8601 UTC expiry. Expired sessions and reservations cannot be reused.
The catalogAmountMinor value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 100000000
discountMinorintegerRequired
The discountMinor value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 100000000
trialDaysinteger | nullRequired
The trialDays value for this operation. Its accepted type and constraints are listed above and below.
seatBundlearrayRequired
The seatBundle value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
Show child fields
keystringRequired
The key value for this operation. Its accepted type and constraints are listed above and below.
pattern: ^[a-z][a-z0-9_]{0,63}$
quantityintegerRequired
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.
min: 1 · max: 10000
applePromotionalOfferobject | nullRequired
The applePromotionalOffer value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
offerIdstringRequired
ID of an offer claimed by this customer; mutually exclusive with promotionCode.
minLength: 1 · maxLength: 255
keyIdstringRequired
The keyId value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 255
nonceuuidRequired
The nonce value for this operation. Its accepted type and constraints are listed above and below.
signaturestringRequired
The signature value for this operation. Its accepted type and constraints are listed above and below.
minLength: 1 · maxLength: 1024
timestampintegerRequired
The timestamp value for this operation. Its accepted type and constraints are listed above and below.
min: 0 · max: 9007199254740991
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.