---
title: "Close customer access"
method: POST
path: "/v1/customer-access/{customerAccessId}/close"
tags: ["Customers"]
---

# Close customer access

`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

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.

## Path parameters

- `customerAccessId` string, required: Hyperscale customer access ID

## Headers

- `X-Hyperscale-Environment` 'sandbox' | 'live'
- `Idempotency-Key` string, required

## Request body

- object
  - `reason` string, required

## Response `200`

Success

- CustomerAccessCloseOutput
  - `tenantId` string, required: Organization tenant ID
  - `productId` string, required: Hyperscale product ID
  - `customerId` string, required: Tenant-local customer ID
  - `customerAccessId` string, required: Hyperscale customer access ID
  - `updatedAt` string, date-time, required
  - `reason` string, required
  - `previousStatus` 'pending' | 'active' | 'suspended', required
  - `status` 'closed', required

## Other responses

- `default`: ErrorResponse. See x-error-codes and x-errors for codes, HTTP statuses and retry guidance.

---

[API](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api.md) · [All operations](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/revisions/e9e8faa044d5?raw)