Skip to main content
PUT
Atualizar assinatura

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
_id
string
required
Minimum string length: 1
companyId
string
required
Minimum string length: 1
productId
string
Minimum string length: 1

Response

Assinatura atualizada.

_id
string

ID da assinatura.

companyId
string

ID da empresa vinculada a assinatura.

clientId
string

ID do cliente assinante.

productId
string

ID do produto vinculado.

status
enum<string>

Status atual da assinatura.

Available options:
ACTIVE,
ERROR_PAYMENT,
NO_PAYMENT_ROUTE,
CREATED,
PENDING_PAYMENT,
RECOVERED,
NO_PAYMENT,
CANCELED_ALERT_ETHOCA,
BLOCKED,
CANCELED_MANUAL,
IMPORTED,
STANDBY,
OVERDUE
paymentMethod
enum<string>

Metodos de pagamento disponiveis para a assinatura.

Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
PIX
installments
number

Quantidade de parcelas configurada.

nextCharge
string<date-time>

Proxima data de cobranca, quando disponivel.

origin
enum<string>

Origem da criacao da assinatura.

Available options:
API,
CHECKOUT,
IMPORTED,
AFFILIATE
referenceId
string

Referencia externa da sua aplicacao.

metadata
object

Metadados livres vinculados a assinatura.

active
boolean

Indica se a assinatura esta ativa.

createdAt
string<date-time>

Data de criacao da assinatura.

lastUpdate
string<date-time>

Data da ultima atualizacao da assinatura.