Pular para o conteúdo
Pagamentos

Pausar assinatura

v1.0.0
POSThttps://api.growthaisystem.com/api/v1/subscriptions/{id}/pause
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.write

Interrompe a geração das próximas faturas e a cobrança automática até alguém reativar. Faturas já emitidas continuam pagáveis. Corpo {}. Exige o header Idempotency-Key.

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Corpo da requisição

application/jsonobrigatório
objeto

Respostas

10 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A assinatura pausada (pauseReason: merchant). Já pausada continua pausada com o motivo original. Replay traz idempotency_replay: true.

V1SubscriptionEscrita

  • idstring
  • statusstring
    • um de"active""paused""canceled"
  • pauseReasonstring | null
    • um de"merchant""payment_refused""card_revoked"
  • planIdstring
  • planNamestring
  • amountinteger

    Valor mensal congelado na assinatura, em centavos.

  • currency"BRL"
    • sempre "BRL"
  • paymentMethodstring
    • um de"pix""card"
  • billingModestring
    • um de"checkout""automatic_card"

  • Autorização de débito mensal do comprador, quando houve. Nunca traz o token do cartão.

    • statusstring
      • um de"storing""active""unconfirmed""revoked""unavailable""superseded"
    • brandstring | null
    • last4string | null
    • namestring
    • emailstring
    • taxIdLast4string
  • startDatestring

    Primeiro vencimento (YYYY-MM-DD). Âncora do dia de cobrança.

  • nextCycleNumberinteger
  • nextDueDatestring | null

    Próximo vencimento (YYYY-MM-DD); null quando cancelada.

  • overdueInvoicesinteger

    Faturas vencidas sem pagamento confirmado.

  • externalReferencestring | null
    • chave string
    • valor string | number | boolean | null

    Uma destas formas

    • string
    • number
    • boolean
  • createdAtstring
  • canceledAtstring | null

  • As 24 faturas mais recentes, da mais nova para a mais antiga.

    Cada item — V1SubscriptionInvoice

    • cycleNumberinteger
    • dueDatestring
    • amountinteger
    • chargeIdstring

      A fatura é uma cobrança: GET /charges/{chargeId} traz o detalhe.

    • statusstring
      • um de"open""processing""pending""paid""failed""expired""canceled""refunded""partially_refunded""chargeback""reconciliation_required"
    • overdueboolean
    • checkoutUrlstring (uri)
    • paidAtstring | null
  • idempotency_replaytruepode faltar
    • sempre true