Sign in

v1

latestOpenAPI 3.0.32026-07-2647114182.1 KB
subscriptions

Atualiza campos da assinatura.

put/public_api/subscriptions/{id}/

Path parameters

idstring uuid required

Id da assinatura.

Request body

object required

Response

Assinatura atualizada.

idstring required

Identificador único da assinatura

status'active' | 'inactive' | 'canceled' | 'expired' | 'paused' | 'trial' required
  • active - Ativa
  • inactive - Inativa
  • canceled - Cancelada
  • expired - Expirada
  • paused - Pausada
  • trial - Em período de teste
current_periodinteger

Período atual da assinatura

recurrence_periodinteger

Quantidade de dias entre cada cobrança

quantity_recurrencesinteger

Quantidade total de recorrências configuradas

trial_daysinteger

Dias de teste configurados na assinatura

max_retriesinteger

Número máximo de tentativas de cobrança

amountstring decimal required

Valor da assinatura

retry_intervalinteger

Intervalo entre tentativas de cobrança

paid_payments_quantityinteger

Quantidade de pagamentos já efetuados

retentionstring

Tempo em que a assinatura permaneceu ativa

parent_orderobject required

Pedido de origem da assinatura

paymentMethodobject required

Método de pagamento usado na assinatura

customerobject required

Cliente associado à assinatura

productobject required

Produto associado à assinatura

offerobject required

Oferta associada à assinatura

ordersobject[]

Pedidos vinculados à assinatura

next_payment_datestring date-time nullable

Data estimada do próximo pagamento

createdAtstring date-time required

Data de criação

updatedAtstring date-time required

Data da última atualização

canceledAtstring date-time nullable

Data de cancelamento