Skip to content

Commit 2056379

Browse files
Service types (#182)
* Service types
1 parent 85fc44b commit 2056379

File tree

3 files changed

+67
-16
lines changed

3 files changed

+67
-16
lines changed

en/web-interface/billing/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Yeti billing is simple and based on processing different types of billing events
2020
accounts
2121
payments
2222
services
23+
service_types
2324
transactions
2425
invoices
2526
invoice_templates
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.. _service_type:
2+
3+
=============
4+
Service Types
5+
=============
6+
7+
A **Service Type** object is a template for a service. It defines how a service behaves during its life-cycle.
8+
9+
Id
10+
Unique identifier of the Service Type.
11+
12+
Name
13+
Human-readable name of the Service Type.
14+
15+
Force Renew
16+
When enabled, this flag forces service renewal even if the customer’s account
17+
balance is insufficient (``balance <= min_balance``).
18+
In this case, the service is renewed and the corresponding price is still charged.
19+
20+
.. spelling:word-list::
21+
FreeMinutes
22+
PhoneSystems
23+
24+
Provisioning Class
25+
Specifies system behavior during the service life-cycle (Creation, Renewal, Deletion).
26+
27+
Billing::Provisioning::Logging
28+
This provisioning class requires no configuration variables and performs no actions.
29+
It can be used for services that only need to charge the account periodically.
30+
31+
Billing::Provisioning::FreeMinutes
32+
Provisioning class that provides packages of free minutes.
33+
34+
Billing::Provisioning::PhoneSystems
35+
Provisioner for account creation on the DIDWW Phone.Systems cloud PBX platform.
36+
It creates an Account, Incoming and Outgoing trunks on the Phone.Systems side
37+
(via the `Operator API <https://doc.telecom.center/introduction.html>`_), and a gateway on the Yeti side to exchange calls with the Phone Systems Account.
38+
39+
UI Type
40+
Optional setting that controls how the service is displayed in the :ref:`Customer Portal <yeti_client>`.
41+
42+
Variables
43+
Optional provisioning class configuration in JSON format.

en/web-interface/billing/services.rst

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,52 +5,59 @@
55
Services
66
========
77

8-
Service object represents additional paid service not related to per-second call billing. Service may charge customer account one time or multiple times during **renew** procedure
8+
A **Service** object represents an additional paid service that is not related to per-second call billing.
9+
A service may charge the customer’s account once or multiple times during the **renew** procedure.
910

1011
Id
11-
Unique payment id.
12+
Unique identifier of the Service.
1213

1314
UUID
14-
Unique payment id.
15+
Globally unique identifier (UUID) of the Service.
1516

1617
Name
17-
Name of service.
18+
Name of the Service.
1819

1920
Account
20-
Account related to payment.
21+
Account to which payments are applied.
2122

2223
Type
23-
Service Type.
24+
:ref:`Service Type <service_type>` of the Service.
2425

2526
Variables
26-
Service variables. Data format depends on configured Service Type.
27+
Service-specific variables.
28+
The data format depends on the configured Service Type.
2729

2830
State
29-
Current state of service.
31+
Current state of the Service.
3032

3133
Initial price
32-
Price that will bill be charged immediately after service creation.
34+
Price charged immediately after the Service is created.
3335

3436
Renew price
35-
Price of renew.
37+
Price charged during each renewal.
3638

3739
Created At
38-
Timestamp of service creation.
40+
Timestamp of when the Service was created.
3941

4042
Renew At
41-
Timestamp when service will be renewed.
43+
Timestamp of the next renewal.
4244

4345
Renew Period
44-
Daily or Monthly.
46+
Defines how the next **Renew At** date is calculated during the renewal process.
47+
Possible values:
4548

49+
- **Daily** – Renew At is set to 00:00 of the next day.
50+
- **Monthly** – Renew At is set to 1st day of the next month, at 00:00.
4651

47-
Creation of service with non-zero **Initial price** value will cause creation of :ref:`Transaction <transaction>` object and it will cause Account balance modification.
52+
Creating a Service with a non-zero **Initial price** will automatically create a
53+
:ref:`Transaction <transaction>` object, which modifies the Account balance.
4854

4955
Renew procedure
5056
===============
5157

52-
Renew time controlled by **Renew At** value. Initially this value defined during service creation. During renew next **Renew At** will be set according to **Renew Period** configuration.
53-
58+
The renewal time is controlled by the **Renew At** value.
59+
This value is set during Service creation.
60+
During each renewal, the next **Renew At** timestamp is updated according to the **Renew Period** configuration.
5461

5562

5663
.. mermaid::

0 commit comments

Comments
 (0)