Gerar a fatura para assinar um plano

Gera a fatura da assinatura (ou da troca para um plano maior) do workspace workspaceId; a assinatura começa quando a fatura é paga. planId é obrigatório e precisa ser um plano que o workspace pode contratar (403 quando não está liberado para ele, 404 quando não existe, 409 quando está arquivado); billingCycle é monthly (padrão) ou annual; billingType é a forma de pagamento da fatura; description substitui o texto padrão da fatura. Com uma assinatura ativa, só um plano mais caro é aceito (409). referralCode é o código do afiliado que indicou; vazio, vale o cabeçalho X-Affiliate-Ref ou o cookie affiliate_ref. billingType desconhecido responde 400 payment_method_invalid; uma forma que o provedor de pagamento ativo não cobra responde 422 payment_method_unsupported (veja GET /billing/payment-methods). A cobrança e a nota fiscal saem com os dados de faturamento da área de trabalho (GET /v1/workspace/billing-details); sem eles a resposta é 422 billing_details_required. X-Device-Session-Id fora do formato esperado responde 400 device_session_invalid. As demais respostas de erro desta rota não trazem code. Exige plans:create no workspace do caminho.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID do workspace

Body Params

Plano, ciclo e forma de pagamento

string
string
string
string
string
Headers
string

Identificador do dispositivo de quem paga, gerado no navegador pelo script de segurança do provedor de pagamento; repassado ao provedor para a análise antifraude. Ausente, nada é repassado

string

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json