Skip to content

feat(backend): add billing cadence and pro-rating config to plan and subscription #2890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 10, 2025
Merged

feat(backend): add billing cadence and pro-rating config to plan and subscription #2890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
376a0f5
feat(backend): add billing cadence and pro-rating config to plan & su…
tothandras May 26, 2025
259a2f7
feat(plan): update divisible periods to allow hours and validate plan…
tothandras Jun 3, 2025
779318b
feat(pc): use billing cadence in subscription sync (#2922)
GAlexIHU Jun 3, 2025
d8bcbb2
fix(pc): use correct error
GAlexIHU Jun 3, 2025
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
2,221 changes: 1,148 additions & 1,073 deletions api/api.gen.go
View file
Open in desktop

Large diffs are not rendered by default.

2,148 changes: 1,112 additions & 1,036 deletions api/client/go/client.gen.go
View file
Open in desktop

Large diffs are not rendered by default.

130 changes: 130 additions & 0 deletions api/client/javascript/src/client/schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3504,6 +3504,24 @@ export interface components {
* @default USD
*/
currency: components['schemas']['CurrencyCode']
/**
* Billing cadence
* Format: duration
* @description The default billing cadence for subscriptions using this plan.
* Defines how often customers are billed using ISO8601 duration format.
* Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually).
* @example P1M
*/
billingCadence: string
/**
* Pro-rating configuration
* @description Default pro-rating configuration for subscriptions using this plan.
* @default {
* "enabled": true,
* "mode": "prorate_prices"
* }
*/
proRatingConfig?: components['schemas']['ProRatingConfig']
/**
* Plan phases
* @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
Expand Down Expand Up @@ -7705,6 +7723,24 @@ export interface components {
* @default USD
*/
currency: components['schemas']['CurrencyCode']
/**
* Billing cadence
* Format: duration
* @description The default billing cadence for subscriptions using this plan.
* Defines how often customers are billed using ISO8601 duration format.
* Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually).
* @example P1M
*/
billingCadence: string
/**
* Pro-rating configuration
* @description Default pro-rating configuration for subscriptions using this plan.
* @default {
* "enabled": true,
* "mode": "prorate_prices"
* }
*/
proRatingConfig?: components['schemas']['ProRatingConfig']
/**
* Effective start date
* Format: date-time
Expand Down Expand Up @@ -7899,6 +7935,24 @@ export interface components {
* @default USD
*/
currency: components['schemas']['CurrencyCode']
/**
* Billing cadence
* Format: duration
* @description The default billing cadence for subscriptions using this plan.
* Defines how often customers are billed using ISO8601 duration format.
* Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually).
* @example P1M
*/
billingCadence: string
/**
* Pro-rating configuration
* @description Default pro-rating configuration for subscriptions using this plan.
* @default {
* "enabled": true,
* "mode": "prorate_prices"
* }
*/
proRatingConfig?: components['schemas']['ProRatingConfig']
/**
* Plan phases
* @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
Expand Down Expand Up @@ -8004,6 +8058,24 @@ export interface components {
metadata?: components['schemas']['Metadata'] | null
/** @description Alignment configuration for the plan. */
alignment?: components['schemas']['Alignment']
/**
* Billing cadence
* Format: duration
* @description The default billing cadence for subscriptions using this plan.
* Defines how often customers are billed using ISO8601 duration format.
* Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually).
* @example P1M
*/
billingCadence: string
/**
* Pro-rating configuration
* @description Default pro-rating configuration for subscriptions using this plan.
* @default {
* "enabled": true,
* "mode": "prorate_prices"
* }
*/
proRatingConfig?: components['schemas']['ProRatingConfig']
/**
* Plan phases
* @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
Expand Down Expand Up @@ -8130,6 +8202,26 @@ export interface components {
*/
unitPrice: components['schemas']['UnitPrice'] | null
}
/** @description Configuration for pro-rating behavior. */
ProRatingConfig: {
/**
* Enable pro-rating
* @description Whether pro-rating is enabled for this plan.
* @default true
*/
enabled: boolean
/**
* Pro-rating mode
* @description How to handle pro-rating for billing period changes.
* @default prorate_prices
*/
mode: components['schemas']['ProRatingMode']
}
/**
* @description Pro-rating mode options for handling billing period changes.
* @enum {string}
*/
ProRatingMode: 'prorate_prices'
/** @description Progress describes a progress of a task. */
Progress: {
/**
Expand Down Expand Up @@ -8994,6 +9086,24 @@ export interface components {
* @default USD
*/
currency: components['schemas']['CurrencyCode']
/**
* Billing cadence
* Format: duration
* @description The billing cadence for the subscriptions.
* Defines how often customers are billed using ISO8601 duration format.
* Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually).
* @example P1M
*/
readonly billingCadence: string
/**
* Pro-rating configuration
* @description The pro-rating configuration for the subscriptions.
* @default {
* "enabled": true,
* "mode": "prorate_prices"
* }
*/
readonly proRatingConfig?: components['schemas']['ProRatingConfig']
}
/** @description A subscription add-on, represents concrete instances of an add-on for a given subscription. */
SubscriptionAddon: {
Expand Down Expand Up @@ -9345,6 +9455,24 @@ export interface components {
* @default USD
*/
currency: components['schemas']['CurrencyCode']
/**
* Billing cadence
* Format: duration
* @description The billing cadence for the subscriptions.
* Defines how often customers are billed using ISO8601 duration format.
* Examples: "P1M" (monthly), "P3M" (quarterly), "P1Y" (annually).
* @example P1M
*/
readonly billingCadence: string
/**
* Pro-rating configuration
* @description The pro-rating configuration for the subscriptions.
* @default {
* "enabled": true,
* "mode": "prorate_prices"
* }
*/
readonly proRatingConfig?: components['schemas']['ProRatingConfig']
/** @description Alignment details enriched with the current billing period. */
alignment?: components['schemas']['SubscriptionAlignment']
/** @description The phases of the subscription. */
Expand Down Expand Up @@ -10562,6 +10690,8 @@ export type PreconditionFailedProblemResponse =
components['schemas']['PreconditionFailedProblemResponse']
export type PricePaymentTerm = components['schemas']['PricePaymentTerm']
export type PriceTier = components['schemas']['PriceTier']
export type ProRatingConfig = components['schemas']['ProRatingConfig']
export type ProRatingMode = components['schemas']['ProRatingMode']
export type Progress = components['schemas']['Progress']
export type RateCard = components['schemas']['RateCard']
export type RateCardBooleanEntitlement =
Expand Down
120 changes: 120 additions & 0 deletions api/client/javascript/src/zod/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9165,6 +9165,12 @@ export const createPlanBodyCurrencyMaxOne = 3

export const createPlanBodyCurrencyRegExpOne = new RegExp('^[A-Z]{3}$')
export const createPlanBodyCurrencyDefault = 'USD'
export const createPlanBodyProRatingConfigEnabledDefault = true
export const createPlanBodyProRatingConfigModeDefault = 'prorate_prices'
export const createPlanBodyProRatingConfigDefault = {
enabled: true,
mode: 'prorate_prices',
}
export const createPlanBodyPhasesItemKeyMax = 64

export const createPlanBodyPhasesItemKeyRegExp = new RegExp(
Expand Down Expand Up @@ -9271,6 +9277,11 @@ export const createPlanBody = zod
.describe('Alignment configuration for a plan or subscription.')
.optional()
.describe('Alignment configuration for the plan.'),
billingCadence: zod
.string()
.describe(
'The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'
),
currency: zod
.string()
.min(createPlanBodyCurrencyMinOne)
Expand Down Expand Up @@ -10142,6 +10153,23 @@ export const createPlanBody = zod
.describe(
"The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."
),
proRatingConfig: zod
.object({
enabled: zod
.boolean()
.describe('Whether pro-rating is enabled for this plan.'),
mode: zod
.enum(['prorate_prices'])
.describe(
'Pro-rating mode options for handling billing period changes.'
)
.describe('How to handle pro-rating for billing period changes.'),
})
.describe('Configuration for pro-rating behavior.')
.default(createPlanBodyProRatingConfigDefault)
.describe(
'Default pro-rating configuration for subscriptions using this plan.'
),
})
.describe('Resource create operation model.')

Expand Down Expand Up @@ -10179,6 +10207,12 @@ export const updatePlanParams = zod.object({

export const updatePlanBodyNameMax = 256
export const updatePlanBodyDescriptionMax = 1024
export const updatePlanBodyProRatingConfigEnabledDefault = true
export const updatePlanBodyProRatingConfigModeDefault = 'prorate_prices'
export const updatePlanBodyProRatingConfigDefault = {
enabled: true,
mode: 'prorate_prices',
}
export const updatePlanBodyPhasesItemKeyMax = 64

export const updatePlanBodyPhasesItemKeyRegExp = new RegExp(
Expand Down Expand Up @@ -10285,6 +10319,11 @@ export const updatePlanBody = zod
.describe('Alignment configuration for a plan or subscription.')
.optional()
.describe('Alignment configuration for the plan.'),
billingCadence: zod
.string()
.describe(
'The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'
),
description: zod
.string()
.max(updatePlanBodyDescriptionMax)
Expand Down Expand Up @@ -11141,6 +11180,23 @@ export const updatePlanBody = zod
.describe(
"The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."
),
proRatingConfig: zod
.object({
enabled: zod
.boolean()
.describe('Whether pro-rating is enabled for this plan.'),
mode: zod
.enum(['prorate_prices'])
.describe(
'Pro-rating mode options for handling billing period changes.'
)
.describe('How to handle pro-rating for billing period changes.'),
})
.describe('Configuration for pro-rating behavior.')
.default(updatePlanBodyProRatingConfigDefault)
.describe(
'Default pro-rating configuration for subscriptions using this plan.'
),
})
.describe('Resource update operation model.')

Expand Down Expand Up @@ -12755,6 +12811,14 @@ export const createSubscriptionBodyCustomPlanCurrencyRegExpOne = new RegExp(
'^[A-Z]{3}$'
)
export const createSubscriptionBodyCustomPlanCurrencyDefault = 'USD'
export const createSubscriptionBodyCustomPlanProRatingConfigEnabledDefault =
true
export const createSubscriptionBodyCustomPlanProRatingConfigModeDefault =
'prorate_prices'
export const createSubscriptionBodyCustomPlanProRatingConfigDefault = {
enabled: true,
mode: 'prorate_prices',
}
export const createSubscriptionBodyCustomPlanPhasesItemKeyMax = 64

export const createSubscriptionBodyCustomPlanPhasesItemKeyRegExp = new RegExp(
Expand Down Expand Up @@ -12966,6 +13030,11 @@ export const createSubscriptionBody = zod
.describe('Alignment configuration for a plan or subscription.')
.optional()
.describe('Alignment configuration for the plan.'),
billingCadence: zod
.string()
.describe(
'The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'
),
currency: zod
.string()
.min(createSubscriptionBodyCustomPlanCurrencyMinOne)
Expand Down Expand Up @@ -13879,6 +13948,25 @@ export const createSubscriptionBody = zod
.describe(
"The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."
),
proRatingConfig: zod
.object({
enabled: zod
.boolean()
.describe('Whether pro-rating is enabled for this plan.'),
mode: zod
.enum(['prorate_prices'])
.describe(
'Pro-rating mode options for handling billing period changes.'
)
.describe(
'How to handle pro-rating for billing period changes.'
),
})
.describe('Configuration for pro-rating behavior.')
.default(createSubscriptionBodyCustomPlanProRatingConfigDefault)
.describe(
'Default pro-rating configuration for subscriptions using this plan.'
),
})
.describe('The template for omitting properties.')
.describe(
Expand Down Expand Up @@ -15242,6 +15330,14 @@ export const changeSubscriptionBodyCustomPlanCurrencyRegExpOne = new RegExp(
'^[A-Z]{3}$'
)
export const changeSubscriptionBodyCustomPlanCurrencyDefault = 'USD'
export const changeSubscriptionBodyCustomPlanProRatingConfigEnabledDefault =
true
export const changeSubscriptionBodyCustomPlanProRatingConfigModeDefault =
'prorate_prices'
export const changeSubscriptionBodyCustomPlanProRatingConfigDefault = {
enabled: true,
mode: 'prorate_prices',
}
export const changeSubscriptionBodyCustomPlanPhasesItemKeyMax = 64

export const changeSubscriptionBodyCustomPlanPhasesItemKeyRegExp = new RegExp(
Expand Down Expand Up @@ -15421,6 +15517,11 @@ export const changeSubscriptionBody = zod
.describe('Alignment configuration for a plan or subscription.')
.optional()
.describe('Alignment configuration for the plan.'),
billingCadence: zod
.string()
.describe(
'The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'
),
currency: zod
.string()
.min(changeSubscriptionBodyCustomPlanCurrencyMinOne)
Expand Down Expand Up @@ -16334,6 +16435,25 @@ export const changeSubscriptionBody = zod
.describe(
"The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."
),
proRatingConfig: zod
.object({
enabled: zod
.boolean()
.describe('Whether pro-rating is enabled for this plan.'),
mode: zod
.enum(['prorate_prices'])
.describe(
'Pro-rating mode options for handling billing period changes.'
)
.describe(
'How to handle pro-rating for billing period changes.'
),
})
.describe('Configuration for pro-rating behavior.')
.default(changeSubscriptionBodyCustomPlanProRatingConfigDefault)
.describe(
'Default pro-rating configuration for subscriptions using this plan.'
),
})
.describe('The template for omitting properties.')
.describe(
Expand Down
Loading
Loading