---
title: "Pause collection for a customer"
method: PUT
path: "/customers/{customerId}:pause_collection"
tags: ["Customers"]
---

# Pause collection for a customer

`PUT /customers/{customerId}:pause_collection`

Stops collection from the customer by the named methods. Payment requests already raised for the customer are not collected by those methods until collection is resumed. Methods that are not named keep collecting, and a method that is already paused stays as it is.

## Path parameters

- `customerId` string, uuid, required

## Request body

- CollectionPauseRequest — The collection methods to stop collecting by.
  - `collectionMethods` string[], required — The collection methods to pause. At least one method is required.

## Response `204`

Collection is paused for the named methods.

## Other responses

- `400` — The request was refused. `errors[].type` is `COLLECTION_METHOD_NOT_ELIGIBLE` when a named method cannot be paused for this customer, and no method is paused in that case. An empty or unrecognised `collectionMethods` is also refused here.
- `401` — The request carried no valid access token.
- `403` — The access token does not grant updating customers.
- `404` — There is no customer with that identifier.
- `500` — The server could not process the request.

---

[API](https://skmtc.dev/adfin/apis/adfin-api.md) · [All operations](https://skmtc.dev/adfin/apis/adfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adfin/adfin-api/revisions/53d29f0850e0/schema)