💳 API de Faturamento e Uso
Transições de plano, faturamento e consumo de recursos. Limites de cota em nível de namespace e rastreamento de uso.
- Categoria: Plataforma
- Complexidade: moderada
- Caminhos: 25 | Schemas: 101
- Nível: Standard
- Domínios relacionados:
system,users
Casos de Uso
Seção intitulada “Casos de Uso”- Gerenciar planos de assinatura e transições de faturamento
- Configurar métodos de pagamento e faturas
- Rastrear o uso de cotas de recursos entre namespaces
- Monitorar limites de uso e capacidade
Recursos Principais
Seção intitulada “Recursos Principais”- subscription: Assinatura para direitos de serviço
- quota: Cota de recursos para limites de uso
- usage_report: Relatório de uso para rastreamento de consumo
Endpoints
Seção intitulada “Endpoints”| Método | Caminho | Descrição |
|---|---|---|
| POST | /api/data/namespaces/system/billing/usage_summary | Resumo de Uso de Faturamento. |
| GET | /api/web/namespaces/{namespace}/usage/invoice_pdf | ObterPdfDaFatura. |
| GET | /api/web/namespaces/{namespace}/usage/invoices/custom_list | Listar faturas. |
| POST | /api/web/namespaces/{namespace}/billing/payment_method/{name}/primary | Tornar cartão de crédito principal. |
| POST | /api/web/namespaces/{namespace}/billing/payment_method/{name}/secondary | Tornar método de pagamento secundário. |
| POST | /api/web/namespaces/{namespace}/billing/payment_method/{name}/swap-primary | Tornar método de pagamento secundário. |
| POST | /api/web/namespaces/{namespace}/billing/payment_methods | Criar especificação de método de pagamento. |
| DELETE | /api/web/namespaces/{namespace}/billing/payment_methods/{name} | EXCLUIR o método de pagamento especificado. |
| GET | /no_auth/namespaces/system/billing/plan_transition | ObterTransiçãoDePlano. |
| POST | /api/web/namespaces/{namespace}/billing/plan_transition | IniciarTransiçãoDePlano. |
| POST | /api/web/namespaces/{metadata.namespace}/quotas | Criar Cota. |
| PUT | /api/web/namespaces/{metadata.namespace}/quotas/{metadata.name} | Substituir Cota. |
| GET | /api/web/namespaces/{namespace}/quota/limits | GET Personalizado de Limites de Cota. |
| GET | /api/web/namespaces/{namespace}/quota/usage | GET de Uso de Cota. |
| GET | /api/web/namespaces/{namespace}/quotas | Listar Cota. |
| GET | /api/web/namespaces/{namespace}/quotas/{name} | GET de Cota |
| DELETE | /api/web/namespaces/{namespace}/quotas/{name} | EXCLUIR Cota. |
| GET | /api/web/namespaces/{namespace}/subscriptions/custom_list | Listar Assinaturas. |
| POST | /api/web/namespaces/system/addon/subscribe | Assinar serviços de addon XC. |
| POST | /api/web/namespaces/system/addon/unsubscribe | Cancelar assinatura de serviços de addon XC. |
| POST | /api/web/namespaces/{namespace}/current_usage | Listar detalhes de uso atual. |
| POST | /api/web/namespaces/{namespace}/hourly_usage_details | Listar detalhes de uso por hora. |
| POST | /api/web/namespaces/{namespace}/monthly_usage | Listar detalhes de uso mensal. |
| POST | /api/web/namespaces/{namespace}/usage_details | Listar detalhes de uso. |
| GET | /api/web/namespaces/system/usage_plans/current | GET do plano de uso atual. |
| GET | /api/web/namespaces/system/usage_plans/custom_list | Listar Planos de Uso. |