Skip to main content
POST
Retomar assinatura pausada
POST /subscriptions/:id/resume Faz parte do recurso Assinaturas — o conceito e os dez estados estão lá. Devolve uma assinatura paused para active.
O tempo parado é devolvido, não perdido. currentPeriodEnd e nextInvoiceAt avançam exatamente o quanto durou a pausa, então o cliente não perde ciclo nem paga pelo período em que não usou.
As faturas seguem o mesmo critério da pausa:
  • just_in_time — uma fatura nova é gerada na retomada, porque as anteriores foram anuladas ao pausar;
  • upfront — as congeladas voltam a scheduled, com chargeAt e dueAt deslocados pelo tempo de pausa. Elas não reabrem de imediato: cada uma reabre quando a sua nova data chegar.
A diferença importa para quem espera cobrança logo após a retomada. Em upfront, pode não haver nenhuma naquele dia.
Só assinatura pausada pode ser retomada. Qualquer outro estado responde 409. Se a pausa tinha resumesAt agendado, a retomada manual antecipa o retorno — não é preciso cancelar o agendamento antes.
A retomada tem dois motivos que você não envia: auto_resume_scheduled, quando o resumesAt agendado chegou, e admin_action, quando a retomada partiu do painel. Os dois aparecem no histórico sem passar por esta rota.

Exemplo

Resposta 200
As datas do exemplo saltaram dois meses em relação à pausa: é o tempo parado sendo devolvido ao ciclo.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID da assinatura

Body

application/json
reason
enum<string>
required
Available options:
customer_request,
payment_method_updated,
other
reasonDetails
string
required
Required string length: 1 - 500

Response

Assinatura retomada

id
string

Identificador único do registro.

number
object

Número do endereço.

referenceCode
string | null

Código do contrato no sistema do integrador; pesquisável, sem unicidade.

customerId
string

ID do cliente associado ao registro.

customerEmail
string

E-mail do cliente.

customerName
string

Nome do cliente.

customerDocument
string

Documento do cliente (CPF ou CNPJ).

currency
string

Moeda no padrão ISO 4217 (ex.: BRL).

status
enum<string>

Status atual do registro (assinatura, fatura, plano ou slip de pagamento).

Available options:
incomplete,
incomplete_expired,
trialing,
active,
past_due,
unpaid,
paused,
canceled,
completed
billingGroupId
any | null

ID do grupo de cobrança ao qual o registro pertence; nulo se não agrupado.

currentPeriodStart
string<date-time>

Início do período de cobrança atual da assinatura (ISO 8601).

currentPeriodEnd
string<date-time>

Fim do período de cobrança atual da assinatura (ISO 8601).

nextInvoiceAt
string<date-time> | null

Data e hora prevista para a próxima fatura da assinatura (ISO 8601).

recurrence
object

Regra de recorrência (intervalo, unidade e âncora do ciclo).

collectionMethod
enum<string>

Como a fatura é cobrada. Hoje só a cobrança automática na forma de pagamento padrão.

Available options:
charge_automatically
collectionTiming
enum<string>

Momento da cobrança do ciclo: prepaid (no início) ou postpaid (no fim).

Available options:
prepaid,
postpaid
invoiceGenerationMode
enum<string>

Modo de geração de faturas: just_in_time (a cada ciclo) ou upfront (todas antecipadas).

Available options:
just_in_time,
upfront
cancelAtPeriodEnd
boolean

Indica se a assinatura será cancelada ao fim do período atual.

canceledAt
any | null

Data e hora do cancelamento; nula se não cancelado (ISO 8601).

endedAt
any | null

Data e hora em que a assinatura foi efetivamente encerrada; nula se ainda ativa (ISO 8601).

cancellationReason
any | null

Motivo do cancelamento da assinatura.

pausedAt
any | null

Data e hora em que a assinatura foi pausada; nula se não pausada (ISO 8601).

pauseResumesAt
any | null

Data e hora agendada para a retomada automática da assinatura pausada (ISO 8601).

pauseReason
any | null

Motivo da pausa da assinatura.

trialEnd
any | null

Data e hora de término do período de teste; nula se sem trial (ISO 8601).

incompleteExpiresAt
any | null

Prazo para concluir o primeiro pagamento antes de a assinatura incompleta expirar (ISO 8601).

trialRemindersFired
any[]

Lembretes de fim do período de teste já disparados para a assinatura.

maxCycles
any | null

Número máximo de ciclos da assinatura; nulo se não houver limite.

issuedCycles
integer

Número de ciclos já faturados (faturas emitidas) da assinatura.

completedCycles
integer

Número de ciclos já concluídos (pagos) da assinatura.

defaultPaymentMethodRef
object

Referência da forma de pagamento padrão usada para cobrar a assinatura.

splitConfig
any | null

Configuração de divisão (split) dos valores entre recebedores; nula se sem split.

paymentBehavior
enum<string>

O que fazer quando a primeira cobrança não é aprovada: allow_incomplete cria a assinatura com a fatura em aberto; error_if_incomplete cancela a assinatura.

Available options:
allow_incomplete,
error_if_incomplete
latestInvoiceId
string

ID da fatura mais recente gerada pela assinatura.

paymentUpdateToken
any | null

Token do link público para o cliente atualizar a forma de pagamento; nulo se não gerado.

paymentUpdateMethods
any | null

Formas de pagamento permitidas no link público de troca; nula se não habilitada.

metadata
object

Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).