mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-26 00:17:43 +00:00
docs(legal): remove billing page to redirect to the HubSpot KBA URL (#10488)
Removed the billing md document and updated the links to the HubSpot KBA -> https://help.zitadel.com/pricing-and-billing-of-zitadel-services Co-authored-by: Maximilian <mpa@zitadel.com>
This commit is contained in:
Federico Coppede
@@ -31,7 +31,6 @@ You agree that we may delete any data on our systems or networks, if CAOS believ
|
||||
|
||||
You agree to adhere to the following fair use limits:
|
||||
|
||||
- [Actions minutes](../service-description/billing.md#action-minutes): A monthly limit of 1'000 Action minutes per instance
|
||||
- Usage limits that were agreed by both parties in advance for the duration of the term
|
||||
|
||||
## Violations of this policy
|
||||
|
||||
@@ -1,82 +0,0 @@
|
||||
---
|
||||
title: Pricing and billing of ZITADEL services
|
||||
sidebar_label: Billing
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
Last updated on November 15, 2023
|
||||
|
||||
This annex of the [Framework Agreement](../terms-of-service) describes the pricing and billing of our Services.
|
||||
|
||||
## Pricing
|
||||
|
||||
You can find pricing information on our [website](https://zitadel.com/pricing).
|
||||
|
||||
### Enterprise pricing
|
||||
|
||||
Customer and ZITADEL may agree on an individual per-customer pricing via an Enterprise Agreement.
|
||||
|
||||
## Billing Metrics
|
||||
|
||||
### Monthly amount
|
||||
|
||||
Monthly amount means the available usage per measure for one billing period.
|
||||
The amount is reset to zero with the start of a new billing period.
|
||||
|
||||
### Daily active user (DAU)
|
||||
|
||||
Daily Active Users (DAU) are counted as users who authenticate or refresh their token during the given day.
|
||||
To calculate the monthly amount we take the sum of DAU over a given month.
|
||||
Included are users that either login with local accounts or users that login with an external identity provider.
|
||||
Service users that authenticate or access the management API are counted against Daily Active Users.
|
||||
|
||||
### Active external identity providers
|
||||
|
||||
To calculate the monthly amount we take the sum of activated external identity providers over all instances on each day and calculate the average over a given month, rounded up to the next integer.
|
||||
Excluded are configured identity providers that are not activated.
|
||||
|
||||
### Action minutes
|
||||
|
||||
Action minutes mean execution time, rounded up to 1 second, of custom code execution via a customer defined Action.
|
||||
|
||||
### Management API requests
|
||||
|
||||
Management API requests means any request to the following API endpoints requiring a valid authorization header.
|
||||
Excluded are requests with a server error, public endpoints, health endpoints, and endpoints to load UI assets.
|
||||
|
||||
Management endpoints:
|
||||
|
||||
- /zitadel.*
|
||||
- /v2alpha*
|
||||
- /v2beta*
|
||||
- /v2*
|
||||
- /admin*
|
||||
- /management*
|
||||
- /system*
|
||||
|
||||
### Admin users
|
||||
|
||||
Admin users means users within the customer portal that can manage a customer's account including billing, instances, analytics and additional services.
|
||||
|
||||
### Audit trail history (events)
|
||||
|
||||
Audit trail history (events) means past events that can be retrieved via API or GUI.
|
||||
Typically all changes to any object in within ZITADEL are saved as events and can be used for audit trail and analytics purposes.
|
||||
The number of past events that can be retrieved may be limited by your subscription.
|
||||
|
||||
### Access and runtime logs (logs)
|
||||
|
||||
Access and runtime logs (logs) means logs that are available about your instance.
|
||||
Logs may contain information about success or failure reasons for API requests and Action executions, output from Actions, rate limit violations, and system health.
|
||||
You might be able to retrieve logs only for a limited period of time based on your subscription.
|
||||
|
||||
### Custom domains
|
||||
|
||||
Custom domains mean domains that you can configure to reach your ZITADEL instance.
|
||||
By default ZITADEL creates a custom domain for you when creating new instances.
|
||||
Besides the included amount each additional custom domain is charged.
|
||||
|
||||
## Payment cycle
|
||||
|
||||
If not agreed otherwise, the payment frequency is monthly.
|
||||
Your invoice will contain both pre-paid items for the current billing period and usage-based charges from the last billing period.
|
||||
@@ -17,7 +17,7 @@ This annex of the [Framework Agreement](../terms-of-service) describes the servi
|
||||
You will benefit from the same software as the open-source project, but we take care of the hosting, maintenance, backup, scaling, and operational security. The cloud service is managed and maintained by the team that also develops the software.
|
||||
|
||||
When creating a new instance, you are able to choose a [data location](#data-location).
|
||||
We follow a single-provider strategy by minimizing the involved [sub-processors](../subprocessors.md) to increase security, compliance, and performance of our services. [Billing](./billing.md) is based on effective usage of our services.
|
||||
We follow a single-provider strategy by minimizing the involved [sub-processors](../subprocessors.md) to increase security, compliance, and performance of our services. [Billing](https://help.zitadel.com/pricing-and-billing-of-zitadel-services) is based on effective usage of our services.
|
||||
|
||||
### Enterprise license / self-hosted
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
|
||||
const sidebar_api_auth = require("./docs/apis/resources/auth/sidebar.ts").default
|
||||
const sidebar_api_auth = require("./docs/apis/resources/auth/sidebar.ts").default
|
||||
const sidebar_api_mgmt = require("./docs/apis/resources/mgmt/sidebar.ts").default
|
||||
const sidebar_api_admin = require("./docs/apis/resources/admin/sidebar.ts").default
|
||||
const sidebar_api_system = require("./docs/apis/resources/system/sidebar.ts").default
|
||||
@@ -683,7 +683,7 @@ module.exports = {
|
||||
title: "User Service API",
|
||||
slug: "/apis/resources/user_service_v2",
|
||||
description:
|
||||
"This API is intended to manage users in a ZITADEL instance.\n",
|
||||
"This API is intended to manage users in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_user_service_v2,
|
||||
},
|
||||
@@ -695,7 +695,7 @@ module.exports = {
|
||||
title: "Session Service API",
|
||||
slug: "/apis/resources/session_service_v2",
|
||||
description:
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n",
|
||||
"This API is intended to manage sessions in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_session_service_v2,
|
||||
},
|
||||
@@ -707,7 +707,7 @@ module.exports = {
|
||||
title: "OIDC Service API",
|
||||
slug: "/apis/resources/oidc_service_v2",
|
||||
description:
|
||||
"Get OIDC Auth Request details and create callback URLs.\n",
|
||||
"Get OIDC Auth Request details and create callback URLs.\n",
|
||||
},
|
||||
items: sidebar_api_oidc_service_v2,
|
||||
},
|
||||
@@ -731,7 +731,7 @@ module.exports = {
|
||||
title: "Settings Service API",
|
||||
slug: "/apis/resources/settings_service_v2",
|
||||
description:
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n",
|
||||
"This API is intended to manage settings in a ZITADEL instance.\n",
|
||||
},
|
||||
items: sidebar_api_settings_service_v2,
|
||||
},
|
||||
@@ -743,7 +743,7 @@ module.exports = {
|
||||
title: "Feature Service API",
|
||||
slug: "/apis/resources/feature_service_v2",
|
||||
description:
|
||||
'This API is intended to manage features for ZITADEL. Feature settings that are available on multiple "levels", such as instance and organization. The higher level instance acts as a default for the lower level. When a feature is set on multiple levels, the lower level takes precedence. Features can be experimental where ZITADEL will assume a sane default, such as disabled. When over time confidence in such a feature grows, ZITADEL can default to enabling the feature. As a final step we might choose to always enable a feature and remove the setting from this API, reserving the proto field number. Such removal is not considered a breaking change. Setting a removed field will effectively result in a no-op.\n',
|
||||
'This API is intended to manage features for ZITADEL. Feature settings that are available on multiple "levels", such as instance and organization. The higher level instance acts as a default for the lower level. When a feature is set on multiple levels, the lower level takes precedence. Features can be experimental where ZITADEL will assume a sane default, such as disabled. When over time confidence in such a feature grows, ZITADEL can default to enabling the feature. As a final step we might choose to always enable a feature and remove the setting from this API, reserving the proto field number. Such removal is not considered a breaking change. Setting a removed field will effectively result in a no-op.\n',
|
||||
},
|
||||
items: sidebar_api_feature_service_v2,
|
||||
},
|
||||
@@ -755,7 +755,7 @@ module.exports = {
|
||||
title: "Organization Service API",
|
||||
slug: "/apis/resources/org_service/v2",
|
||||
description:
|
||||
"This API is intended to manage organizations for ZITADEL. \n",
|
||||
"This API is intended to manage organizations for ZITADEL. \n",
|
||||
},
|
||||
items: sidebar_api_org_service_v2,
|
||||
},
|
||||
@@ -767,7 +767,7 @@ module.exports = {
|
||||
title: "Organization Service Beta API",
|
||||
slug: "/apis/resources/org_service/v2beta",
|
||||
description:
|
||||
"This beta API is intended to manage organizations for ZITADEL. Expect breaking changes to occur. Please use the v2 version for a stable API. \n",
|
||||
"This beta API is intended to manage organizations for ZITADEL. Expect breaking changes to occur. Please use the v2 version for a stable API. \n",
|
||||
},
|
||||
items: sidebar_api_org_service_v2beta,
|
||||
},
|
||||
@@ -779,7 +779,7 @@ module.exports = {
|
||||
title: "Identity Provider Service API",
|
||||
slug: "/apis/resources/idp_service_v2",
|
||||
description:
|
||||
"This API is intended to manage identity providers (IdPs) for ZITADEL.\n",
|
||||
"This API is intended to manage identity providers (IdPs) for ZITADEL.\n",
|
||||
},
|
||||
items: sidebar_api_idp_service_v2,
|
||||
},
|
||||
@@ -791,9 +791,9 @@ module.exports = {
|
||||
title: "Web Key Service API",
|
||||
slug: "/apis/resources/webkey_service_v2",
|
||||
description:
|
||||
"This API is intended to manage web keys for a ZITADEL instance, used to sign and validate OIDC tokens.\n" +
|
||||
"\n"+
|
||||
"The public key endpoint (outside of this service) is used to retrieve the public keys of the active and inactive keys.\n",
|
||||
"This API is intended to manage web keys for a ZITADEL instance, used to sign and validate OIDC tokens.\n" +
|
||||
"\n" +
|
||||
"The public key endpoint (outside of this service) is used to retrieve the public keys of the active and inactive keys.\n",
|
||||
},
|
||||
items: sidebar_api_webkey_service_v2
|
||||
},
|
||||
@@ -805,16 +805,16 @@ module.exports = {
|
||||
title: "Action Service API (Beta)",
|
||||
slug: "/apis/resources/action_service_v2",
|
||||
description:
|
||||
"This API is intended to manage custom executions and targets (previously known as actions) in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n"+
|
||||
"\n" +
|
||||
"The version 2 of actions provide much more options to customize ZITADELs behaviour than previous action versions.\n" +
|
||||
"Also, v2 actions are available instance-wide, whereas previous actions had to be managed for each organization individually\n" +
|
||||
"ZITADEL doesn't restrict the implementation languages, tooling and runtime for v2 action executions anymore.\n" +
|
||||
"Instead, it calls external endpoints which are implemented and maintained by action v2 users.\n"+
|
||||
"\n" +
|
||||
"Please make sure to enable the `actions` feature flag on your instance to use this service and that you're running Zitadel V3.",
|
||||
"This API is intended to manage custom executions and targets (previously known as actions) in a ZITADEL instance.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n" +
|
||||
"\n" +
|
||||
"The version 2 of actions provide much more options to customize ZITADELs behaviour than previous action versions.\n" +
|
||||
"Also, v2 actions are available instance-wide, whereas previous actions had to be managed for each organization individually\n" +
|
||||
"ZITADEL doesn't restrict the implementation languages, tooling and runtime for v2 action executions anymore.\n" +
|
||||
"Instead, it calls external endpoints which are implemented and maintained by action v2 users.\n" +
|
||||
"\n" +
|
||||
"Please make sure to enable the `actions` feature flag on your instance to use this service and that you're running Zitadel V3.",
|
||||
},
|
||||
items: sidebar_api_actions_v2,
|
||||
},
|
||||
@@ -826,12 +826,12 @@ module.exports = {
|
||||
title: "Instance Service API (Beta)",
|
||||
slug: "/apis/resources/instance_service_v2",
|
||||
description:
|
||||
"This API is intended to manage instances, custom domains and trusted domains in ZITADEL.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n"+
|
||||
"\n" +
|
||||
"This v2 of the API provides the same functionalities as the v1, but organised on a per resource basis.\n" +
|
||||
"The whole functionality related to domains (custom and trusted) has been moved under this instance API."
|
||||
"This API is intended to manage instances, custom domains and trusted domains in ZITADEL.\n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.\n" +
|
||||
"\n" +
|
||||
"This v2 of the API provides the same functionalities as the v1, but organised on a per resource basis.\n" +
|
||||
"The whole functionality related to domains (custom and trusted) has been moved under this instance API."
|
||||
,
|
||||
},
|
||||
items: sidebar_api_instance_service_v2,
|
||||
@@ -844,9 +844,9 @@ module.exports = {
|
||||
title: "Project Service API (Beta)",
|
||||
slug: "/apis/resources/project_service_v2",
|
||||
description:
|
||||
"This API is intended to manage projects and subresources for ZITADEL. \n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.",
|
||||
"This API is intended to manage projects and subresources for ZITADEL. \n" +
|
||||
"\n" +
|
||||
"This service is in beta state. It can AND will continue breaking until a stable version is released.",
|
||||
},
|
||||
items: sidebar_api_project_service_v2,
|
||||
},
|
||||
@@ -858,11 +858,11 @@ module.exports = {
|
||||
title: "Application Service API (Beta)",
|
||||
slug: "/apis/resources/application_service_v2",
|
||||
description:
|
||||
"This API lets you manage Zitadel applications (API, SAML, OIDC).\n"+
|
||||
"\n"+
|
||||
"The API offers generic endpoints that work for all app types (API, SAML, OIDC), "+
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
"This API lets you manage Zitadel applications (API, SAML, OIDC).\n" +
|
||||
"\n" +
|
||||
"The API offers generic endpoints that work for all app types (API, SAML, OIDC), " +
|
||||
"\n" +
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_app_v2,
|
||||
},
|
||||
@@ -874,12 +874,12 @@ module.exports = {
|
||||
title: "Authorization Service API (Beta)",
|
||||
slug: "/apis/resources/authorization_service_v2",
|
||||
description:
|
||||
"AuthorizationService provides methods to manage authorizations for users within your projects and applications.\n" +
|
||||
"\n" +
|
||||
"For managing permissions and roles for ZITADEL internal resources, like organizations, projects,\n" +
|
||||
"users, etc., please use the InternalPermissionService."+
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
"AuthorizationService provides methods to manage authorizations for users within your projects and applications.\n" +
|
||||
"\n" +
|
||||
"For managing permissions and roles for ZITADEL internal resources, like organizations, projects,\n" +
|
||||
"users, etc., please use the InternalPermissionService." +
|
||||
"\n" +
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_authorization_service_v2,
|
||||
},
|
||||
@@ -891,9 +891,9 @@ module.exports = {
|
||||
title: "Internal Permission Service API (Beta)",
|
||||
slug: "/apis/resources/internal_permission_service_v2",
|
||||
description:
|
||||
"This API is intended to manage internal permissions in ZITADEL.\n" +
|
||||
"\n"+
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
"This API is intended to manage internal permissions in ZITADEL.\n" +
|
||||
"\n" +
|
||||
"This API is in beta state. It can AND will continue breaking until a stable version is released.\n"
|
||||
},
|
||||
items: sidebar_api_internal_permission_service_v2,
|
||||
},
|
||||
@@ -1180,6 +1180,11 @@ module.exports = {
|
||||
type: "autogenerated",
|
||||
dirName: "legal/service-description",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
label: "Billing",
|
||||
href: "https://help.zitadel.com/pricing-and-billing-of-zitadel-services"
|
||||
}
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user