Catálogo do que pode ser cobrado

Lista os produtos de assinatura à venda, com os planos de cada um, e a
sua integração via API em meta.integration. Escopo plans:read.

billing_methods dentro de cada plano é exatamente o que a adesão
aceita naquele lugar; default_billing_method do plano é a forma
usada quando a adesão ali não informa billing_method (null = é
preciso informar).

Um plano pode aparecer dentro de um produto e em
meta.integration, com listas diferentes: a do produto vale para
adesão com product; a de meta.integration, para adesão sem product.

Plano criado dentro de um produto à venda (vínculo ativo) só aparece
no produto. Com o produto pausado, arquivado ou apagado, ou o vínculo
inativo, ele passa para meta.integration.

billing_methods no topo do produto e em meta.integration é a
união das listas dos planos (resumo). default_billing_method
no topo do produto é o padrão configurado no produto.

meta.integration aparece igual em todas as páginas e traz no
máximo 200 planos (do mais antigo para o mais novo). Acima
disso, plans_truncated: true; os planos fora da lista continuam
aceitando adesão pelo token.

credit_card só aparece com as liberações de cartão da conta.

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

{ "data": [ { "reference_id": "5e0c1a2b-0000-4000-8000-00000000a501", "name": "Clinix Agenda", "billing_methods": [ "qr_code", "pix_automatico" ], "default_billing_method": "qr_code", "plans": [ { "token": "9d1f0000-0000-4000-8000-00000000c001", "name": "Clinix Mensal", "amount": "97.00", "periodicity_days": 30, "billing_methods": [ "qr_code", "pix_automatico" ], "default_billing_method": "qr_code" }, { "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Studio Nuvem Mensal", "amount": "49.90", "periodicity_days": 30, "billing_methods": [ "qr_code" ], "default_billing_method": "qr_code" } ] } ], "meta": { "integration": { "billing_methods": [ "qr_code", "pix_automatico", "credit_card" ], "plans": [ { "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Studio Nuvem Mensal", "amount": "49.90", "periodicity_days": 30, "billing_methods": [ "pix_automatico", "credit_card" ], "default_billing_method": "pix_automatico" }, { "token": "b2c3d4e5-0000-4000-8000-00000000a002", "name": "Studio Nuvem Plus", "amount": "39.90", "periodicity_days": 30, "billing_methods": [ "qr_code", "pix_automatico" ], "default_billing_method": "qr_code" } ], "plans_truncated": false }, "total": 1, "current_page": 1, "per_page": 15, "last_page": 1 } }

Catálogo do que pode ser cobrado

Requisição

Respostas