ABabacatepay

Alterar plano da assinatura

Changed on

Altera o produto principal de uma assinatura ativa.

A mudança é agendada como PENDING e aplicada automaticamente no início do próximo ciclo de cobrança. Só pode existir uma alteração pendente por assinatura — uma nova chamada substitui a anterior ainda não aplicada.

O produto informado em productId deve ter um ciclo de cobrança definido, igual ao da assinatura. Produtos avulsos (sem ciclo) retornam erro.

post/subscriptions/change-plan

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/subscriptions/change-plan
  • Auth
    HTTP bearer

Request body

idstring required

Identificador único da assinatura a ser alterada.

productIdstring

Identificador do novo produto. Deve ter ciclo de cobrança definido.

quantityinteger

Quantidade do novo produto.

Example request

{
  "id": "subs_abc123xyz",
  "productId": "prod_plano_pro",
  "quantity": 1,
  "items": [
    {
      "productId": "prod_abc123xyz",
      "quantity": 1
    }
  ]
}

Response

Alteração de plano agendada com sucesso.

errorstring nullable
successboolean

Se a requisição obteve sucesso ou não.

Example response

{
  "data": {
    "id": "subu_abc123xyz",
    "subscriptionId": "subs_abc123xyz",
    "status": "PENDING",
    "productId": "prod_plano_pro",
    "quantity": 1,
    "newAmount": 4990,
    "requestedAt": "2024-12-06T20:05:00.000Z"
  },
  "success": true
}

Changes

  • ea8a72b04f2aRevision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional