Alterar o desconto da assinatura

PATCH

/v1/subscriptions/{id}/discount

Define o desconto da assinatura. Pode ser chamado a qualquer momento — para adicionar, alterar ou remover o desconto — e vale a partir da próxima cobrança gerada.

O desconto pode ser nominal (valor fixo em reais) ou percentual. No percentual, o desconto incide sobre o valor dos produtos e é recalculado a cada cobrança: se a composição da assinatura mudar, o desconto acompanha. O frete é somado depois do desconto e nunca é descontado.

Envie discount: 0 para remover o desconto.

TIP

Uma cobrança que já está em cobrança vencida (retentativa) não é afetada — ela reutiliza o pedido que já havia sido gerado. A alteração vale do próximo ciclo em diante.

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

integer

Obrigatório

Exemplo10

Corpo da Requisição

application/json

{

  

"discount": 40,

  

"discount_type": "nominal"

}

Respostas

Desconto atualizado. Retorna o detalhe atualizado da assinatura.

Content-Type

application/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,

  

  

"discount": 10,

  

  

"discount_type": "percent",

  

  

"interval": "month",

  

  

"interval_count": 1,

  

  

"current_cycle": 3,

  

  

"completed_cycles": 2,

  

  

"customer": {

  

  

  

"name": "Maria Silva",

  

  

  

"email": "[email protected]",

  

  

  

"document": "12345678909",

  

  

  

"phone": "11999999999",

  

  

  

"address": {

  

  

  

  

"country": "BR",

  

  

  

  

"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

  

  

  

]

  

  

],

  

  

"cycle_changes": [

  

  

  

{

  

  

  

  

"cycle_index": 3,

  

  

  

  

"status": "UNBILLED",

  

  

  

  

"added": [

  

  

  

  

  

{

  

  

  

  

  

  

"name": "Caneca Appmax",

  

  

  

  

  

  

"sku": "CAN-1",

  

  

  

  

  

  

"quantity": 1,

  

  

  

  

  

  

"price": 30,

  

  

  

  

  

  

"variant_id": "48304785031422",

  

  

  

  

  

  

"shopify_product_id": "9260400836862",

  

  

  

  

  

  

"product_id": 42,

  

  

  

  

  

  

"image_url": "string",

  

  

  

  

  

  

"compare_at_price": 0

  

  

  

  

  

}

  

  

  

  

],

  

  

  

  

"removed": [

  

  

  

  

  

{

  

  

  

  

  

  

"name": "Caneca Appmax",

  

  

  

  

  

  

"sku": "CAN-1",

  

  

  

  

  

  

"quantity": 1,

  

  

  

  

  

  

"price": 30,

  

  

  

  

  

  

"variant_id": "48304785031422",

  

  

  

  

  

  

"shopify_product_id": "9260400836862",

  

  

  

  

  

  

"product_id": 42,

  

  

  

  

  

  

"image_url": "string",

  

  

  

  

  

  

"compare_at_price": 0

  

  

  

  

  

}

  

  

  

  

],

  

  

  

  

"quantity_changes": [

  

  

  

  

  

{

  

  

  

  

  

  

"reference": "48304785031422",

  

  

  

  

  

  

"quantity": 3,

  

  

  

  

  

  

"previous_quantity": 2,

  

  

  

  

  

  

"name": "Caneca Appmax",

  

  

  

  

  

  

"sku": "CAN-1",

  

  

  

  

  

  

"variant_id": "48304785031422",

  

  

  

  

  

  

"shopify_product_id": "9260400836862",

  

  

  

  

  

  

"product_id": 42,

  

  

  

  

  

  

"image_url": "string",

  

  

  

  

  

  

"compare_at_price": 0

  

  

  

  

  

}

  

  

  

  

]

  

  

  

}

  

  

],

  

  

"original_order_id": 126509440,

  

  

"original_shopify_order_id": "7217346216132",

  

  

"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}/discount

Exemplos

Sandboxhttps://api.sandboxappmax.com.br

Parâmetros da URL

id

Authorization (Bearer)

Cole uma vez e use em todos os playgrounds — o token fica salvo somente nesta aba do navegador e é apagado quando ela for fechada.

Corpo

{
  "discount": 40,
  "discount_type": "nominal"
}

Duplo clique no JSON para editar