feat(DynamicPricing): Document Event#precise_total_amount_cents

src/schemas/ChargeObject.yaml

@@ -31,14 +31,15 @@ properties:
     example: "2022-09-14T16:35:31Z"
   charge_model:
     type: string
-    description: Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`.
+    description: Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.
     enum:
       - standard
       - graduated
       - graduated_percentage
       - package
       - percentage
       - volume
+      - dynamic
   pay_in_advance:
     type: boolean
     description: This field determines the billing timing for this specific usage-based charge. When set to `true`, the charge is due and invoiced immediately. Conversely, when set to `false`, the charge is due and invoiced at the end of each billing period.

src/schemas/EventInputObject.yaml

@@ -24,6 +24,11 @@ properties:
       This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC).
       If this timestamp is not provided, the API will automatically set it to the time of event reception.
       You can also provide miliseconds precision by appending decimals to the timestamp.
+  precise_total_amount_cents:
+    type: string
+    nullable: true
+    example: "1234.56"
+    description: The precise total amount in cents with precision used by the `dynamic` pricing model to compute the usage amount.
   properties:
     type: object
     description: This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.

src/schemas/EventObject.yaml

@@ -33,6 +33,11 @@ properties:
     format: "date-time"
     example: "2022-04-29T08:59:51.123Z"
     description: This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.
+  precise_total_amount_cents:
+    type: string
+    nullable: true
+    example: "1234.56"
+    description: The precise total amount that was sent in the event payload. This filed is used by the `dynamic` pricing model.
   properties:
     type: object
     description: This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a `sum_agg`, `max_agg`, or `unique_count_agg` aggregation method. However, when using a simple `count_agg`, this object is not required.

src/schemas/PlanCreateInput.yaml

@@ -73,14 +73,15 @@ properties:
               example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
             charge_model:
               type: string
-              description: Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage` or `volume`.
+              description: Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage` `package`, `percentage`, `volume` or `dynamic`.
               enum:
                 - standard
                 - graduated
                 - graduated_percentage
                 - package
                 - percentage
                 - volume
+                - dynamic
               example: "standard"
             pay_in_advance:
               type: boolean

src/schemas/PlanUpdateInput.yaml

@@ -78,14 +78,15 @@ properties:
               example: "1a901a90-1a90-1a90-1a90-1a901a901a90"
             charge_model:
               type: string
-              description: Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage` or `volume`.
+              description: Specifies the pricing model used for the calculation of the final fee. It can be `standard`, `graduated`, `graduated_percentage`, `package`, `percentage`, `volume` or `dynamic`.
               enum:
                 - standard
                 - graduated
                 - graduated_percentage
                 - package
                 - percentage
                 - volume
+                - dynamic
               example: "standard"
             pay_in_advance:
               type: boolean