Customers

Close customer access

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. Suspend keeps the binding and its money in place and has no such check.

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

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/customer-access/{customerAccessId}/close
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

customerAccessIdstring required

Hyperscale customer access ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Request body

reasonstring required

Response

Success

tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

customerIdstring required

Tenant-local customer ID

customerAccessIdstring required

Hyperscale customer access ID

updatedAtstring date-time required
reasonstring required
previousStatus'pending' | 'active' | 'suspended' required
status'closed' required

Changes

No recorded changes to this operation across all 1 revision of this API.