The verified customer selects up to 20 owned grants for a confirmed authorization. Discounts apply in order; an empty list removes them. Retain the request ID for retries; an active collection stays fixed.
API v1Updated
Make the request
The verified customer selects up to 20 owned grants for a confirmed authorization. Discounts apply in order; an empty list removes them. Retain the request ID for retries; an active collection stays fixed.
Credential
Customer token only. Identity is bound to the token.
Permission
billing:write
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.
For this Web Beta, configure the Stripe Sandbox test account and fixed Product Prices before checkout. Redirects do not confirm payment.
The response tab lists field types, not an example payload. Actual values depend on customer state.
Request parameters
JSON body
membershipIduuidRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
requestIduuidRequired
Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
grantIdsarrayRequired
The grantIds value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
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"
couponsobjectRequired
The coupons value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
membershipIduuidRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
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
"pending""effective"
executionobject | nullRequired
The execution 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.
customerIdstringRequired
Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.
accountIdstringRequired
The accountId value for this operation. Its accepted type and constraints are listed above and below.
sourceItemsarrayRequired
The sourceItems value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 100
Show child fields
idstringRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
price_idstringRequired
The price_id value for this operation. Its accepted type and constraints are listed above and below.
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: -9007199254740991 · max: 9007199254740991
discountsarrayOptional
The discounts value for this operation. Its accepted type and constraints are listed above and below.
itemsarrayRequired
The items value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 100
Show child fields
idstringRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
pricestringRequired
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: -9007199254740991 · max: 9007199254740991
discountsarrayRequired
The discounts value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
grantsarrayRequired
The grants value for this operation. Its accepted type and constraints are listed above and below.
maxItems: 20
Show child fields
iduuidRequired
The id value for this operation. Its accepted type and constraints are listed above and below.
couponIduuidRequired
Coupon UUID in the current App and environment.
namestringRequired
Display name of the customer or object; not an identity key.
discountobject | objectRequired
The discount value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
type"percent" | "amount"Required
The type value for this operation. Its accepted type and constraints are listed above and below.
percentOffintegerOptional
The percentOff value for this operation. Its accepted type and constraints are listed above and below.
min: 1 · max: 100
amountOffCentsintegerOptional
The amountOffCents value for this operation. Its accepted type and constraints are listed above and below.