Atualizar a tag da assinatura
PATCH
/v1/subscriptions/{id}/tag
Define o apelido da assinatura — um rótulo livre de até 255 caracteres que você escolhe para identificar a assinatura nos seus relatórios.
Envie tag vazia ("" ou null) para remover o apelido. Sem apelido
definido, todas as respostas da API devolvem o padrão #assinatura{id}.
TIP
A tag não aparece no painel Appmax nem no portal do assinante — ela existe apenas nas respostas desta API.
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 "tag": "Clube do Whey"
{
}
Respostas
Tag atualizada. Retorna o detalhe atualizado da assinatura.
application/json
JSON "data": { "subscription_id": 10, "tag": "Clube do Whey", "status": "ACTIVE", "products": [ { "name": "Camiseta Preta", "shopify_product_id": "string", "variant_id": "string", "product_id": 55, "sku": "SKU-1", "quantity": 1, "price": 199.9, "image_url": "string", "compare_at_price": 0 } ], "value": 199.9, "freight_value": 19.9, "interval": "month", "interval_count": 1, "current_cycle": 3, "completed_cycles": 2, "customer": { "name": "Maria Silva", "document": "12345678909", "phone": "11999999999", "address": { "street": "Rua São Bento", "number": "111", "complement": "Bloco 7", "district": "Centro", "city": "São Paulo", "state": "SP", "postcode": "01010000" } }, "payment": { "payment_info": { "brand": "visa", "final": "1234", "expiration": "12/2029" } }, "max_cycles": 12, "skipped_cycles": [ [ 3 ] ], "next_charge_at": "2026-08-15 00:00:00", "last_charge_at": "15/07/2026", "charges": [ { "cycle": 1, "order_id": 12345, "shopify_order_id": "6868591542526", "charged_at": "15/07/2026", "value": 199.9, "status": "paid" } ], "created_at": "2026-06-15 10:00:00", "canceled_at": "string", "paused_from": "string", "paused_until": "string", "pause_reason": "Cliente vai viajar", "cancel_reason": "Achou caro" }
{
}
PATCH
/v1/subscriptions/{id}/tag