Atualizar plano
Altera os campos enviados de um plano. As assinaturas já criadas mantêm os termos originais.
apiKeyAuthorizationBearer <token>Chave de API da conta: Authorization: Bearer <chave de API>.
id*stringId do plano.
application/json- body
Envie só os campos que vão mudar.
name?stringNome do plano.
1 <= length <= 150amountCents?integerValor de cada ciclo em centavos.
100 <= valuepaymentMethods?array<>Meio de pagamento do plano.
1 <= itemstype?PlanTypePIX_RECURRING para Pix Automático; RECURRENT para cartão.
"PIX_RECURRING""RECURRENT"frequency?PlanFrequencyPeriodicidade: semanal, mensal, semestral ou anual.
"WEEKLY""MONTHLY""SEMIANNUALLY""ANNUALLY"pixRecurringOptions?|Mesclado com as opções atuais: enviar só journey mantém o
retryPolicy e o minimumValue já gravados. null volta às opções
padrão.
passthroughFees?booleanNão pode mudar. Enviar o valor atual é aceito; enviar outro valor
responde 400.
dayDue?integerPix. Dias até a cobrança de cada ciclo vencer.
3 <= valueinstallmentCount?integerNúmero de ciclos.
1 <= valuecomment?stringAnotação interna sua.
length <= 500Plano atualizado.
application/json- response
id?stringId do plano (ULID).
name?stringNome do plano.
comment?|Anotação interna.
amountCents?integerValor de cada ciclo em centavos.
currency?stringMoeda. Sempre BRL.
dayDue?|Dias até a cobrança de cada ciclo vencer (Pix).
type?PlanTypePIX_RECURRING para Pix Automático; RECURRENT para cartão.
"PIX_RECURRING""RECURRENT"frequency?PlanFrequencyPeriodicidade: semanal, mensal, semestral ou anual.
"WEEKLY""MONTHLY""SEMIANNUALLY""ANNUALLY"installmentCount?|Número de ciclos. null = contínua.
paymentMethods?array<>Meio de pagamento do plano.
pixRecurringOptions?|Opções do Pix Automático, já com os padrões aplicados. null em plano de cartão.
passthroughFees?booleanSe o repasse de tarifa está ligado.
isArchived?booleanSe o plano está arquivado. Plano arquivado não aceita assinatura nova nem edição.
createdAt?stringCriação, em UTC.
date-timeupdatedAt?stringÚltima alteração, em UTC.
date-timecurl -X PATCH 'https://api.gates2b.com/plan/string' \ -H 'Content-Type: application/json' \ -d '{ "amountCents": 10990}'{ "id": "01JB7Y2M3N4P5Q6R7S8T9V0W1X", "name": "Plano Mensal Premium", "comment": null, "amountCents": 10990, "currency": "BRL", "dayDue": null, "type": "PIX_RECURRING", "frequency": "MONTHLY", "installmentCount": null, "paymentMethods": [ "PIX" ], "pixRecurringOptions": { "journey": "ONLY_RECURRENCY", "retryPolicy": "THREE_RETRIES_7_DAYS" }, "passthroughFees": false, "isArchived": false, "createdAt": "2026-05-28T13:00:00.000Z", "updatedAt": "2026-06-02T09:30:00.000Z"}Como funciona
Cada assinatura guarda uma cópia dos termos do plano no momento em que foi
criada, em planSnapshot. Atualizar o plano muda só o modelo: as assinaturas
existentes continuam cobrando o valor copiado.
Plano
- amountCents: 10990
Assinatura de março
- cobra 9990
Assinatura de abril
- cobra 9990
Assinatura nova
- cobra 10990
Para saber quantas assinaturas ativas estão com valor diferente do plano, veja
outdatedSubscriptionsCount em Listar planos.
curl -X PATCH "https://api.gates2b.com/plan/01JB7Y2M3N4P5Q6R7S8T9V0W1X" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{ "amountCents": 10990 }'Regras
- Envie só o que vai mudar. Os campos ausentes ficam como estão.
- A mudança vale para as assinaturas criadas depois. As existentes continuam
cobrando o que está no
planSnapshotdelas. pixRecurringOptionsé mesclado: enviar sójourneymantém oretryPolicye ominimumValueatuais.nullvolta às opções padrão.passthroughFeesnão muda depois da criação. Enviar o valor atual é aceito; um valor diferente responde400. Para mudar o repasse, crie outro plano.- Plano arquivado não pode ser editado: responde
400.