Platform billing
Ivora's CSMS usage fee for a project (tenant) at /v1/tenants/{tenant_id}/billing-profile, and for the whole team at /v1/teams/{team_id}/billing: a fee per kWh of charging (default 1.00 cent, set per team by Ivora, optionally overridden per project). Billing is per team (company): a team owns one or more projects, the card on file on Ivora's own Stripe account, the waiver, the grace period and one monthly invoice with a line per project. Reading requires billing:read; adding, synchronizing or removing the team's card requires a signed-in user with billing:write on the project or the team's owner, admin or billing role (API keys are refused). Without a usable team card, waiver or grace period, creating stations, locations and CSMS keys, commands other than stop and unlock, setting or clearing charging profiles and session caps, and creating bills and external sessions answer 402 payment_method_required. Reads, OCPP traffic, running charging, stops and starting a bill or session that already exists are never blocked.
15 endpoints
- getRead the project's CSMS usage fee and its team's payment method/v1/tenants/{tenant_id}/billing-profileRequires billing:read, or a signed-in member whose team role manages billing (owner, admin, billing).
- postStart adding or replacing the team's payment method/v1/tenants/{tenant_id}/billing-profile/payment-method/setupSigned-in tenant-admin of the project (and so of any project of the team) or Ivora staff; API keys are refused.
- postRecord the payment method saved on the setup page/v1/tenants/{tenant_id}/billing-profile/payment-method/syncSigned-in tenant-admin or Ivora staff; API keys are refused.
- deleteRemove the team's payment method/v1/tenants/{tenant_id}/billing-profile/payment-methodSigned-in tenant-admin or Ivora staff; API keys are refused.
- getList the team's monthly usage-fee invoices/v1/tenants/{tenant_id}/billing-profile/invoicesRequires billing:read, or a signed-in member whose team role manages billing (owner, admin, billing).
- getEstimate the team's usage fee for the current month/v1/tenants/{tenant_id}/billing-profile/usageRequires billing:read, or a signed-in member whose team role manages billing (owner, admin, billing).
- getRead the team's billing account/v1/teams/{team_id}/billingThe team's owners, admins and billing members (billing:manage), and Ivora staff; API keys are refused.
- postStart adding or replacing the team's payment method/v1/teams/{team_id}/billing/payment-method/setupThe team's owners, admins and billing members, and Ivora administrators; API keys are refused.
- postRecord the payment method saved on the setup page/v1/teams/{team_id}/billing/payment-method/syncThe team's owners, admins and billing members, and Ivora administrators; API keys are refused.
- deleteRemove the team's payment method/v1/teams/{team_id}/billing/payment-methodThe team's owners, admins and billing members, and Ivora administrators; API keys are refused.
- postConnect the team's bank account for enterprise invoices/v1/teams/{team_id}/billing/bank-account/setupEnterprise teams only (409 otherwise).
- postRecord the bank account connected on the setup page/v1/teams/{team_id}/billing/bank-account/syncThe team's owners, admins and billing members, and Ivora administrators; API keys are refused.
- deleteRemove the team's bank account/v1/teams/{team_id}/billing/bank-accountThe team's owners, admins and billing members, and Ivora administrators; API keys are refused.
- getList the team's monthly usage-fee invoices/v1/teams/{team_id}/billing/invoicesThe team's owners, admins and billing members, and Ivora staff; API keys are refused.
- getEstimate the team's usage fee for the current month/v1/teams/{team_id}/billing/usageThe team's owners, admins and billing members, and Ivora staff; API keys are refused.