Criar assinatura
POST
/v1/subscriptions
Cria uma assinatura a partir de um pedido existente. O pedido informado
em order_id é transformado em uma cobrança recorrente.
Pré-requisitos do pedido
- Deve existir e pertencer à mesma loja das credenciais.
- Forma de pagamento deve ser cartão de crédito ou PIX.
- Status deve ser aprovado ou integrado (ou seja, já liberado pelo antifraude).
Um mesmo pedido pode originar mais de uma assinatura.
Pedidos originados de um checkout Shopify
Quando o pedido tem carrinho Shopify vinculado, products é obrigatório e
cada item precisa de shopify_product_id e shopify_variant_id (o preço é
lido da variante na Shopify, não do payload).
- Com
intervalinformado, a cadência enviada vale para todos os itens. - Sem
interval, a cadência vem do plano de assinatura da variante e todos os itens precisam ter a mesma frequência.
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)
Corpo da Requisição
application/json
JSON "order_id": 12345, "interval": "month", "interval_count": 1, "max_cycles": 12, "products": [ { "product_id": 55, "quantity": 1 } ], "freight_value": 19.9, "discount": 10
{
}
Respostas
Assinatura criada com sucesso.
application/json
JSON "data": { "id": 10, "uuid": "6f1c0f1e-6a1c-4a2b-9f0e-3d5c7a9b1234", "status": "active", "subscription_status_id": 1, "interval": "month", "interval_count": 1, "interval_name": "Mensal", "charge_day": 15, "fail_max_tries": 3, "fail_interval_hours": 24, "max_cycles": 12, "completed_cycles": 0, "current_cycle": 1, "next_charge_at": "2026-08-15 00:00:00", "created_at": "2026-07-15 10:00:00", "freight_value": 19.9, "products": [ { "name": "Camiseta Preta", "price": 199.9, "quantity": 1, "product_id": 55, "shopify_product_id": null, "variant_id": null, "sku": "SKU-1", "image_url": null, "compare_at_price": null } ], "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" } }, "charges": [ { "cycle": 0, "order_id": 12345, "shopify_order_id": null, "charged_at": "15/07/2026", "value": 209.8, "status": "paid" } ], "panel_url": "https://assinaturas.appmax.com.br/painel/6f1c0f1e-6a1c-4a2b-9f0e-3d5c7a9b1234" }
{
}
POST
/v1/subscriptions