From 90eb2befb225f6e42c969bd384d9f7a42068c87d Mon Sep 17 00:00:00 2001 From: Lovro Colic Date: Tue, 19 May 2026 11:38:58 +0200 Subject: [PATCH] add support for invoice consolidation attribute --- openapi.yaml | 26 ++++++++++++++++++++++++ src/schemas/SubscriptionCreateInput.yaml | 9 ++++++++ src/schemas/SubscriptionObject.yaml | 9 ++++++++ src/schemas/SubscriptionUpdateInput.yaml | 8 ++++++++ 4 files changed, 52 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index c1f9f4c..6acc5a7 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -15423,6 +15423,15 @@ components: payment_method: $ref: '#/components/schemas/PaymentMethodReference' description: The payment method assigned to this subscription for processing payments. + consolidate_invoice: + type: boolean + default: true + example: true + description: | + Controls whether this subscription is eligible to be grouped with other subscriptions of the same customer on a consolidated recurring invoice. + + - `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method). + - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice, regardless of other grouping criteria. SubscriptionsPaginated: type: object required: @@ -20508,6 +20517,15 @@ components: payment_method: $ref: '#/components/schemas/PaymentMethodReference' description: Optional payment method to use for processing subscription payments. + consolidate_invoice: + type: boolean + default: true + example: true + description: | + Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices. + + - `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method). + - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice. ApplicableUsageThreshold: type: object required: @@ -20590,6 +20608,14 @@ components: payment_method: $ref: '#/components/schemas/PaymentMethodReference' description: Optional payment method to use for processing subscription payments. + consolidate_invoice: + type: boolean + example: false + description: | + Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices. + + - `true`: the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method). + - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice. Subscription: type: object required: diff --git a/src/schemas/SubscriptionCreateInput.yaml b/src/schemas/SubscriptionCreateInput.yaml index 488bde1..09a69b7 100644 --- a/src/schemas/SubscriptionCreateInput.yaml +++ b/src/schemas/SubscriptionCreateInput.yaml @@ -75,3 +75,12 @@ properties: payment_method: $ref: "./PaymentMethodReference.yaml" description: Optional payment method to use for processing subscription payments. + consolidate_invoice: + type: boolean + default: true + example: true + description: | + Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices. + + - `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method). + - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice. diff --git a/src/schemas/SubscriptionObject.yaml b/src/schemas/SubscriptionObject.yaml index 8bf3d78..9d77a7b 100644 --- a/src/schemas/SubscriptionObject.yaml +++ b/src/schemas/SubscriptionObject.yaml @@ -200,3 +200,12 @@ properties: payment_method: $ref: "./PaymentMethodReference.yaml" description: The payment method assigned to this subscription for processing payments. + consolidate_invoice: + type: boolean + default: true + example: true + description: | + Controls whether this subscription is eligible to be grouped with other subscriptions of the same customer on a consolidated recurring invoice. + + - `true` (default): the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method). + - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice, regardless of other grouping criteria. diff --git a/src/schemas/SubscriptionUpdateInput.yaml b/src/schemas/SubscriptionUpdateInput.yaml index 0ac757d..0ec3264 100644 --- a/src/schemas/SubscriptionUpdateInput.yaml +++ b/src/schemas/SubscriptionUpdateInput.yaml @@ -39,3 +39,11 @@ properties: payment_method: $ref: "./PaymentMethodReference.yaml" description: Optional payment method to use for processing subscription payments. + consolidate_invoice: + type: boolean + example: false + description: | + Defines whether this subscription should be grouped with other subscriptions of the same customer when generating recurring invoices. + + - `true`: the subscription is included in the customer's standard invoice grouping (by billing entity, currency and payment method). + - `false`: the subscription is excluded from consolidation and always billed on its own dedicated invoice.