Assinaturas

O contrato vivo entre um cliente e um plano: ativar, pausar, retomar, trocar de plano e cancelar. create-invoice força uma fatura fora do ciclo.

Comando	HTTP	Descrição
subscriptions list	GET /v1/subscriptions	Listar assinaturas
subscriptions create	POST /v1/subscriptions	Criar assinatura
subscriptions get	GET /v1/subscriptions/{id}	Obter assinatura
subscriptions update	PATCH /v1/subscriptions/{id}	Atualizar assinatura
subscriptions delete	DELETE /v1/subscriptions/{id}	Cancelar e remover assinatura (soft delete)
subscriptions activate	POST /v1/subscriptions/{id}/activate	Ativar assinatura em rascunho/confirmada
subscriptions cancel	POST /v1/subscriptions/{id}/cancel	Cancelar assinatura
subscriptions change-plan	POST /v1/subscriptions/{id}/change-plan	Trocar o plano da assinatura
subscriptions create-invoice	POST /v1/subscriptions/{id}/create-invoice	Gerar uma fatura avulsa para a assinatura
subscriptions items	GET /v1/subscriptions/{id}/items	Listar itens da assinatura
subscriptions pause	POST /v1/subscriptions/{id}/pause	Pausar assinatura
subscriptions resume	POST /v1/subscriptions/{id}/resume	Retomar assinatura pausada
subscriptions revert-to-confirmed	POST /v1/subscriptions/{id}/revert-to-confirmed	Reverter assinatura para o estado confirmado
subscriptions sync-plan-items	POST /v1/subscriptions/{id}/sync-plan-items	Ressincronizar itens com o plano atual

Exemplos

--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar assinaturas
kobana billing subscriptions list \
  --fields "id,public_id,external_id,billing_account_id,company_id"

# Obter assinatura
kobana billing subscriptions get --params '{"id": "SUBSCRIPTION_ID"}'

# Criar assinatura
kobana billing subscriptions create \
  --json '{"billing_account_id": "BILLING_ACCOUNT_ID"}'

# Atualizar assinatura
kobana billing subscriptions update \
  --params '{"id": "SUBSCRIPTION_ID"}' \
  --json '{"external_id": "EXTERNAL_ID", "plan_id": "PLAN_ID", "billing_cycle": "monthly"}'

# Ativar assinatura em rascunho/confirmada
kobana billing subscriptions activate --params '{"id": "SUBSCRIPTION_ID"}'

# Cancelar e remover assinatura (soft delete)
kobana billing subscriptions delete \
  --params '{"id": "SUBSCRIPTION_ID"}' \
  --dry-run

Próximos passos

• Mudanças de assinatura
• Introspecção de schema — todos os parâmetros que este recurso aceita.