Atualiza uma assinatura existente.

Utilize este método para alterar os atributos de uma assinatura existente.

Reagendamento da data de cobrança

A data de cobrança da assinatura pode ser atualizada através dos parâmetros billing_trigger_type e billing_trigger_day.

Após a atualização, a plataforma irá retornar a próxima data de cobrança calculada no atributo next_billing_at. Se esta data for igual ou anterior ao dia corrente, você poderá gerar uma fatura manualmente usando o método POST /periods/{id}/bill. A plataforma não irá emitir faturas retroativas automaticamente.

Por motivos de retrocompatibilidade, a atualização da data de cobrança diretamente através do parâmetro next_billing_at ainda é possível, porém não recomendável.

Desvincular perfil de pagamento

Para desvincular um perfil de pagamento de uma assinatura sem vincular outro perfil, envie:

{
  "payment_profile": {
    "id": null
  }
}

Itens da assinatura

Para atualizar os itens da assinatura, utilize o serviço product_items.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

ID da assinatura que deverá ser atualizada.

Body Params

Atualiza uma assinatura existente.

string

JSON com os novos atributos da assinatura.

string

Código externo para referência via API

string
required

Código do método de pagamento

int32

Parcelamento da cobrança. Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano

string
enum

Referência para data de geração da cobrança

Allowed:
int32

Dia para geração da cobrança.

string
enum

Metadados da assinatura

Allowed:
payment_profile
object
string

Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano (true). Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano

subscription_affiliates
array of objects

Lista de participantes da assinatura. Este campo é exclusivo para transaçõesque utilizaram a regra de split de pagamento e os participantes estejam ativos.

subscription_affiliates
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json