Hyperscale docs Sign in Start building

Close customer access

customer_access.close

Moves a pending, active, or suspended product customer-access binding to closed status without disabling the tenant customer relationship or deleting binding history. Close is terminal, so it refuses with customer_access_close_open_activity while the customer is a party to an open record in this Product (escrow for it sits on a product account), or the customer's accounts in this Product hold a non-zero ledger balance or hold, or sit in an unresolved internal transfer; details.blockers uses the product.closure.retrieve shape with codes open_record, transfer and balance.

POST /v1/customer-access/{customerAccessId}/close

Scopes: customer:write

Input

FieldTypeDescription
customerAccessId requiredstringHyperscale customer access ID
reason requiredstring
idempotencyKey requiredstringNew per change; reuse only to retry it.
confirmation requiredcustomer_access_close | customer_access.closeThis tool's name, once the founder agrees.

Request sample

curl --request POST 'https://console.hyperscale0.ai/v1/customer-access/{customerAccessId}/close' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "reason": "<string>",
  "idempotencyKey": "<string>",
  "confirmation": "<customer_access_close | customer_access.close>"
}'

All operations