Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions src/schemas/SubscriptionCreateInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
9 changes: 9 additions & 0 deletions src/schemas/SubscriptionObject.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 8 additions & 0 deletions src/schemas/SubscriptionUpdateInput.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading