@openmeter/sdk 1.0.0-beta-8f1a0516de02 → 1.0.0-beta-0b7940036433
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/billing.d.cts +3 -2
- package/dist/cjs/src/client/schemas.d.cts +172 -118
- package/dist/cjs/{tsconfig.544a34b5.tsbuildinfo → tsconfig.a7cfd45c.tsbuildinfo} +1 -1
- package/dist/cjs/{tsconfig.a4c56cab.tsbuildinfo → tsconfig.e7add78a.tsbuildinfo} +1 -1
- package/dist/src/client/billing.d.ts +3 -2
- package/dist/src/client/schemas.d.ts +172 -118
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -401,7 +401,7 @@ export declare class BillingInvoices {
|
|
|
401
401
|
id: string;
|
|
402
402
|
readonly managedBy: import("./schemas.cjs").components["schemas"]["InvoiceLineManagedBy"];
|
|
403
403
|
readonly status: import("./schemas.cjs").components["schemas"]["InvoiceLineStatus"];
|
|
404
|
-
readonly discounts?: import("./schemas.cjs").components["schemas"]["
|
|
404
|
+
readonly discounts?: import("./schemas.cjs").components["schemas"]["InvoiceLineDiscounts"];
|
|
405
405
|
invoice?: import("./schemas.cjs").components["schemas"]["InvoiceReference"];
|
|
406
406
|
currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
|
|
407
407
|
readonly taxes?: import("./schemas.cjs").components["schemas"]["InvoiceLineTaxItem"][];
|
|
@@ -419,6 +419,7 @@ export declare class BillingInvoices {
|
|
|
419
419
|
readonly quantity?: import("./schemas.cjs").components["schemas"]["Numeric"];
|
|
420
420
|
readonly meteredQuantity?: import("./schemas.cjs").components["schemas"]["Numeric"];
|
|
421
421
|
readonly preLinePeriodQuantity?: import("./schemas.cjs").components["schemas"]["Numeric"];
|
|
422
|
+
readonly meteredPreLinePeriodQuantity?: import("./schemas.cjs").components["schemas"]["Numeric"];
|
|
422
423
|
} | {
|
|
423
424
|
name: string;
|
|
424
425
|
description?: string;
|
|
@@ -429,7 +430,7 @@ export declare class BillingInvoices {
|
|
|
429
430
|
id: string;
|
|
430
431
|
readonly managedBy: import("./schemas.cjs").components["schemas"]["InvoiceLineManagedBy"];
|
|
431
432
|
readonly status: import("./schemas.cjs").components["schemas"]["InvoiceLineStatus"];
|
|
432
|
-
readonly discounts?: import("./schemas.cjs").components["schemas"]["
|
|
433
|
+
readonly discounts?: import("./schemas.cjs").components["schemas"]["InvoiceLineDiscounts"];
|
|
433
434
|
invoice?: import("./schemas.cjs").components["schemas"]["InvoiceReference"];
|
|
434
435
|
currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
|
|
435
436
|
readonly taxes?: import("./schemas.cjs").components["schemas"]["InvoiceLineTaxItem"][];
|
|
@@ -2308,16 +2308,8 @@ export interface components {
|
|
|
2308
2308
|
* Expand settings govern if this includes the whole app object or just the ID references. */
|
|
2309
2309
|
readonly apps: components['schemas']['BillingProfileAppsOrReference'];
|
|
2310
2310
|
};
|
|
2311
|
-
/** @description A discount on a price. This extends the productcatalog.Discount union to include the
|
|
2312
|
-
* billing specific extra fields required. */
|
|
2313
|
-
BillingDiscount: components['schemas']['BillingDiscountPercentage'] | components['schemas']['BillingDiscountUsage'];
|
|
2314
2311
|
/** @description A percentage discount. */
|
|
2315
2312
|
BillingDiscountPercentage: {
|
|
2316
|
-
/**
|
|
2317
|
-
* @description The type of the discount. (enum property replaced by openapi-typescript)
|
|
2318
|
-
* @enum {string}
|
|
2319
|
-
*/
|
|
2320
|
-
type: 'percentage';
|
|
2321
2313
|
/**
|
|
2322
2314
|
* Percentage
|
|
2323
2315
|
* @description The percentage of the discount.
|
|
@@ -2328,18 +2320,17 @@ export interface components {
|
|
|
2328
2320
|
*
|
|
2329
2321
|
* This is used to link discounts across different invoices (progressive billing use case).
|
|
2330
2322
|
*
|
|
2331
|
-
* If not provided, the invoicing engine will auto-generate one.
|
|
2323
|
+
* If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
|
|
2324
|
+
* please make sure to keep the same correlation ID of the discount or in progressive billing
|
|
2325
|
+
* setups the discount amounts might be incorrect.
|
|
2332
2326
|
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
2333
2327
|
*/
|
|
2334
2328
|
correlationId?: string;
|
|
2335
2329
|
};
|
|
2330
|
+
/** @description The reason for the discount. */
|
|
2331
|
+
BillingDiscountReason: components['schemas']['DiscountReasonMaximumSpend'] | components['schemas']['DiscountReasonRatecardPercentage'] | components['schemas']['DiscountReasonRatecardUsage'];
|
|
2336
2332
|
/** @description A usage discount. */
|
|
2337
2333
|
BillingDiscountUsage: {
|
|
2338
|
-
/**
|
|
2339
|
-
* @description The type of the discount. (enum property replaced by openapi-typescript)
|
|
2340
|
-
* @enum {string}
|
|
2341
|
-
*/
|
|
2342
|
-
type: 'usage';
|
|
2343
2334
|
/**
|
|
2344
2335
|
* Usage
|
|
2345
2336
|
* @description The quantity of the usage discount.
|
|
@@ -2352,11 +2343,20 @@ export interface components {
|
|
|
2352
2343
|
*
|
|
2353
2344
|
* This is used to link discounts across different invoices (progressive billing use case).
|
|
2354
2345
|
*
|
|
2355
|
-
* If not provided, the invoicing engine will auto-generate one.
|
|
2346
|
+
* If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
|
|
2347
|
+
* please make sure to keep the same correlation ID of the discount or in progressive billing
|
|
2348
|
+
* setups the discount amounts might be incorrect.
|
|
2356
2349
|
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
2357
2350
|
*/
|
|
2358
2351
|
correlationId?: string;
|
|
2359
2352
|
};
|
|
2353
|
+
/** @description A discount by type. */
|
|
2354
|
+
BillingDiscounts: {
|
|
2355
|
+
/** @description The percentage discount. */
|
|
2356
|
+
percentage?: components['schemas']['BillingDiscountPercentage'];
|
|
2357
|
+
/** @description The usage discount. */
|
|
2358
|
+
usage?: components['schemas']['BillingDiscountUsage'];
|
|
2359
|
+
};
|
|
2360
2360
|
/** @description Party represents a person or business entity. */
|
|
2361
2361
|
BillingParty: {
|
|
2362
2362
|
/** @description Unique identifier for the party (if available) */
|
|
@@ -3366,20 +3366,71 @@ export interface components {
|
|
|
3366
3366
|
*/
|
|
3367
3367
|
subjectKeys: string[];
|
|
3368
3368
|
};
|
|
3369
|
-
/** @description A discount on a price. */
|
|
3370
|
-
Discount: components['schemas']['DiscountPercentage'] | components['schemas']['DiscountUsage'];
|
|
3371
3369
|
/** @description Percentage discount. */
|
|
3372
3370
|
DiscountPercentage: {
|
|
3373
3371
|
/**
|
|
3374
|
-
*
|
|
3372
|
+
* Percentage
|
|
3373
|
+
* @description The percentage of the discount.
|
|
3374
|
+
*/
|
|
3375
|
+
percentage: components['schemas']['Percentage'];
|
|
3376
|
+
};
|
|
3377
|
+
/** @description The reason for the discount is a maximum spend. */
|
|
3378
|
+
DiscountReasonMaximumSpend: {
|
|
3379
|
+
/**
|
|
3380
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3381
|
+
* @enum {string}
|
|
3382
|
+
*/
|
|
3383
|
+
type: 'maximum_spend';
|
|
3384
|
+
};
|
|
3385
|
+
/** @description The reason for the discount is a ratecard percentage. */
|
|
3386
|
+
DiscountReasonRatecardPercentage: {
|
|
3387
|
+
/**
|
|
3388
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3375
3389
|
* @enum {string}
|
|
3376
3390
|
*/
|
|
3377
|
-
type: '
|
|
3391
|
+
type: 'ratecard_percentage';
|
|
3378
3392
|
/**
|
|
3379
3393
|
* Percentage
|
|
3380
3394
|
* @description The percentage of the discount.
|
|
3381
3395
|
*/
|
|
3382
3396
|
percentage: components['schemas']['Percentage'];
|
|
3397
|
+
/**
|
|
3398
|
+
* @description Correlation ID for the discount.
|
|
3399
|
+
*
|
|
3400
|
+
* This is used to link discounts across different invoices (progressive billing use case).
|
|
3401
|
+
*
|
|
3402
|
+
* If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
|
|
3403
|
+
* please make sure to keep the same correlation ID of the discount or in progressive billing
|
|
3404
|
+
* setups the discount amounts might be incorrect.
|
|
3405
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
3406
|
+
*/
|
|
3407
|
+
correlationId?: string;
|
|
3408
|
+
};
|
|
3409
|
+
/** @description The reason for the discount is a ratecard usage. */
|
|
3410
|
+
DiscountReasonRatecardUsage: {
|
|
3411
|
+
/**
|
|
3412
|
+
* @description discriminator enum property added by openapi-typescript
|
|
3413
|
+
* @enum {string}
|
|
3414
|
+
*/
|
|
3415
|
+
type: 'ratecard_usage';
|
|
3416
|
+
/**
|
|
3417
|
+
* Usage
|
|
3418
|
+
* @description The quantity of the usage discount.
|
|
3419
|
+
*
|
|
3420
|
+
* Must be positive.
|
|
3421
|
+
*/
|
|
3422
|
+
quantity: components['schemas']['Numeric'];
|
|
3423
|
+
/**
|
|
3424
|
+
* @description Correlation ID for the discount.
|
|
3425
|
+
*
|
|
3426
|
+
* This is used to link discounts across different invoices (progressive billing use case).
|
|
3427
|
+
*
|
|
3428
|
+
* If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
|
|
3429
|
+
* please make sure to keep the same correlation ID of the discount or in progressive billing
|
|
3430
|
+
* setups the discount amounts might be incorrect.
|
|
3431
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
3432
|
+
*/
|
|
3433
|
+
correlationId?: string;
|
|
3383
3434
|
};
|
|
3384
3435
|
/** @description Usage discount.
|
|
3385
3436
|
*
|
|
@@ -3387,11 +3438,6 @@ export interface components {
|
|
|
3387
3438
|
* this means that any usage on a specific feature is considered 0 until this discount
|
|
3388
3439
|
* is exhausted. */
|
|
3389
3440
|
DiscountUsage: {
|
|
3390
|
-
/**
|
|
3391
|
-
* @description The type of the discount. (enum property replaced by openapi-typescript)
|
|
3392
|
-
* @enum {string}
|
|
3393
|
-
*/
|
|
3394
|
-
type: 'usage';
|
|
3395
3441
|
/**
|
|
3396
3442
|
* Usage
|
|
3397
3443
|
* @description The quantity of the usage discount.
|
|
@@ -3400,6 +3446,13 @@ export interface components {
|
|
|
3400
3446
|
*/
|
|
3401
3447
|
quantity: components['schemas']['Numeric'];
|
|
3402
3448
|
};
|
|
3449
|
+
/** @description Discount by type on a price */
|
|
3450
|
+
Discounts: {
|
|
3451
|
+
/** @description The percentage discount. */
|
|
3452
|
+
percentage?: components['schemas']['DiscountPercentage'];
|
|
3453
|
+
/** @description The usage discount. */
|
|
3454
|
+
usage?: components['schemas']['DiscountUsage'];
|
|
3455
|
+
};
|
|
3403
3456
|
/** @description Dynamic price with spend commitments. */
|
|
3404
3457
|
DynamicPriceWithCommitments: {
|
|
3405
3458
|
/**
|
|
@@ -4803,11 +4856,6 @@ export interface components {
|
|
|
4803
4856
|
/** @description Invoice a gathering invoice */
|
|
4804
4857
|
readonly invoice?: components['schemas']['InvoiceAvailableActionInvoiceDetails'];
|
|
4805
4858
|
};
|
|
4806
|
-
/**
|
|
4807
|
-
* @description Reason code.
|
|
4808
|
-
* @enum {string}
|
|
4809
|
-
*/
|
|
4810
|
-
InvoiceDiscountReason: 'maximum_spend' | 'ratecard_discount';
|
|
4811
4859
|
/** @description InvoiceDocumentRef is used to describe a reference to an existing document (invoice). */
|
|
4812
4860
|
InvoiceDocumentRef: components['schemas']['CreditNoteOriginalInvoiceRef'];
|
|
4813
4861
|
/**
|
|
@@ -4880,7 +4928,7 @@ export interface components {
|
|
|
4880
4928
|
*
|
|
4881
4929
|
* New discounts can be added via the invoice's discounts API, to facilitate
|
|
4882
4930
|
* discounts that are affecting multiple lines. */
|
|
4883
|
-
readonly discounts?: components['schemas']['
|
|
4931
|
+
readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
|
|
4884
4932
|
/** @description The invoice this item belongs to. */
|
|
4885
4933
|
invoice?: components['schemas']['InvoiceReference'];
|
|
4886
4934
|
/** @description The currency of this line. */
|
|
@@ -5099,7 +5147,7 @@ export interface components {
|
|
|
5099
5147
|
* Default: 1 */
|
|
5100
5148
|
quantity?: components['schemas']['Numeric'];
|
|
5101
5149
|
/** @description The discounts that are applied to the line. */
|
|
5102
|
-
discounts?: components['schemas']['
|
|
5150
|
+
discounts?: components['schemas']['BillingDiscounts'];
|
|
5103
5151
|
};
|
|
5104
5152
|
/**
|
|
5105
5153
|
* InvoiceGenericDocumentRef is used to describe an existing document or a specific part of it's contents.
|
|
@@ -5118,17 +5166,8 @@ export interface components {
|
|
|
5118
5166
|
};
|
|
5119
5167
|
/** @description BillingInvoiceLine represents a line item that is sold to the customer based on a specific (unit) price. */
|
|
5120
5168
|
InvoiceLine: components['schemas']['InvoiceUsageBasedLine'] | components['schemas']['InvoiceFlatFeeLine'];
|
|
5121
|
-
/** @description
|
|
5122
|
-
|
|
5123
|
-
/** @description The external ID of the invoice in the invoicing app if available. */
|
|
5124
|
-
readonly invoicing?: string;
|
|
5125
|
-
/** @description The external ID of the invoice in the tax app if available. */
|
|
5126
|
-
readonly tax?: string;
|
|
5127
|
-
};
|
|
5128
|
-
/** @description InvoiceLineDiscount represents the actual discount applied to the invoice line. */
|
|
5129
|
-
InvoiceLineDiscount: components['schemas']['InvoiceLineDiscountAmount'] | components['schemas']['InvoiceLineDiscountUsage'];
|
|
5130
|
-
/** @description InvoiceLineDiscountAmount represents an amount deducted from the line, and will be applied before taxes. */
|
|
5131
|
-
InvoiceLineDiscountAmount: {
|
|
5169
|
+
/** @description InvoiceLineAmountDiscount represents an amount deducted from the line, and will be applied before taxes. */
|
|
5170
|
+
InvoiceLineAmountDiscount: {
|
|
5132
5171
|
/**
|
|
5133
5172
|
* Creation Time
|
|
5134
5173
|
* Format: date-time
|
|
@@ -5156,28 +5195,81 @@ export interface components {
|
|
|
5156
5195
|
*/
|
|
5157
5196
|
readonly id: string;
|
|
5158
5197
|
/** @description Reason code. */
|
|
5159
|
-
readonly reason: components['schemas']['
|
|
5198
|
+
readonly reason: components['schemas']['BillingDiscountReason'];
|
|
5160
5199
|
/** @description Text description as to why the discount was applied. */
|
|
5161
5200
|
readonly description?: string;
|
|
5162
5201
|
/** @description External IDs of the invoice in other apps such as Stripe. */
|
|
5163
5202
|
readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
|
|
5164
|
-
/** @description The discount from the rate card this discount is based on. */
|
|
5165
|
-
readonly rateCardDiscount?: components['schemas']['Discount'];
|
|
5166
5203
|
/**
|
|
5167
5204
|
* Amount in the currency of the invoice
|
|
5168
5205
|
* @description Fixed discount amount to apply (calculated if percent present).
|
|
5169
5206
|
*/
|
|
5170
5207
|
readonly amount: components['schemas']['Numeric'];
|
|
5171
|
-
/**
|
|
5172
|
-
* @description The type of the discount. (enum property replaced by openapi-typescript)
|
|
5173
|
-
* @enum {string}
|
|
5174
|
-
*/
|
|
5175
|
-
type: 'amount';
|
|
5176
5208
|
};
|
|
5177
|
-
/** @description
|
|
5209
|
+
/** @description InvoiceLineAppExternalIds contains the external IDs of the invoice in other apps such as Stripe. */
|
|
5210
|
+
InvoiceLineAppExternalIds: {
|
|
5211
|
+
/** @description The external ID of the invoice in the invoicing app if available. */
|
|
5212
|
+
readonly invoicing?: string;
|
|
5213
|
+
/** @description The external ID of the invoice in the tax app if available. */
|
|
5214
|
+
readonly tax?: string;
|
|
5215
|
+
};
|
|
5216
|
+
/** @description InvoiceLineDiscounts represents the discounts applied to the invoice line by type. */
|
|
5217
|
+
InvoiceLineDiscounts: {
|
|
5218
|
+
/** @description Amount based discounts applied to the line.
|
|
5219
|
+
*
|
|
5220
|
+
* Amount based discounts are deduced from the total price of the line. */
|
|
5221
|
+
amount?: components['schemas']['InvoiceLineAmountDiscount'][];
|
|
5222
|
+
/** @description Usage based discounts applied to the line.
|
|
5223
|
+
*
|
|
5224
|
+
* Usage based discounts are deduced from the usage of the line before price calculations are applied. */
|
|
5225
|
+
usage?: components['schemas']['InvoiceLineUsageDiscount'][];
|
|
5226
|
+
};
|
|
5227
|
+
/**
|
|
5228
|
+
* @description InvoiceLineManagedBy specifies who manages the line.
|
|
5229
|
+
* @enum {string}
|
|
5230
|
+
*/
|
|
5231
|
+
InvoiceLineManagedBy: 'subscription' | 'system' | 'manual';
|
|
5232
|
+
/** @description InvoiceLineReplaceUpdate represents the update model for an invoice line. */
|
|
5233
|
+
InvoiceLineReplaceUpdate: components['schemas']['InvoiceUsageBasedLineReplaceUpdate'] | components['schemas']['InvoiceFlatFeeLineReplaceUpdate'];
|
|
5234
|
+
/**
|
|
5235
|
+
* @description Line status specifies the status of the line.
|
|
5236
|
+
* @enum {string}
|
|
5237
|
+
*/
|
|
5238
|
+
InvoiceLineStatus: 'valid' | 'detail' | 'split';
|
|
5239
|
+
/** @description InvoiceLineSubscriptionReference contains the references to the subscription that this line is related to. */
|
|
5240
|
+
InvoiceLineSubscriptionReference: {
|
|
5241
|
+
/** @description The subscription. */
|
|
5242
|
+
readonly subscription: components['schemas']['IDResource'];
|
|
5243
|
+
/** @description The phase of the subscription. */
|
|
5244
|
+
readonly phase: components['schemas']['IDResource'];
|
|
5245
|
+
/** @description The item this line is related to. */
|
|
5246
|
+
readonly item: components['schemas']['IDResource'];
|
|
5247
|
+
};
|
|
5248
|
+
/**
|
|
5249
|
+
* @description InvoiceLineTaxBehavior details how the tax item is applied to the base amount.
|
|
5250
|
+
*
|
|
5251
|
+
* Inclusive means the tax is included in the base amount.
|
|
5252
|
+
* Exclusive means the tax is added to the base amount.
|
|
5253
|
+
* @enum {string}
|
|
5254
|
+
*/
|
|
5255
|
+
InvoiceLineTaxBehavior: 'inclusive' | 'exclusive';
|
|
5256
|
+
/** @description TaxConfig stores the configuration for a tax line relative to an invoice line. */
|
|
5257
|
+
InvoiceLineTaxItem: {
|
|
5258
|
+
/** @description Tax provider configuration. */
|
|
5259
|
+
readonly config?: components['schemas']['TaxConfig'];
|
|
5260
|
+
/** @description Percent defines the percentage set manually or determined from
|
|
5261
|
+
* the rate key (calculated if rate present). A nil percent implies that
|
|
5262
|
+
* this tax combo is **exempt** from tax.") */
|
|
5263
|
+
readonly percent?: components['schemas']['Percentage'];
|
|
5264
|
+
/** @description Some countries require an additional surcharge (calculated if rate present). */
|
|
5265
|
+
readonly surcharge?: components['schemas']['Numeric'];
|
|
5266
|
+
/** @description Is the tax item inclusive or exclusive of the base amount. */
|
|
5267
|
+
readonly behavior?: components['schemas']['InvoiceLineTaxBehavior'];
|
|
5268
|
+
};
|
|
5269
|
+
/** @description InvoiceLineUsageDiscount represents an usage-based discount applied to the line.
|
|
5178
5270
|
*
|
|
5179
5271
|
* The deduction is done before the pricing algorithm is applied. */
|
|
5180
|
-
|
|
5272
|
+
InvoiceLineUsageDiscount: {
|
|
5181
5273
|
/**
|
|
5182
5274
|
* Creation Time
|
|
5183
5275
|
* Format: date-time
|
|
@@ -5205,13 +5297,11 @@ export interface components {
|
|
|
5205
5297
|
*/
|
|
5206
5298
|
readonly id: string;
|
|
5207
5299
|
/** @description Reason code. */
|
|
5208
|
-
readonly reason: components['schemas']['
|
|
5300
|
+
readonly reason: components['schemas']['BillingDiscountReason'];
|
|
5209
5301
|
/** @description Text description as to why the discount was applied. */
|
|
5210
5302
|
readonly description?: string;
|
|
5211
5303
|
/** @description External IDs of the invoice in other apps such as Stripe. */
|
|
5212
5304
|
readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
|
|
5213
|
-
/** @description The discount from the rate card this discount is based on. */
|
|
5214
|
-
readonly rateCardDiscount?: components['schemas']['Discount'];
|
|
5215
5305
|
/**
|
|
5216
5306
|
* Usage quantity in the unit of the underlying meter
|
|
5217
5307
|
* @description The usage to apply.
|
|
@@ -5224,53 +5314,6 @@ export interface components {
|
|
|
5224
5314
|
* Only set if progressive billing is enabled and the line is a split line.
|
|
5225
5315
|
*/
|
|
5226
5316
|
readonly preLinePeriodQuantity?: components['schemas']['Numeric'];
|
|
5227
|
-
/**
|
|
5228
|
-
* @description The type of the discount. (enum property replaced by openapi-typescript)
|
|
5229
|
-
* @enum {string}
|
|
5230
|
-
*/
|
|
5231
|
-
type: 'usage';
|
|
5232
|
-
};
|
|
5233
|
-
/**
|
|
5234
|
-
* @description InvoiceLineManagedBy specifies who manages the line.
|
|
5235
|
-
* @enum {string}
|
|
5236
|
-
*/
|
|
5237
|
-
InvoiceLineManagedBy: 'subscription' | 'system' | 'manual';
|
|
5238
|
-
/** @description InvoiceLineReplaceUpdate represents the update model for an invoice line. */
|
|
5239
|
-
InvoiceLineReplaceUpdate: components['schemas']['InvoiceUsageBasedLineReplaceUpdate'] | components['schemas']['InvoiceFlatFeeLineReplaceUpdate'];
|
|
5240
|
-
/**
|
|
5241
|
-
* @description Line status specifies the status of the line.
|
|
5242
|
-
* @enum {string}
|
|
5243
|
-
*/
|
|
5244
|
-
InvoiceLineStatus: 'valid' | 'detail' | 'split';
|
|
5245
|
-
/** @description InvoiceLineSubscriptionReference contains the references to the subscription that this line is related to. */
|
|
5246
|
-
InvoiceLineSubscriptionReference: {
|
|
5247
|
-
/** @description The subscription. */
|
|
5248
|
-
readonly subscription: components['schemas']['IDResource'];
|
|
5249
|
-
/** @description The phase of the subscription. */
|
|
5250
|
-
readonly phase: components['schemas']['IDResource'];
|
|
5251
|
-
/** @description The item this line is related to. */
|
|
5252
|
-
readonly item: components['schemas']['IDResource'];
|
|
5253
|
-
};
|
|
5254
|
-
/**
|
|
5255
|
-
* @description InvoiceLineTaxBehavior details how the tax item is applied to the base amount.
|
|
5256
|
-
*
|
|
5257
|
-
* Inclusive means the tax is included in the base amount.
|
|
5258
|
-
* Exclusive means the tax is added to the base amount.
|
|
5259
|
-
* @enum {string}
|
|
5260
|
-
*/
|
|
5261
|
-
InvoiceLineTaxBehavior: 'inclusive' | 'exclusive';
|
|
5262
|
-
/** @description TaxConfig stores the configuration for a tax line relative to an invoice line. */
|
|
5263
|
-
InvoiceLineTaxItem: {
|
|
5264
|
-
/** @description Tax provider configuration. */
|
|
5265
|
-
readonly config?: components['schemas']['TaxConfig'];
|
|
5266
|
-
/** @description Percent defines the percentage set manually or determined from
|
|
5267
|
-
* the rate key (calculated if rate present). A nil percent implies that
|
|
5268
|
-
* this tax combo is **exempt** from tax.") */
|
|
5269
|
-
readonly percent?: components['schemas']['Percentage'];
|
|
5270
|
-
/** @description Some countries require an additional surcharge (calculated if rate present). */
|
|
5271
|
-
readonly surcharge?: components['schemas']['Numeric'];
|
|
5272
|
-
/** @description Is the tax item inclusive or exclusive of the base amount. */
|
|
5273
|
-
readonly behavior?: components['schemas']['InvoiceLineTaxBehavior'];
|
|
5274
5317
|
};
|
|
5275
5318
|
/**
|
|
5276
5319
|
* @description InvoiceNumber is a unique identifier for the invoice, generated by the
|
|
@@ -5627,7 +5670,7 @@ export interface components {
|
|
|
5627
5670
|
*
|
|
5628
5671
|
* New discounts can be added via the invoice's discounts API, to facilitate
|
|
5629
5672
|
* discounts that are affecting multiple lines. */
|
|
5630
|
-
readonly discounts?: components['schemas']['
|
|
5673
|
+
readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
|
|
5631
5674
|
/** @description The invoice this item belongs to. */
|
|
5632
5675
|
invoice?: components['schemas']['InvoiceReference'];
|
|
5633
5676
|
/** @description The currency of this line. */
|
|
@@ -5676,14 +5719,22 @@ export interface components {
|
|
|
5676
5719
|
*
|
|
5677
5720
|
* The rate card captures the intent of the price and discounts for the usage-based item. */
|
|
5678
5721
|
rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
|
|
5679
|
-
/** @description The quantity of the item being sold.
|
|
5722
|
+
/** @description The quantity of the item being sold.
|
|
5723
|
+
*
|
|
5724
|
+
* Any usage discounts applied previously are deducted from this quantity. */
|
|
5680
5725
|
readonly quantity?: components['schemas']['Numeric'];
|
|
5681
5726
|
/** @description The quantity of the item that has been metered for the period before any discounts were applied. */
|
|
5682
5727
|
readonly meteredQuantity?: components['schemas']['Numeric'];
|
|
5683
|
-
/** @description The quantity of the item used
|
|
5728
|
+
/** @description The quantity of the item used before this line's period.
|
|
5684
5729
|
*
|
|
5685
|
-
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
|
|
5730
|
+
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
|
|
5731
|
+
*
|
|
5732
|
+
* Any usage discounts applied previously are deducted from this quantity. */
|
|
5686
5733
|
readonly preLinePeriodQuantity?: components['schemas']['Numeric'];
|
|
5734
|
+
/** @description The metered quantity of the item used in before this line's period without any discounts applied.
|
|
5735
|
+
*
|
|
5736
|
+
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */
|
|
5737
|
+
readonly meteredPreLinePeriodQuantity?: components['schemas']['Numeric'];
|
|
5687
5738
|
};
|
|
5688
5739
|
/** @description InvoiceUpdateUsageBasedLineReplaceUpdate represents the update model for an UBP invoice line.
|
|
5689
5740
|
*
|
|
@@ -5820,7 +5871,7 @@ export interface components {
|
|
|
5820
5871
|
* When null, the feature or service is free. */
|
|
5821
5872
|
price: components['schemas']['RateCardUsageBasedPrice'] | null;
|
|
5822
5873
|
/** @description The discounts that are applied to the line. */
|
|
5823
|
-
discounts?: components['schemas']['
|
|
5874
|
+
discounts?: components['schemas']['BillingDiscounts'];
|
|
5824
5875
|
};
|
|
5825
5876
|
/** @description InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow. */
|
|
5826
5877
|
InvoiceWorkflowInvoicingSettingsReplaceUpdate: {
|
|
@@ -7309,7 +7360,7 @@ export interface components {
|
|
|
7309
7360
|
* @description The discount of the rate card. For flat fee rate cards only percentage discounts are supported.
|
|
7310
7361
|
* Only available when price is set.
|
|
7311
7362
|
*/
|
|
7312
|
-
discounts?: components['schemas']['
|
|
7363
|
+
discounts?: components['schemas']['Discounts'];
|
|
7313
7364
|
};
|
|
7314
7365
|
/** @description The entitlement template with a metered entitlement. */
|
|
7315
7366
|
RateCardMeteredEntitlement: {
|
|
@@ -7428,7 +7479,7 @@ export interface components {
|
|
|
7428
7479
|
*
|
|
7429
7480
|
* Flat fee rate cards only support percentage discounts.
|
|
7430
7481
|
*/
|
|
7431
|
-
discounts?: components['schemas']['
|
|
7482
|
+
discounts?: components['schemas']['Discounts'];
|
|
7432
7483
|
};
|
|
7433
7484
|
/** @description The price of the usage based rate card. */
|
|
7434
7485
|
RateCardUsageBasedPrice: components['schemas']['FlatPriceWithPaymentTerm'] | components['schemas']['UnitPriceWithCommitments'] | components['schemas']['TieredPriceWithCommitments'] | components['schemas']['DynamicPriceWithCommitments'] | components['schemas']['PackagePriceWithCommitments'];
|
|
@@ -8431,7 +8482,7 @@ export interface components {
|
|
|
8431
8482
|
* Discounts
|
|
8432
8483
|
* @description The discounts applied to the rate card.
|
|
8433
8484
|
*/
|
|
8434
|
-
discounts?: components['schemas']['
|
|
8485
|
+
discounts?: components['schemas']['Discounts'];
|
|
8435
8486
|
/** @description Describes what access is gained via the SubscriptionItem */
|
|
8436
8487
|
included?: components['schemas']['SubscriptionItemIncluded'];
|
|
8437
8488
|
/**
|
|
@@ -8490,7 +8541,7 @@ export interface components {
|
|
|
8490
8541
|
* Discounts
|
|
8491
8542
|
* @description The discounts on the plan.
|
|
8492
8543
|
*/
|
|
8493
|
-
discounts?: components['schemas']['
|
|
8544
|
+
discounts?: components['schemas']['Discounts'];
|
|
8494
8545
|
/** @description A locally unique identifier for the phase. */
|
|
8495
8546
|
key: string;
|
|
8496
8547
|
/** @description The name of the phase. */
|
|
@@ -8548,7 +8599,7 @@ export interface components {
|
|
|
8548
8599
|
* Discounts
|
|
8549
8600
|
* @description The discounts on the plan.
|
|
8550
8601
|
*/
|
|
8551
|
-
discounts?: components['schemas']['
|
|
8602
|
+
discounts?: components['schemas']['Discounts'];
|
|
8552
8603
|
/**
|
|
8553
8604
|
* Format: date-time
|
|
8554
8605
|
* @description The time from which the phase is active.
|
|
@@ -9090,9 +9141,10 @@ export type AppType = components['schemas']['AppType'];
|
|
|
9090
9141
|
export type BadRequestProblemResponse = components['schemas']['BadRequestProblemResponse'];
|
|
9091
9142
|
export type BalanceHistoryWindow = components['schemas']['BalanceHistoryWindow'];
|
|
9092
9143
|
export type BillingCustomerProfile = components['schemas']['BillingCustomerProfile'];
|
|
9093
|
-
export type BillingDiscount = components['schemas']['BillingDiscount'];
|
|
9094
9144
|
export type BillingDiscountPercentage = components['schemas']['BillingDiscountPercentage'];
|
|
9145
|
+
export type BillingDiscountReason = components['schemas']['BillingDiscountReason'];
|
|
9095
9146
|
export type BillingDiscountUsage = components['schemas']['BillingDiscountUsage'];
|
|
9147
|
+
export type BillingDiscounts = components['schemas']['BillingDiscounts'];
|
|
9096
9148
|
export type BillingParty = components['schemas']['BillingParty'];
|
|
9097
9149
|
export type BillingPartyReplaceUpdate = components['schemas']['BillingPartyReplaceUpdate'];
|
|
9098
9150
|
export type BillingPartyTaxIdentity = components['schemas']['BillingPartyTaxIdentity'];
|
|
@@ -9157,9 +9209,12 @@ export type CustomerOrderBy = components['schemas']['CustomerOrderBy'];
|
|
|
9157
9209
|
export type CustomerPaginatedResponse = components['schemas']['CustomerPaginatedResponse'];
|
|
9158
9210
|
export type CustomerReplaceUpdate = components['schemas']['CustomerReplaceUpdate'];
|
|
9159
9211
|
export type CustomerUsageAttribution = components['schemas']['CustomerUsageAttribution'];
|
|
9160
|
-
export type Discount = components['schemas']['Discount'];
|
|
9161
9212
|
export type DiscountPercentage = components['schemas']['DiscountPercentage'];
|
|
9213
|
+
export type DiscountReasonMaximumSpend = components['schemas']['DiscountReasonMaximumSpend'];
|
|
9214
|
+
export type DiscountReasonRatecardPercentage = components['schemas']['DiscountReasonRatecardPercentage'];
|
|
9215
|
+
export type DiscountReasonRatecardUsage = components['schemas']['DiscountReasonRatecardUsage'];
|
|
9162
9216
|
export type DiscountUsage = components['schemas']['DiscountUsage'];
|
|
9217
|
+
export type Discounts = components['schemas']['Discounts'];
|
|
9163
9218
|
export type DynamicPriceWithCommitments = components['schemas']['DynamicPriceWithCommitments'];
|
|
9164
9219
|
export type EditSubscriptionAddItem = components['schemas']['EditSubscriptionAddItem'];
|
|
9165
9220
|
export type EditSubscriptionAddPhase = components['schemas']['EditSubscriptionAddPhase'];
|
|
@@ -9210,7 +9265,6 @@ export type InvoiceAppExternalIds = components['schemas']['InvoiceAppExternalIds
|
|
|
9210
9265
|
export type InvoiceAvailableActionDetails = components['schemas']['InvoiceAvailableActionDetails'];
|
|
9211
9266
|
export type InvoiceAvailableActionInvoiceDetails = components['schemas']['InvoiceAvailableActionInvoiceDetails'];
|
|
9212
9267
|
export type InvoiceAvailableActions = components['schemas']['InvoiceAvailableActions'];
|
|
9213
|
-
export type InvoiceDiscountReason = components['schemas']['InvoiceDiscountReason'];
|
|
9214
9268
|
export type InvoiceDocumentRef = components['schemas']['InvoiceDocumentRef'];
|
|
9215
9269
|
export type InvoiceDocumentRefType = components['schemas']['InvoiceDocumentRefType'];
|
|
9216
9270
|
export type InvoiceExpand = components['schemas']['InvoiceExpand'];
|
|
@@ -9221,16 +9275,16 @@ export type InvoiceFlatFeePendingLineCreate = components['schemas']['InvoiceFlat
|
|
|
9221
9275
|
export type InvoiceFlatFeeRateCard = components['schemas']['InvoiceFlatFeeRateCard'];
|
|
9222
9276
|
export type InvoiceGenericDocumentRef = components['schemas']['InvoiceGenericDocumentRef'];
|
|
9223
9277
|
export type InvoiceLine = components['schemas']['InvoiceLine'];
|
|
9278
|
+
export type InvoiceLineAmountDiscount = components['schemas']['InvoiceLineAmountDiscount'];
|
|
9224
9279
|
export type InvoiceLineAppExternalIds = components['schemas']['InvoiceLineAppExternalIds'];
|
|
9225
|
-
export type
|
|
9226
|
-
export type InvoiceLineDiscountAmount = components['schemas']['InvoiceLineDiscountAmount'];
|
|
9227
|
-
export type InvoiceLineDiscountUsage = components['schemas']['InvoiceLineDiscountUsage'];
|
|
9280
|
+
export type InvoiceLineDiscounts = components['schemas']['InvoiceLineDiscounts'];
|
|
9228
9281
|
export type InvoiceLineManagedBy = components['schemas']['InvoiceLineManagedBy'];
|
|
9229
9282
|
export type InvoiceLineReplaceUpdate = components['schemas']['InvoiceLineReplaceUpdate'];
|
|
9230
9283
|
export type InvoiceLineStatus = components['schemas']['InvoiceLineStatus'];
|
|
9231
9284
|
export type InvoiceLineSubscriptionReference = components['schemas']['InvoiceLineSubscriptionReference'];
|
|
9232
9285
|
export type InvoiceLineTaxBehavior = components['schemas']['InvoiceLineTaxBehavior'];
|
|
9233
9286
|
export type InvoiceLineTaxItem = components['schemas']['InvoiceLineTaxItem'];
|
|
9287
|
+
export type InvoiceLineUsageDiscount = components['schemas']['InvoiceLineUsageDiscount'];
|
|
9234
9288
|
export type InvoiceNumber = components['schemas']['InvoiceNumber'];
|
|
9235
9289
|
export type InvoiceOrderBy = components['schemas']['InvoiceOrderBy'];
|
|
9236
9290
|
export type InvoicePaginatedResponse = components['schemas']['InvoicePaginatedResponse'];
|