feat(charges): Add Charge.regroup_paid_fees attribute

src/schemas/ChargeObject.yaml

@@ -47,6 +47,19 @@ properties:
     type: boolean
     description: This field specifies whether the charge should be included in a proper invoice. If set to `false`, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.
     example: true
+  regroup_paid_fees:
+    type: string
+    nullable: true
+    enum:
+      - null
+      - invoice
+    description: |-
+      This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+      This field determines whether and when the charge fee should be included in
+      the invoice. If `null`, no invoice will be issued for this charge fee.
+      If `invoice`, an invoice will be generated at the end of the period,
+      consolidating all charge fees with a succeeded payment status.
+    example: "invoice"
   prorated:
     type: boolean
     example: false

src/schemas/PlanCreateInput.yaml

@@ -90,6 +90,19 @@ properties:
               type: boolean
               description: This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.
               example: true
+            regroup_paid_fees:
+              type: string
+              nullable: true
+              enum:
+                - null
+                - invoice
+              description: |-
+                This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+                This field determines whether and when the charge fee should be included in
+                the invoice. If `null`, no invoice will be issued for this charge fee.
+                If `invoice`, an invoice will be generated at the end of the period,
+                consolidating all charge fees with a succeeded payment status.
+              example: "invoice"
             invoice_display_name:
               type: string
               description: Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
@@ -146,6 +159,7 @@ properties:
             invoiceable: true
             invoice_display_name: "Setup"
             pay_in_advance: false
+            regroup_paid_fees: null
             prorated: false
             min_amount_cents: 3000
             properties:
@@ -216,6 +230,7 @@ properties:
             invoiceable: false
             invoice_display_name: "Setup"
             pay_in_advance: true
+            regroup_paid_fees: "invoice"
             prorated: false
             min_amount_cents: 0
             properties:

src/schemas/PlanObject.yaml

@@ -91,6 +91,7 @@ properties:
         invoiceable: true
         invoice_display_name: "Setup"
         pay_in_advance: false
+        regroup_paid_fees: null
         prorated: false
         min_amount_cents: 3000
         properties:
@@ -175,6 +176,7 @@ properties:
         invoiceable: false
         invoice_display_name: "Setup"
         pay_in_advance: true
+        regroup_paid_fees: "invoice"
         prorated: false
         min_amount_cents: 0
         properties:

src/schemas/PlanUpdateInput.yaml

@@ -95,6 +95,19 @@ properties:
               type: boolean
               description: This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to `false` when `pay_in_advance` is `true`.
               example: true
+            regroup_paid_fees:
+              type: string
+              nullable: true
+              enum:
+                - null
+                - invoice
+              description: |-
+                This setting can only be configured if `pay_in_advance` is `true` and `invoiceable` is `false`.
+                This field determines whether and when the charge fee should be included in
+                the invoice. If `null`, no invoice will be issued for this charge fee.
+                If `invoice`, an invoice will be generated at the end of the period,
+                consolidating all charge fees with a succeeded payment status.
+              example: "invoice"
             invoice_display_name:
               type: string
               description: Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.
@@ -182,6 +195,7 @@ properties:
             invoiceable: true
             invoice_display_name: "Setup"
             pay_in_advance: true
+            regroup_paid_fees: null
             prorated: false
             min_amount_cents: 0
             properties: {}
@@ -221,6 +235,7 @@ properties:
             invoiceable: false
             invoice_display_name: "Setup"
             pay_in_advance: true
+            regroup_paid_fees: "invoice"
             prorated: false
             min_amount_cents: 0
             properties: