Alterar a periodicidade
PATCH
/v1/subscriptions/{id}/frequency
Altera a periodicidade (interval + interval_count) da assinatura e
recalcula next_charge_at. Retorna o detalhe atualizado da assinatura.
A periodicidade enviada precisa ser oferecida pelo produto da assinatura.
Para assinaturas de produtos Shopify, isso significa existir uma variante de
assinatura naquela cadência; caso contrário a troca é recusada com 422.
Quando a troca é recusada
- assinatura não está ativa ou está pausada;
- a periodicidade enviada é igual à atual;
- já existe uma cobrança em processamento (
409); - a próxima cobrança está dentro da janela do agendador (
409).
Autorizações
bearerAuth
Token Bearer do merchant obtido via POST /oauth2/token usando as
credenciais do merchant (não do app). Veja
Autenticação.
Tipo
HTTP (bearer)
Parâmetros
Parâmetros de Caminho
id*
Identificador da assinatura.
Tipo
Obrigatóriointeger
Exemplo
10Corpo da Requisição
application/json
JSON "interval": "month", "interval_count": 2
{
}
Respostas
Periodicidade alterada. Retorna o detalhe atualizado.
application/json
JSON "data": { "subscription_id": 10, "status": "ACTIVE", "interval": "month", "interval_count": 2, "next_charge_at": "2026-10-15 00:00:00" }
{
}
PATCH
/v1/subscriptions/{id}/frequency