Freeze cancellation or restoration targets by their actual payment container and provider. A shared Stripe container has one owned operation. While quotes remain incomplete, ready is false; continue with the same requestId. Store targets retain management URLs.
SDK 0.0.1Updated
Make the request
Freeze cancellation or restoration targets by their actual payment container and provider. A shared Stripe container has one owned operation. While quotes remain incomplete, ready is false; continue with the same requestId. Store targets retain management URLs.
Credential
Server API key only. Call from your trusted backend.
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 published price mappings 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
requestIduuidRequired
Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.
targetsarrayRequired
The targets value for this operation. Its accepted type and constraints are listed above and below.
minItems: 1 · maxItems: 100
Show child fields
membershipIduuidRequired
The membershipId value for this operation. Its accepted type and constraints are listed above and below.
actionenumRequired
Business action. Target fields and quantity requirements vary by action; see the request structure and example.
Show allowed values
"cancel""uncancel"
timingenumRequired
Immediate or end-of-cycle timing, only for supported plan-change actions.
Show allowed values
"immediate""renewal"
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"
batchobjectRequired
The batch value for this operation. Its accepted type and constraints are listed above and below.
Show child fields
batchIduuidRequired
The batchId value for this operation. Its accepted type and constraints are listed above and below.
readybooleanRequired
The ready 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.