Read the original operationId and, when needed, reconcile Stripe to finish it. Repeated reads preserve activation evidence and membership ownership. Store instructions do not imply a completed store change.
SDK 0.0.1Updated
Make the request
Read the original operationId and, when needed, reconcile Stripe to finish it. Repeated reads preserve activation evidence and membership ownership. Store instructions do not imply a completed store change.
Credential
Server API key only. Call from your trusted backend.
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 tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
operationIduuidRequired
Business operation UUID. Subscription execution references operationId from previewAttach; balance refunds reference the original consumption.
customerIduuidRequired
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"
trialobjectRequired
The trial 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.
statusenumRequired
The status value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"effective""store_action_required"
providerenumRequired
The provider value for this operation. Its accepted type and constraints are listed above and below.
Show allowed values
"free""stripe""apple""google"
membershipIdsarrayRequired
The membershipIds value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1 · maxItems: 20
endsAtdate-time | nullRequired
The endsAt value for this operation. Its accepted type and constraints are listed above and below.
managementUrluri | nullRequired
The managementUrl 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.