|
5 | 5 | Services |
6 | 6 | ======== |
7 | 7 |
|
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. |
9 | 10 |
|
10 | 11 | Id |
11 | | - Unique payment id. |
| 12 | + Unique identifier of the Service. |
12 | 13 |
|
13 | 14 | UUID |
14 | | - Unique payment id. |
| 15 | + Globally unique identifier (UUID) of the Service. |
15 | 16 |
|
16 | 17 | Name |
17 | | - Name of service. |
| 18 | + Name of the Service. |
18 | 19 |
|
19 | 20 | Account |
20 | | - Account related to payment. |
| 21 | + Account to which payments are applied. |
21 | 22 |
|
22 | 23 | Type |
23 | | - Service Type. |
| 24 | + :ref:`Service Type <service_type>` of the Service. |
24 | 25 |
|
25 | 26 | 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. |
27 | 29 |
|
28 | 30 | State |
29 | | - Current state of service. |
| 31 | + Current state of the Service. |
30 | 32 |
|
31 | 33 | Initial price |
32 | | - Price that will bill be charged immediately after service creation. |
| 34 | + Price charged immediately after the Service is created. |
33 | 35 |
|
34 | 36 | Renew price |
35 | | - Price of renew. |
| 37 | + Price charged during each renewal. |
36 | 38 |
|
37 | 39 | Created At |
38 | | - Timestamp of service creation. |
| 40 | + Timestamp of when the Service was created. |
39 | 41 |
|
40 | 42 | Renew At |
41 | | - Timestamp when service will be renewed. |
| 43 | + Timestamp of the next renewal. |
42 | 44 |
|
43 | 45 | Renew Period |
44 | | - Daily or Monthly. |
| 46 | + Defines how the next **Renew At** date is calculated during the renewal process. |
| 47 | + Possible values: |
45 | 48 |
|
| 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. |
46 | 51 |
|
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. |
48 | 54 |
|
49 | 55 | Renew procedure |
50 | 56 | =============== |
51 | 57 |
|
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. |
54 | 61 |
|
55 | 62 |
|
56 | 63 | .. mermaid:: |
|
0 commit comments