@openmeter/sdk 1.0.0-beta-3a223c322bbb → 1.0.0-beta-e17c230acd1e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/client/plans.d.cts +5 -0
- package/dist/cjs/src/client/schemas.d.cts +69 -0
- package/dist/cjs/src/client/subscriptions.d.cts +5 -0
- package/dist/cjs/src/zod/index.cjs +42 -13
- package/dist/cjs/src/zod/index.cjs.map +1 -1
- package/dist/cjs/src/zod/index.d.cts +24 -0
- package/dist/src/client/plans.d.ts +5 -0
- package/dist/src/client/schemas.d.ts +69 -0
- package/dist/src/client/subscriptions.d.ts +5 -0
- package/dist/src/zod/index.d.ts +24 -0
- package/dist/src/zod/index.js +29 -0
- package/dist/src/zod/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -3482,6 +3482,7 @@ export declare const createPlanBodyProRatingConfigDefault: {
|
|
|
3482
3482
|
readonly enabled: true;
|
|
3483
3483
|
readonly mode: "prorate_prices";
|
|
3484
3484
|
};
|
|
3485
|
+
export declare const createPlanBodySettlementModeDefault: "credit_then_invoice";
|
|
3485
3486
|
export declare const createPlanBodyPhasesItemKeyMax: 64;
|
|
3486
3487
|
export declare const createPlanBodyPhasesItemKeyRegExp: RegExp;
|
|
3487
3488
|
export declare const createPlanBodyPhasesItemNameMax: 256;
|
|
@@ -3727,6 +3728,10 @@ export declare const CreatePlanBody: zod.ZodObject<{
|
|
|
3727
3728
|
prorate_prices: "prorate_prices";
|
|
3728
3729
|
}>>;
|
|
3729
3730
|
}, zod.z.core.$strip>>;
|
|
3731
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
3732
|
+
credit_then_invoice: "credit_then_invoice";
|
|
3733
|
+
credit_only: "credit_only";
|
|
3734
|
+
}>>;
|
|
3730
3735
|
}, zod.z.core.$strip>;
|
|
3731
3736
|
/**
|
|
3732
3737
|
* Create a new draft version from plan.
|
|
@@ -3755,6 +3760,7 @@ export declare const updatePlanBodyProRatingConfigDefault: {
|
|
|
3755
3760
|
readonly enabled: true;
|
|
3756
3761
|
readonly mode: "prorate_prices";
|
|
3757
3762
|
};
|
|
3763
|
+
export declare const updatePlanBodySettlementModeDefault: "credit_then_invoice";
|
|
3758
3764
|
export declare const updatePlanBodyPhasesItemKeyMax: 64;
|
|
3759
3765
|
export declare const updatePlanBodyPhasesItemKeyRegExp: RegExp;
|
|
3760
3766
|
export declare const updatePlanBodyPhasesItemNameMax: 256;
|
|
@@ -3998,6 +4004,10 @@ export declare const UpdatePlanBody: zod.ZodObject<{
|
|
|
3998
4004
|
prorate_prices: "prorate_prices";
|
|
3999
4005
|
}>>;
|
|
4000
4006
|
}, zod.z.core.$strip>>;
|
|
4007
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
4008
|
+
credit_then_invoice: "credit_then_invoice";
|
|
4009
|
+
credit_only: "credit_only";
|
|
4010
|
+
}>>;
|
|
4001
4011
|
}, zod.z.core.$strip>;
|
|
4002
4012
|
/**
|
|
4003
4013
|
* Get a plan by id or key. The latest published version is returned if latter is used.
|
|
@@ -4730,6 +4740,7 @@ export declare const createSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDef
|
|
|
4730
4740
|
readonly enabled: true;
|
|
4731
4741
|
readonly mode: "prorate_prices";
|
|
4732
4742
|
};
|
|
4743
|
+
export declare const createSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault: "credit_then_invoice";
|
|
4733
4744
|
export declare const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax: 64;
|
|
4734
4745
|
export declare const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp: RegExp;
|
|
4735
4746
|
export declare const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax: 256;
|
|
@@ -4797,6 +4808,10 @@ export declare const CreateSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
4797
4808
|
key: zod.z.ZodCoercedString<unknown>;
|
|
4798
4809
|
version: zod.ZodOptional<zod.z.ZodCoercedNumber<unknown>>;
|
|
4799
4810
|
}, zod.z.core.$strip>;
|
|
4811
|
+
settlementMode: zod.ZodOptional<zod.ZodEnum<{
|
|
4812
|
+
credit_then_invoice: "credit_then_invoice";
|
|
4813
|
+
credit_only: "credit_only";
|
|
4814
|
+
}>>;
|
|
4800
4815
|
startingPhase: zod.ZodOptional<zod.z.ZodCoercedString<unknown>>;
|
|
4801
4816
|
timing: zod.ZodDefault<zod.ZodUnion<readonly [zod.ZodEnum<{
|
|
4802
4817
|
immediate: "immediate";
|
|
@@ -5000,6 +5015,10 @@ export declare const CreateSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
5000
5015
|
prorate_prices: "prorate_prices";
|
|
5001
5016
|
}>>;
|
|
5002
5017
|
}, zod.z.core.$strip>>;
|
|
5018
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
5019
|
+
credit_then_invoice: "credit_then_invoice";
|
|
5020
|
+
credit_only: "credit_only";
|
|
5021
|
+
}>>;
|
|
5003
5022
|
}, zod.z.core.$strip>;
|
|
5004
5023
|
timing: zod.ZodDefault<zod.ZodUnion<readonly [zod.ZodEnum<{
|
|
5005
5024
|
immediate: "immediate";
|
|
@@ -5415,6 +5434,7 @@ export declare const changeSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDef
|
|
|
5415
5434
|
readonly enabled: true;
|
|
5416
5435
|
readonly mode: "prorate_prices";
|
|
5417
5436
|
};
|
|
5437
|
+
export declare const changeSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault: "credit_then_invoice";
|
|
5418
5438
|
export declare const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax: 64;
|
|
5419
5439
|
export declare const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp: RegExp;
|
|
5420
5440
|
export declare const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax: 256;
|
|
@@ -5678,6 +5698,10 @@ export declare const ChangeSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
5678
5698
|
prorate_prices: "prorate_prices";
|
|
5679
5699
|
}>>;
|
|
5680
5700
|
}, zod.z.core.$strip>>;
|
|
5701
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
5702
|
+
credit_then_invoice: "credit_then_invoice";
|
|
5703
|
+
credit_only: "credit_only";
|
|
5704
|
+
}>>;
|
|
5681
5705
|
}, zod.z.core.$strip>;
|
|
5682
5706
|
timing: zod.ZodUnion<readonly [zod.ZodEnum<{
|
|
5683
5707
|
immediate: "immediate";
|
|
@@ -32,6 +32,7 @@ export declare class Plans {
|
|
|
32
32
|
readonly effectiveFrom?: Date;
|
|
33
33
|
readonly effectiveTo?: Date;
|
|
34
34
|
readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
|
|
35
|
+
settlementMode?: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
35
36
|
phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
|
|
36
37
|
readonly validationErrors: import("./schemas.js").components["schemas"]["ValidationError"][] | null;
|
|
37
38
|
} | undefined>;
|
|
@@ -59,6 +60,7 @@ export declare class Plans {
|
|
|
59
60
|
readonly effectiveFrom?: Date;
|
|
60
61
|
readonly effectiveTo?: Date;
|
|
61
62
|
readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
|
|
63
|
+
settlementMode?: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
62
64
|
phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
|
|
63
65
|
readonly validationErrors: import("./schemas.js").components["schemas"]["ValidationError"][] | null;
|
|
64
66
|
} | undefined>;
|
|
@@ -98,6 +100,7 @@ export declare class Plans {
|
|
|
98
100
|
readonly effectiveFrom?: Date;
|
|
99
101
|
readonly effectiveTo?: Date;
|
|
100
102
|
readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
|
|
103
|
+
settlementMode?: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
101
104
|
phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
|
|
102
105
|
readonly validationErrors: import("./schemas.js").components["schemas"]["ValidationError"][] | null;
|
|
103
106
|
} | undefined>;
|
|
@@ -131,6 +134,7 @@ export declare class Plans {
|
|
|
131
134
|
readonly effectiveFrom?: Date;
|
|
132
135
|
readonly effectiveTo?: Date;
|
|
133
136
|
readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
|
|
137
|
+
settlementMode?: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
134
138
|
phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
|
|
135
139
|
readonly validationErrors: import("./schemas.js").components["schemas"]["ValidationError"][] | null;
|
|
136
140
|
} | undefined>;
|
|
@@ -157,6 +161,7 @@ export declare class Plans {
|
|
|
157
161
|
readonly effectiveFrom?: Date;
|
|
158
162
|
readonly effectiveTo?: Date;
|
|
159
163
|
readonly status: import("./schemas.js").components["schemas"]["PlanStatus"];
|
|
164
|
+
settlementMode?: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
160
165
|
phases: import("./schemas.js").components["schemas"]["PlanPhase"][];
|
|
161
166
|
readonly validationErrors: import("./schemas.js").components["schemas"]["ValidationError"][] | null;
|
|
162
167
|
} | undefined>;
|
|
@@ -3257,6 +3257,14 @@ export interface components {
|
|
|
3257
3257
|
/** @description The billing workflow settings for this profile. */
|
|
3258
3258
|
workflow: components['schemas']['BillingWorkflow'];
|
|
3259
3259
|
};
|
|
3260
|
+
/**
|
|
3261
|
+
* @description The settlement mode of a plan.
|
|
3262
|
+
* It determines how the billing system generates invoices and credits for the subscriptions using this plan.
|
|
3263
|
+
* - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.
|
|
3264
|
+
* - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
|
|
3265
|
+
* @enum {string}
|
|
3266
|
+
*/
|
|
3267
|
+
BillingSettlementMode: 'credit_then_invoice' | 'credit_only';
|
|
3260
3268
|
/** @description TaxIdentificationCode is a normalized tax code shown on the original identity document. */
|
|
3261
3269
|
BillingTaxIdentificationCode: string;
|
|
3262
3270
|
/** @description BillingWorkflow represents the settings for a billing workflow. */
|
|
@@ -4032,6 +4040,16 @@ export interface components {
|
|
|
4032
4040
|
* }
|
|
4033
4041
|
*/
|
|
4034
4042
|
proRatingConfig?: components['schemas']['ProRatingConfig'];
|
|
4043
|
+
/**
|
|
4044
|
+
* Settlement mode
|
|
4045
|
+
* @description The settlement mode of the plan.
|
|
4046
|
+
* It determines how the billing system generates invoices and credits for the subscriptions using this plan.
|
|
4047
|
+
* - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
|
|
4048
|
+
* - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
|
|
4049
|
+
* This is the default and most common settlement mode.
|
|
4050
|
+
* @default credit_then_invoice
|
|
4051
|
+
*/
|
|
4052
|
+
settlementMode?: components['schemas']['BillingSettlementMode'];
|
|
4035
4053
|
/**
|
|
4036
4054
|
* Plan phases
|
|
4037
4055
|
* @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
|
|
@@ -9342,6 +9360,16 @@ export interface components {
|
|
|
9342
9360
|
* - scheduled = now < effectiveFrom < effectiveTo
|
|
9343
9361
|
*/
|
|
9344
9362
|
readonly status: components['schemas']['PlanStatus'];
|
|
9363
|
+
/**
|
|
9364
|
+
* Settlement mode
|
|
9365
|
+
* @description The settlement mode of the plan.
|
|
9366
|
+
* It determines how the billing system generates invoices and credits for the subscriptions using this plan.
|
|
9367
|
+
* - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
|
|
9368
|
+
* - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
|
|
9369
|
+
* This is the default and most common settlement mode.
|
|
9370
|
+
* @default credit_then_invoice
|
|
9371
|
+
*/
|
|
9372
|
+
settlementMode?: components['schemas']['BillingSettlementMode'];
|
|
9345
9373
|
/**
|
|
9346
9374
|
* Plan phases
|
|
9347
9375
|
* @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
|
|
@@ -9526,6 +9554,16 @@ export interface components {
|
|
|
9526
9554
|
* }
|
|
9527
9555
|
*/
|
|
9528
9556
|
proRatingConfig?: components['schemas']['ProRatingConfig'];
|
|
9557
|
+
/**
|
|
9558
|
+
* Settlement mode
|
|
9559
|
+
* @description The settlement mode of the plan.
|
|
9560
|
+
* It determines how the billing system generates invoices and credits for the subscriptions using this plan.
|
|
9561
|
+
* - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
|
|
9562
|
+
* - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
|
|
9563
|
+
* This is the default and most common settlement mode.
|
|
9564
|
+
* @default credit_then_invoice
|
|
9565
|
+
*/
|
|
9566
|
+
settlementMode?: components['schemas']['BillingSettlementMode'];
|
|
9529
9567
|
/**
|
|
9530
9568
|
* Plan phases
|
|
9531
9569
|
* @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
|
|
@@ -9649,6 +9687,16 @@ export interface components {
|
|
|
9649
9687
|
* }
|
|
9650
9688
|
*/
|
|
9651
9689
|
proRatingConfig?: components['schemas']['ProRatingConfig'];
|
|
9690
|
+
/**
|
|
9691
|
+
* Settlement mode
|
|
9692
|
+
* @description The settlement mode of the plan.
|
|
9693
|
+
* It determines how the billing system generates invoices and credits for the subscriptions using this plan.
|
|
9694
|
+
* - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
|
|
9695
|
+
* - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
|
|
9696
|
+
* This is the default and most common settlement mode.
|
|
9697
|
+
* @default credit_then_invoice
|
|
9698
|
+
*/
|
|
9699
|
+
settlementMode?: components['schemas']['BillingSettlementMode'];
|
|
9652
9700
|
/**
|
|
9653
9701
|
* Plan phases
|
|
9654
9702
|
* @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
|
|
@@ -9729,6 +9777,8 @@ export interface components {
|
|
|
9729
9777
|
* @example 2023-01-01T01:01:01.001Z
|
|
9730
9778
|
*/
|
|
9731
9779
|
billingAnchor?: Date;
|
|
9780
|
+
/** @description The settlement mode of the subscription. */
|
|
9781
|
+
settlementMode?: components['schemas']['BillingSettlementMode'];
|
|
9732
9782
|
};
|
|
9733
9783
|
/**
|
|
9734
9784
|
* @description A consumer portal token.
|
|
@@ -10815,6 +10865,15 @@ export interface components {
|
|
|
10815
10865
|
* @example 2023-01-01T01:01:01.001Z
|
|
10816
10866
|
*/
|
|
10817
10867
|
readonly billingAnchor: Date;
|
|
10868
|
+
/**
|
|
10869
|
+
* Settlement mode
|
|
10870
|
+
* @description The settlement mode of the subscription.
|
|
10871
|
+
* - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
|
|
10872
|
+
* - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
|
|
10873
|
+
* This is the default and most common settlement mode.
|
|
10874
|
+
* @default credit_then_invoice
|
|
10875
|
+
*/
|
|
10876
|
+
readonly settlementMode: components['schemas']['BillingSettlementMode'];
|
|
10818
10877
|
};
|
|
10819
10878
|
/** @description A subscription add-on, represents concrete instances of an add-on for a given subscription. */
|
|
10820
10879
|
SubscriptionAddon: {
|
|
@@ -11266,6 +11325,15 @@ export interface components {
|
|
|
11266
11325
|
* @example 2023-01-01T01:01:01.001Z
|
|
11267
11326
|
*/
|
|
11268
11327
|
readonly billingAnchor: Date;
|
|
11328
|
+
/**
|
|
11329
|
+
* Settlement mode
|
|
11330
|
+
* @description The settlement mode of the subscription.
|
|
11331
|
+
* - credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.
|
|
11332
|
+
* - credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.
|
|
11333
|
+
* This is the default and most common settlement mode.
|
|
11334
|
+
* @default credit_then_invoice
|
|
11335
|
+
*/
|
|
11336
|
+
readonly settlementMode: components['schemas']['BillingSettlementMode'];
|
|
11269
11337
|
/** @description Alignment details enriched with the current billing period. */
|
|
11270
11338
|
alignment?: components['schemas']['SubscriptionAlignment'];
|
|
11271
11339
|
/** @description The phases of the subscription. */
|
|
@@ -12185,6 +12253,7 @@ export type BillingProfileExpand = components['schemas']['BillingProfileExpand']
|
|
|
12185
12253
|
export type BillingProfileOrderBy = components['schemas']['BillingProfileOrderBy'];
|
|
12186
12254
|
export type BillingProfilePaginatedResponse = components['schemas']['BillingProfilePaginatedResponse'];
|
|
12187
12255
|
export type BillingProfileReplaceUpdateWithWorkflow = components['schemas']['BillingProfileReplaceUpdateWithWorkflow'];
|
|
12256
|
+
export type BillingSettlementMode = components['schemas']['BillingSettlementMode'];
|
|
12188
12257
|
export type BillingTaxIdentificationCode = components['schemas']['BillingTaxIdentificationCode'];
|
|
12189
12258
|
export type BillingWorkflow = components['schemas']['BillingWorkflow'];
|
|
12190
12259
|
export type BillingWorkflowCollectionAlignment = components['schemas']['BillingWorkflowCollectionAlignment'];
|
|
@@ -32,6 +32,7 @@ export declare class Subscriptions {
|
|
|
32
32
|
readonly billingCadence: string;
|
|
33
33
|
readonly proRatingConfig?: import("./schemas.js").components["schemas"]["ProRatingConfig"];
|
|
34
34
|
readonly billingAnchor: Date;
|
|
35
|
+
readonly settlementMode: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
35
36
|
} | undefined>;
|
|
36
37
|
/**
|
|
37
38
|
* Get a subscription
|
|
@@ -57,6 +58,7 @@ export declare class Subscriptions {
|
|
|
57
58
|
readonly billingCadence: string;
|
|
58
59
|
readonly proRatingConfig?: import("./schemas.js").components["schemas"]["ProRatingConfig"];
|
|
59
60
|
readonly billingAnchor: Date;
|
|
61
|
+
readonly settlementMode: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
60
62
|
alignment?: import("./schemas.js").components["schemas"]["SubscriptionAlignment"];
|
|
61
63
|
phases: import("./schemas.js").components["schemas"]["SubscriptionPhaseExpanded"][];
|
|
62
64
|
} | undefined>;
|
|
@@ -86,6 +88,7 @@ export declare class Subscriptions {
|
|
|
86
88
|
readonly billingCadence: string;
|
|
87
89
|
readonly proRatingConfig?: import("./schemas.js").components["schemas"]["ProRatingConfig"];
|
|
88
90
|
readonly billingAnchor: Date;
|
|
91
|
+
readonly settlementMode: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
89
92
|
} | undefined>;
|
|
90
93
|
/**
|
|
91
94
|
* Cancel a subscription
|
|
@@ -113,6 +116,7 @@ export declare class Subscriptions {
|
|
|
113
116
|
readonly billingCadence: string;
|
|
114
117
|
readonly proRatingConfig?: import("./schemas.js").components["schemas"]["ProRatingConfig"];
|
|
115
118
|
readonly billingAnchor: Date;
|
|
119
|
+
readonly settlementMode: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
116
120
|
} | undefined>;
|
|
117
121
|
/**
|
|
118
122
|
* Change a subscription
|
|
@@ -163,6 +167,7 @@ export declare class Subscriptions {
|
|
|
163
167
|
readonly billingCadence: string;
|
|
164
168
|
readonly proRatingConfig?: import("./schemas.js").components["schemas"]["ProRatingConfig"];
|
|
165
169
|
readonly billingAnchor: Date;
|
|
170
|
+
readonly settlementMode: import("./schemas.js").components["schemas"]["BillingSettlementMode"];
|
|
166
171
|
} | undefined>;
|
|
167
172
|
/**
|
|
168
173
|
* Delete subscription
|
package/dist/src/zod/index.d.ts
CHANGED
|
@@ -3482,6 +3482,7 @@ export declare const createPlanBodyProRatingConfigDefault: {
|
|
|
3482
3482
|
readonly enabled: true;
|
|
3483
3483
|
readonly mode: "prorate_prices";
|
|
3484
3484
|
};
|
|
3485
|
+
export declare const createPlanBodySettlementModeDefault: "credit_then_invoice";
|
|
3485
3486
|
export declare const createPlanBodyPhasesItemKeyMax: 64;
|
|
3486
3487
|
export declare const createPlanBodyPhasesItemKeyRegExp: RegExp;
|
|
3487
3488
|
export declare const createPlanBodyPhasesItemNameMax: 256;
|
|
@@ -3727,6 +3728,10 @@ export declare const CreatePlanBody: zod.ZodObject<{
|
|
|
3727
3728
|
prorate_prices: "prorate_prices";
|
|
3728
3729
|
}>>;
|
|
3729
3730
|
}, zod.z.core.$strip>>;
|
|
3731
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
3732
|
+
credit_then_invoice: "credit_then_invoice";
|
|
3733
|
+
credit_only: "credit_only";
|
|
3734
|
+
}>>;
|
|
3730
3735
|
}, zod.z.core.$strip>;
|
|
3731
3736
|
/**
|
|
3732
3737
|
* Create a new draft version from plan.
|
|
@@ -3755,6 +3760,7 @@ export declare const updatePlanBodyProRatingConfigDefault: {
|
|
|
3755
3760
|
readonly enabled: true;
|
|
3756
3761
|
readonly mode: "prorate_prices";
|
|
3757
3762
|
};
|
|
3763
|
+
export declare const updatePlanBodySettlementModeDefault: "credit_then_invoice";
|
|
3758
3764
|
export declare const updatePlanBodyPhasesItemKeyMax: 64;
|
|
3759
3765
|
export declare const updatePlanBodyPhasesItemKeyRegExp: RegExp;
|
|
3760
3766
|
export declare const updatePlanBodyPhasesItemNameMax: 256;
|
|
@@ -3998,6 +4004,10 @@ export declare const UpdatePlanBody: zod.ZodObject<{
|
|
|
3998
4004
|
prorate_prices: "prorate_prices";
|
|
3999
4005
|
}>>;
|
|
4000
4006
|
}, zod.z.core.$strip>>;
|
|
4007
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
4008
|
+
credit_then_invoice: "credit_then_invoice";
|
|
4009
|
+
credit_only: "credit_only";
|
|
4010
|
+
}>>;
|
|
4001
4011
|
}, zod.z.core.$strip>;
|
|
4002
4012
|
/**
|
|
4003
4013
|
* Get a plan by id or key. The latest published version is returned if latter is used.
|
|
@@ -4730,6 +4740,7 @@ export declare const createSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDef
|
|
|
4730
4740
|
readonly enabled: true;
|
|
4731
4741
|
readonly mode: "prorate_prices";
|
|
4732
4742
|
};
|
|
4743
|
+
export declare const createSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault: "credit_then_invoice";
|
|
4733
4744
|
export declare const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax: 64;
|
|
4734
4745
|
export declare const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp: RegExp;
|
|
4735
4746
|
export declare const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax: 256;
|
|
@@ -4797,6 +4808,10 @@ export declare const CreateSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
4797
4808
|
key: zod.z.ZodCoercedString<unknown>;
|
|
4798
4809
|
version: zod.ZodOptional<zod.z.ZodCoercedNumber<unknown>>;
|
|
4799
4810
|
}, zod.z.core.$strip>;
|
|
4811
|
+
settlementMode: zod.ZodOptional<zod.ZodEnum<{
|
|
4812
|
+
credit_then_invoice: "credit_then_invoice";
|
|
4813
|
+
credit_only: "credit_only";
|
|
4814
|
+
}>>;
|
|
4800
4815
|
startingPhase: zod.ZodOptional<zod.z.ZodCoercedString<unknown>>;
|
|
4801
4816
|
timing: zod.ZodDefault<zod.ZodUnion<readonly [zod.ZodEnum<{
|
|
4802
4817
|
immediate: "immediate";
|
|
@@ -5000,6 +5015,10 @@ export declare const CreateSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
5000
5015
|
prorate_prices: "prorate_prices";
|
|
5001
5016
|
}>>;
|
|
5002
5017
|
}, zod.z.core.$strip>>;
|
|
5018
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
5019
|
+
credit_then_invoice: "credit_then_invoice";
|
|
5020
|
+
credit_only: "credit_only";
|
|
5021
|
+
}>>;
|
|
5003
5022
|
}, zod.z.core.$strip>;
|
|
5004
5023
|
timing: zod.ZodDefault<zod.ZodUnion<readonly [zod.ZodEnum<{
|
|
5005
5024
|
immediate: "immediate";
|
|
@@ -5415,6 +5434,7 @@ export declare const changeSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDef
|
|
|
5415
5434
|
readonly enabled: true;
|
|
5416
5435
|
readonly mode: "prorate_prices";
|
|
5417
5436
|
};
|
|
5437
|
+
export declare const changeSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault: "credit_then_invoice";
|
|
5418
5438
|
export declare const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax: 64;
|
|
5419
5439
|
export declare const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp: RegExp;
|
|
5420
5440
|
export declare const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax: 256;
|
|
@@ -5678,6 +5698,10 @@ export declare const ChangeSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
5678
5698
|
prorate_prices: "prorate_prices";
|
|
5679
5699
|
}>>;
|
|
5680
5700
|
}, zod.z.core.$strip>>;
|
|
5701
|
+
settlementMode: zod.ZodDefault<zod.ZodEnum<{
|
|
5702
|
+
credit_then_invoice: "credit_then_invoice";
|
|
5703
|
+
credit_only: "credit_only";
|
|
5704
|
+
}>>;
|
|
5681
5705
|
}, zod.z.core.$strip>;
|
|
5682
5706
|
timing: zod.ZodUnion<readonly [zod.ZodEnum<{
|
|
5683
5707
|
immediate: "immediate";
|
package/dist/src/zod/index.js
CHANGED
|
@@ -7203,6 +7203,7 @@ export const createPlanBodyProRatingConfigDefault = {
|
|
|
7203
7203
|
enabled: true,
|
|
7204
7204
|
mode: 'prorate_prices',
|
|
7205
7205
|
};
|
|
7206
|
+
export const createPlanBodySettlementModeDefault = 'credit_then_invoice';
|
|
7206
7207
|
export const createPlanBodyPhasesItemKeyMax = 64;
|
|
7207
7208
|
export const createPlanBodyPhasesItemKeyRegExp = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
|
|
7208
7209
|
export const createPlanBodyPhasesItemNameMax = 256;
|
|
@@ -7849,6 +7850,11 @@ export const CreatePlanBody = zod
|
|
|
7849
7850
|
.describe('Configuration for pro-rating behavior.')
|
|
7850
7851
|
.default(createPlanBodyProRatingConfigDefault)
|
|
7851
7852
|
.describe('Default pro-rating configuration for subscriptions using this plan.'),
|
|
7853
|
+
settlementMode: zod
|
|
7854
|
+
.enum(['credit_then_invoice', 'credit_only'])
|
|
7855
|
+
.describe('The settlement mode of a plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.')
|
|
7856
|
+
.default(createPlanBodySettlementModeDefault)
|
|
7857
|
+
.describe('The settlement mode of the plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.\nThis is the default and most common settlement mode.'),
|
|
7852
7858
|
})
|
|
7853
7859
|
.describe('Resource create operation model.');
|
|
7854
7860
|
/**
|
|
@@ -7882,6 +7888,7 @@ export const updatePlanBodyProRatingConfigDefault = {
|
|
|
7882
7888
|
enabled: true,
|
|
7883
7889
|
mode: 'prorate_prices',
|
|
7884
7890
|
};
|
|
7891
|
+
export const updatePlanBodySettlementModeDefault = 'credit_then_invoice';
|
|
7885
7892
|
export const updatePlanBodyPhasesItemKeyMax = 64;
|
|
7886
7893
|
export const updatePlanBodyPhasesItemKeyRegExp = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
|
|
7887
7894
|
export const updatePlanBodyPhasesItemNameMax = 256;
|
|
@@ -8514,6 +8521,11 @@ export const UpdatePlanBody = zod
|
|
|
8514
8521
|
.describe('Configuration for pro-rating behavior.')
|
|
8515
8522
|
.default(updatePlanBodyProRatingConfigDefault)
|
|
8516
8523
|
.describe('Default pro-rating configuration for subscriptions using this plan.'),
|
|
8524
|
+
settlementMode: zod
|
|
8525
|
+
.enum(['credit_then_invoice', 'credit_only'])
|
|
8526
|
+
.describe('The settlement mode of a plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.')
|
|
8527
|
+
.default(updatePlanBodySettlementModeDefault)
|
|
8528
|
+
.describe('The settlement mode of the plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.\nThis is the default and most common settlement mode.'),
|
|
8517
8529
|
})
|
|
8518
8530
|
.describe('Resource update operation model.');
|
|
8519
8531
|
/**
|
|
@@ -9823,6 +9835,7 @@ export const createSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDefault = {
|
|
|
9823
9835
|
enabled: true,
|
|
9824
9836
|
mode: 'prorate_prices',
|
|
9825
9837
|
};
|
|
9838
|
+
export const createSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault = 'credit_then_invoice';
|
|
9826
9839
|
export const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax = 64;
|
|
9827
9840
|
export const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
|
|
9828
9841
|
export const createSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax = 256;
|
|
@@ -9933,6 +9946,11 @@ export const CreateSubscriptionBody = zod
|
|
|
9933
9946
|
})
|
|
9934
9947
|
.describe('References an exact plan defaulting to the current active version.')
|
|
9935
9948
|
.describe('The plan reference to change to.'),
|
|
9949
|
+
settlementMode: zod
|
|
9950
|
+
.enum(['credit_then_invoice', 'credit_only'])
|
|
9951
|
+
.describe('The settlement mode of a plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.')
|
|
9952
|
+
.optional()
|
|
9953
|
+
.describe('The settlement mode of the subscription.'),
|
|
9936
9954
|
startingPhase: zod.coerce
|
|
9937
9955
|
.string()
|
|
9938
9956
|
.min(1)
|
|
@@ -10559,6 +10577,11 @@ export const CreateSubscriptionBody = zod
|
|
|
10559
10577
|
.describe('Configuration for pro-rating behavior.')
|
|
10560
10578
|
.default(createSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDefault)
|
|
10561
10579
|
.describe('Default pro-rating configuration for subscriptions using this plan.'),
|
|
10580
|
+
settlementMode: zod
|
|
10581
|
+
.enum(['credit_then_invoice', 'credit_only'])
|
|
10582
|
+
.describe('The settlement mode of a plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.')
|
|
10583
|
+
.default(createSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault)
|
|
10584
|
+
.describe('The settlement mode of the plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.\nThis is the default and most common settlement mode.'),
|
|
10562
10585
|
})
|
|
10563
10586
|
.describe('The template for omitting properties.')
|
|
10564
10587
|
.describe('Plan input for custom subscription creation (without key and version).')
|
|
@@ -11466,6 +11489,7 @@ export const changeSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDefault = {
|
|
|
11466
11489
|
enabled: true,
|
|
11467
11490
|
mode: 'prorate_prices',
|
|
11468
11491
|
};
|
|
11492
|
+
export const changeSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault = 'credit_then_invoice';
|
|
11469
11493
|
export const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax = 64;
|
|
11470
11494
|
export const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
|
|
11471
11495
|
export const changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax = 256;
|
|
@@ -12176,6 +12200,11 @@ export const ChangeSubscriptionBody = zod
|
|
|
12176
12200
|
.describe('Configuration for pro-rating behavior.')
|
|
12177
12201
|
.default(changeSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDefault)
|
|
12178
12202
|
.describe('Default pro-rating configuration for subscriptions using this plan.'),
|
|
12203
|
+
settlementMode: zod
|
|
12204
|
+
.enum(['credit_then_invoice', 'credit_only'])
|
|
12205
|
+
.describe('The settlement mode of a plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.')
|
|
12206
|
+
.default(changeSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault)
|
|
12207
|
+
.describe('The settlement mode of the plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.\nThis is the default and most common settlement mode.'),
|
|
12179
12208
|
})
|
|
12180
12209
|
.describe('The template for omitting properties.')
|
|
12181
12210
|
.describe('Plan input for custom subscription creation (without key and version).')
|