On December 1, 2023, the WebOffice billing model changed to a per-call basis. This change affects the GenerateWebofficeToken and RefreshWebofficeToken API operations. This new billing model applies only to projects created on or after December 1, 2023. Projects created before this date continue to be billed based on the number of times a document is opened.
Billing logic comparison
Per-opening billing: Billing is based on the number of times a document is opened. A document opening operation initiates and establishes a long connection to the server. When the connection is disconnected, the billing data is updated. In this billing policy, an access token is not time-limited and can be used by multiple users to open the document any number of times. However, each time the document is opened, a charge is incurred.
Per-call billing: Billing is based on the number of calls to API operations (GenerateWebofficeToken and RefreshWebofficeToken). Each call incurs a charge. A call returns an access token, which allows only one user to open a document for 30 minutes. Opening the document multiple times within the token validity period incurs only one charge. If multiple users attempt to use the same access token to open the same document, only the user who last makes the request can open it. Document access permissions granted to previous users are revoked. To avoid document access failures, use a new access token each time you open a document.
The following table describes the differences between the two billing policies.
Description | Per-opening billing (before December 1, 2023) | Per-call billing (on or after December 1, 2023) |
Charge incurred when | The link becomes invalid after the user opens the document. | An API operation call is made. |
Limit on the number of users allowed | No such limit applies. An access token can be used by multiple users. | An access token can only be used by a single user to access a document at any given time. For multiple users to access a document at the same time, each user requires a different access token. |
Switch to the per-call billing plan
Create a new project in the IMM console. New projects use the per-call billing model by default.
Adjust your code logic to retrieve a new access token each time a document is opened. Remember that an access token can be used by only one user.
Change the project parameter in your IMM API calls to specify the new project.