> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Pausar programa

> Pausa novas adesões e indicações do programa.

Use uma API key de escrita da organização dona do programa. Pausar impede novas adesões e indicações. O histórico, as condições aceitas e as assinaturas existentes são preservados. Você pode reativar o mesmo programa depois.

**id** `string` *required*

ID do programa.

O corpo é vazio (`{}`). Esta ação não publica outras condições.

Use uma `Idempotency-Key` diferente para cada operação que deseja executar.

```bash cURL theme={"theme":"css-variables"}
curl -X POST "https://api.chargefy.io/v1/affiliate-programs/afp_7Dk9mQ2vX5rT8pWN/pause" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: programa-produto-001" \
  -d '{}'
```

```json 200 theme={"theme":"css-variables"}
{
  "id": "afp_7Dk9mQ2vX5rT8pWN",
  "object": "affiliate_program",
  "admission_mode": "manual",
  "affiliate_fee_rate": 2000,
  "attribution_window_days": 30,
  "created_at": "2026-10-27T12:00:00Z",
  "livemode": true,
  "metadata": {},
  "product": "prod_7Dk9mQ2vX5rT8pWN",
  "recurrence_limit": 3,
  "recurrence_mode": "limited",
  "status": "paused",
  "updated_at": "2026-10-27T12:00:00Z",
  "version": 1
}
```

```json 400 theme={"theme":"css-variables"}
{
  "error": {
    "code": "invalid_request",
    "message": "Unknown parameter: version.",
    "param": "version",
    "type": "invalid_request_error"
  }
}
```

```json 403 theme={"theme":"css-variables"}
{
  "error": {
    "code": "permission_denied",
    "message": "You cannot manage this affiliate program.",
    "type": "invalid_request_error"
  }
}
```

```json 404 theme={"theme":"css-variables"}
{
  "error": {
    "code": "resource_missing",
    "message": "Affiliate program not found.",
    "type": "invalid_request_error"
  }
}
```

## Erros

| Código | Quando acontece | Como corrigir |
| - | - | - |
| `authentication_failed` | A chave não é válida | Confira a chave enviada |
| `permission_denied` | A chave não tem acesso à organização ou à operação | Confira os escopos e a organização |
| `resource_missing` | O programa ou produto não existe no modo e na organização da chave | Confira o ID e use a chave correspondente |
| `invalid_request` | Um campo ou uma combinação de condições é inválida | Corrija o campo indicado em `param` |

## Chargefy for Platforms

> [!WARNING]
>
> Esta seção só se aplica a contas com o produto **Chargefy for Platforms** habilitado. Nesse produto, uma plataforma opera pagamentos para **suas organizações conectadas**.

Use a chave da plataforma e o header `Organization` com o ID da organização conectada dona do produto. A organização conectada precisa estar ativa na sua rede. O programa continua pertencendo à organização conectada e ao modo da chave.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.