Skip to main content
PUT
Atualizar assinatura

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Path Parameters

id
string<uuid>
required

Id da assinatura que deseja atualizar

Body

application/json

Envie só os campos que quer alterar. referenceKey, recurrence.interval e trial não podem ser alterados

name
string

Nome da assinatura

Required string length: 1 - 100
merchantId
string<uuid>

Identificador do merchant

items
object[]

Nova lista de itens, que substitui a atual. Não pode ser vazia

Minimum array length: 1
recurrence
object

Aceita só cycles e startAt. O intervalo não pode ser alterado; interval enviado aqui é ignorado sem erro

splitRules
object[]

Nova lista de regras de split, que substitui a atual. Aceita só percentage. Não pode ser vazia

Minimum array length: 1
paymentMethod
object
cancelAtPeriodEnd
boolean

true agenda o cancelamento; false remove o agendamento. Ao agendar com recurrence.cycles definido, cycles passa a ser o ciclo atual mais um; ao remover, volta ao valor anterior. Agendar em assinatura canceled ou expired devolve 409

Example:

true

scheduledCancellationAt
string<date>

Data do cancelamento agendado (YYYY-MM-DD). Exige cancelAtPeriodEnd igual a true, enviado agora ou já salvo, e não pode ser anterior a ontem (UTC). Sem esta data, o cancelamento acontece em trial.endDate ou, sem trial, em recurrence.nextDueDate

Example:

"2025-12-31"

scheduledCancellationReason
string

Motivo do cancelamento agendado (opcional)

Example:

"Cliente solicitou cancelamento"

Response

Success

id
string<uuid>

Identificador da assinatura

Example:

"019860b2-feb8-7edf-b5ba-0c48a7a8bd3f"

name
string

Nome da assinatura

Example:

"Assinatura Premium com Eventos"

clientId
string<uuid>

Identificador do client

Example:

"e234eeb3-483d-4df2-87eb-1e2be5cdaccd"

merchantId
string<uuid>

Identificador do merchant

Example:

"225d39bc-1fbb-480a-90bd-f0caad05d2d0"

customerId
string<uuid>

Identificador do cliente

Example:

"2a8b64ce-904c-4256-b79a-49525808609c"

referenceKey
string

Chave de referência da assinatura

Example:

"SUB-PREMIUM-001"

currency
string

Moeda da assinatura

Example:

"BRL"

items
object[]
recurrence
object
paymentMethod
object
trial
object

Período de trial. Só vem quando a assinatura foi criada com trial

splitRules
object[]

Regras de divisão de valores entre recebedores. Só vem quando a assinatura tem split

status
enum<string>

Status da assinatura

Available options:
created,
active,
paused,
canceled,
unpaid,
expired,
trialing
Example:

"created"

amount
integer

Valor de cada ciclo em centavos, a soma de amount vezes quantity dos itens

Example:

29900

liveMode
boolean

Indica se a assinatura está em modo de produção

Example:

true

lastCycle
object | null

Último ciclo da assinatura. Sempre presente nas respostas individuais (GET, CREATE, UPDATE), pode ser null se não houver ciclos. Não traz items.

createdAt
string<date-time>
Example:

"2025-07-31T13:36:40.118822Z"

updatedAt
string<date-time>
Example:

"2025-07-31T13:36:40.118822Z"

cancelAtPeriodEnd
boolean

Indica se a assinatura tem cancelamento agendado. Enquanto for true, recurrence.cycles mostra o ciclo atual mais um, e o valor anterior volta quando o agendamento é removido

Example:

true

scheduledCancellationAt
string<date>

Data efetiva do cancelamento agendado (YYYY-MM-DD). Só vem quando cancelAtPeriodEnd é true. Sem data enviada, é trial.endDate ou, sem trial, recurrence.nextDueDate

Example:

"2025-12-31"

scheduledCancellationReason
string

Motivo do cancelamento agendado. Só vem quando foi informado

Example:

"Cliente solicitou cancelamento"