---
title: "Alterar assinatura"
method: PUT
path: "/subscriptions/{subscription_id}"
---

# Alterar assinatura

`PUT /subscriptions/{subscription_id}`

## Path parameters

- `subscription_id` string, required

## Headers

- `Authorization` string, required
- `x-idempotency-key` string

## Request body

- object
  - `pro_rata` boolean — Define se a assinatura utilizar pró-rata ou não.
  - `best_invoice_date` object — Objeto com a melhor data para próxima cobrança.
    - `day` string — Melhor dia para pagar (Max 2 caracteres).
    - `month` string — Melhor mês para pagar (Max 2 caracteres).
  - `next_invoice_at` string, date — Melhor data para apenas a próxima cobrança, as demais voltarão ao ciclo normal. <br><small>Formato: YYY-MM-DD</small>
  - `amount` object — Objeto contendo as informações do valor a ser cobrado.
    - `value` integer — Valor a ser estornado em centavos (MAX 9 caracteres). <br><small>Exemplo: R$ 1.500,99 = 150099</small> ⚠️**Obrigatório**⚠️
    - `currency` string — Código de moeda ISO de três letras, em maiúsculas. No momento, apenas o Real brasileiro (BRL) é suportado. ⚠️ **Obrigatório** ⚠️
  - `plan` object — Objeto contendo informações do plano que será usado na assinatura.
    - `id` string — Identificador de um plano existente e ativo no qual a assinatura será associada. Formato `PLAN_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`.
  - `coupon` object — Objeto contendo informações do cupom de desconto, quando aplicável.
    - `id` string — Código de identificação do cupom a ser aplicado a essa assinatura. Formato `COUP_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`.
  - `split_enabled` boolean — Define se o recurso de divisão de pagamento (split) será ativado para assinaturas. Quando definido como `true`, o split será aplicado conforme a configuração do objeto `split`.
  - `split` object — Objeto que define as regras de divisão (percentual ou valor fixo) de uma transação recorrente (assinatura) entre até 15 recebedores. <br/>⚠️ **Obrigatório quando `split_enabled` for `true`.** <br/>🚫 **Não deve ser enviado quando `split_enabled` for `false` ou não estiver presente.**
    - `method` 'PERCENTAGE' | 'FIXED' — Define o método de divisão do pagamento a ser utilizado ⚠️**Obrigatório**⚠️. <br/> - `PERCENTAGE`: Divisão proporcional ao valor percentual informado. <br/> - `FIXED`: Divisão por valores fixos.
    - `receivers` object[] — Listas dos recebedores. Para cada recebedor, você deve informar a conta e o valor a ser recebido ⚠️**Obrigatório**⚠️. <br/> Caso `method = PERCENTAGE`, a soma dos valores deve ser igual a 100. <br/> Caso `method = FIXED`, a soma dos valores atribuídos a cada recebedor não pode ultrapassar o valor da mensalidade.
      - `account` object — Objeto com as informações da conta do recebedor. ⚠️**Obrigatório**⚠️
        - `id` string — Identificador único da conta PagBank do recebedor.
      - `amount` object — Objeto com as informações da quantia, percentual ou fixa, a ser transferida para o recebedor. ⚠️**Obrigatório**⚠️
        - `value` integer — Valor, percentual ou fixo, a ser transferido para a conta PagBank do recebedor.

## Response `200`

200

- object
  - `id` string
  - `reference_id` string
  - `amount` object
    - `value` integer
    - `currency` string
  - `status` string
  - `plan` object
    - `id` string
    - `name` string
  - `payment_method` object[]
    - `type` string
    - `card` object
      - `token` string
      - `brand` string
      - `first_digits` string
      - `last_digits` string
      - `exp_month` string
      - `exp_year` string
      - `holder` object
        - `name` string
  - `next_invoice_at` string
  - `pro_rata` boolean
  - `customer` object
    - `id` string
    - `name` string
    - `email` string
  - `created_at` string
  - `updated_at` string
  - `exp_at` string
  - `links` object[]
    - `rel` string
    - `href` string
    - `media` string
    - `type` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/pagbank/apis/nova-plataforma-sandbox.md) · [All operations](https://skmtc.net/pagbank/apis/nova-plataforma-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pagbank/nova-plataforma-sandbox/versions/05e64f3006ab/schema)