@openmeter/sdk 1.0.0-beta-491b73a4e260 → 1.0.0-beta-dc555220d9fa

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.
@@ -3193,7 +3193,7 @@ export interface components {
3193
3193
  * @description Type of the invoice.
3194
3194
  * @enum {string}
3195
3195
  */
3196
- type: 'credit_node_original_invoice';
3196
+ type: 'credit_note_original_invoice';
3197
3197
  /**
3198
3198
  * Format: date-time
3199
3199
  * @description IssueAt reflects the time the document was issued.
@@ -5288,26 +5288,8 @@ export interface components {
5288
5288
  /** @description Invoice a gathering invoice */
5289
5289
  readonly invoice?: components['schemas']['InvoiceAvailableActionInvoiceDetails'];
5290
5290
  };
5291
- /** @description InvoiceDocumentRef is used to describe a reference to an existing document (invoice). */
5292
- InvoiceDocumentRef: components['schemas']['CreditNoteOriginalInvoiceRef'];
5293
- /**
5294
- * @description InvoiceDocumentRefType defines the type of document that is being referenced.
5295
- * @enum {string}
5296
- */
5297
- InvoiceDocumentRefType: 'credit_node_original_invoice';
5298
- /**
5299
- * @description InvoiceExpand specifies the parts of the invoice to expand in the list output.
5300
- * @enum {string}
5301
- */
5302
- InvoiceExpand: 'lines' | 'preceding' | 'workflow.apps';
5303
- /**
5304
- * @description InvoiceFlatFeeCategory determines if the flat fee is a regular fee due to use due to a
5305
- * commitment.
5306
- * @enum {string}
5307
- */
5308
- InvoiceFlatFeeCategory: 'regular' | 'commitment';
5309
- /** @description InvoiceFlatFeeLine represents a line item that is sold to the customer as a manually added fee. */
5310
- InvoiceFlatFeeLine: {
5291
+ /** @description InvoiceDetailedLine represents a line item that is sold to the customer as a manually added fee. */
5292
+ InvoiceDetailedLine: {
5311
5293
  /**
5312
5294
  * Display name
5313
5295
  * @description Human-readable name for the resource. Between 1 and 256 characters.
@@ -5372,8 +5354,6 @@ export interface components {
5372
5354
  * @description Tax config specify the tax configuration for this line.
5373
5355
  */
5374
5356
  taxConfig?: components['schemas']['TaxConfig'];
5375
- /** @description The lines detailing the item or service sold. */
5376
- readonly children?: components['schemas']['InvoiceLine'][];
5377
5357
  /** @description Totals for this line. */
5378
5358
  readonly totals: components['schemas']['InvoiceTotals'];
5379
5359
  /** @description Period of the line item applies to for revenue recognition pruposes.
@@ -5391,10 +5371,11 @@ export interface components {
5391
5371
  /** @description Subscription are the references to the subscritpions that this line is related to. */
5392
5372
  readonly subscription?: components['schemas']['InvoiceLineSubscriptionReference'];
5393
5373
  /**
5394
- * @description Type of the line. (enum property replaced by openapi-typescript)
5374
+ * @deprecated
5375
+ * @description Type of the line.
5395
5376
  * @enum {string}
5396
5377
  */
5397
- type: 'flat_fee';
5378
+ readonly type: 'flat_fee';
5398
5379
  /**
5399
5380
  * @deprecated
5400
5381
  * @description Price of the item being sold.
@@ -5412,17 +5393,74 @@ export interface components {
5412
5393
  */
5413
5394
  quantity?: components['schemas']['Numeric'];
5414
5395
  /** @description The rate card that is used for this line. */
5415
- rateCard?: components['schemas']['InvoiceFlatFeeRateCard'];
5396
+ rateCard?: components['schemas']['InvoiceDetailedLineRateCard'];
5416
5397
  /**
5417
5398
  * @description Category of the flat fee.
5418
5399
  * @default regular
5419
5400
  */
5420
- category?: components['schemas']['InvoiceFlatFeeCategory'];
5401
+ readonly category?: components['schemas']['InvoiceDetailedLineCostCategory'];
5421
5402
  };
5422
- /** @description InvoiceFlatFeeLineReplaceUpdate represents the update model for a flat fee invoice line.
5423
- *
5424
- * This type makes ID optional to allow for creating new lines as part of the update. */
5425
- InvoiceFlatFeeLineReplaceUpdate: {
5403
+ /**
5404
+ * @description InvoiceDetailedLineCostCategory determines if the flat fee is a regular fee due to use due to a
5405
+ * commitment.
5406
+ * @enum {string}
5407
+ */
5408
+ InvoiceDetailedLineCostCategory: 'regular' | 'commitment';
5409
+ /** @description InvoiceDetailedLineRateCard represents the rate card (intent) for a flat fee line. */
5410
+ InvoiceDetailedLineRateCard: {
5411
+ /**
5412
+ * Tax config
5413
+ * @description The tax config of the rate card.
5414
+ * When undefined, the tax config of the feature or the default tax config of the plan is used.
5415
+ */
5416
+ taxConfig?: components['schemas']['TaxConfig'];
5417
+ /**
5418
+ * Price
5419
+ * @description The price of the rate card.
5420
+ * When null, the feature or service is free.
5421
+ * @example {
5422
+ * "type": "flat",
5423
+ * "amount": "100",
5424
+ * "paymentTerm": "in_arrears"
5425
+ * }
5426
+ */
5427
+ price: components['schemas']['FlatPriceWithPaymentTerm'] | null;
5428
+ /** @description Quantity of the item being sold.
5429
+ *
5430
+ * Default: 1 */
5431
+ quantity?: components['schemas']['Numeric'];
5432
+ /** @description The discounts that are applied to the line. */
5433
+ discounts?: components['schemas']['BillingDiscounts'];
5434
+ };
5435
+ /** @description InvoiceDocumentRef is used to describe a reference to an existing document (invoice). */
5436
+ InvoiceDocumentRef: components['schemas']['CreditNoteOriginalInvoiceRef'];
5437
+ /**
5438
+ * @description InvoiceDocumentRefType defines the type of document that is being referenced.
5439
+ * @enum {string}
5440
+ */
5441
+ InvoiceDocumentRefType: 'credit_note_original_invoice';
5442
+ /**
5443
+ * @description InvoiceExpand specifies the parts of the invoice to expand in the list output.
5444
+ * @enum {string}
5445
+ */
5446
+ InvoiceExpand: 'lines' | 'preceding' | 'workflow.apps';
5447
+ /**
5448
+ * InvoiceGenericDocumentRef is used to describe an existing document or a specific part of it's contents.
5449
+ * @description Omitted fields:
5450
+ * period: Tax period in which the referred document had an effect required by some tax regimes and formats.
5451
+ * stamps: Seals of approval from other organisations that may need to be listed.
5452
+ * ext: Extensions for additional codes that may be required.
5453
+ */
5454
+ InvoiceGenericDocumentRef: {
5455
+ /** @description Type of the document referenced. */
5456
+ readonly type: components['schemas']['InvoiceDocumentRefType'];
5457
+ /** @description Human readable description on why this reference is here or needs to be used. */
5458
+ readonly reason?: string;
5459
+ /** @description Additional details about the document. */
5460
+ readonly description?: string;
5461
+ };
5462
+ /** @description InvoiceUsageBasedLine represents a line item that is sold to the customer based on usage. */
5463
+ InvoiceLine: {
5426
5464
  /**
5427
5465
  * Display name
5428
5466
  * @description Human-readable name for the resource. Between 1 and 256 characters.
@@ -5439,76 +5477,56 @@ export interface components {
5439
5477
  */
5440
5478
  metadata?: components['schemas']['Metadata'] | null;
5441
5479
  /**
5442
- * @deprecated
5443
- * @description Tax config specify the tax configuration for this line.
5444
- */
5445
- taxConfig?: components['schemas']['TaxConfig'];
5446
- /** @description Period of the line item applies to for revenue recognition pruposes.
5447
- *
5448
- * Billing always treats periods as start being inclusive and end being exclusive. */
5449
- period: components['schemas']['Period'];
5450
- /**
5480
+ * Creation Time
5451
5481
  * Format: date-time
5452
- * @description The time this line item should be invoiced.
5453
- * @example 2023-01-01T01:01:01.001Z
5454
- */
5455
- invoiceAt: Date;
5456
- /**
5457
- * @description Type of the line. (enum property replaced by openapi-typescript)
5458
- * @enum {string}
5459
- */
5460
- type: 'flat_fee';
5461
- /**
5462
- * @deprecated
5463
- * @description Price of the item being sold.
5464
- */
5465
- perUnitAmount?: components['schemas']['Numeric'];
5466
- /**
5467
- * @deprecated
5468
- * @description Payment term of the line.
5469
- * @default in_advance
5482
+ * @description Timestamp of when the resource was created.
5483
+ * @example 2024-01-01T01:01:01.001Z
5470
5484
  */
5471
- paymentTerm?: components['schemas']['PricePaymentTerm'];
5485
+ readonly createdAt: Date;
5472
5486
  /**
5473
- * @deprecated
5474
- * @description Quantity of the item being sold.
5487
+ * Last Update Time
5488
+ * Format: date-time
5489
+ * @description Timestamp of when the resource was last updated.
5490
+ * @example 2024-01-01T01:01:01.001Z
5475
5491
  */
5476
- quantity?: components['schemas']['Numeric'];
5477
- /** @description The rate card that is used for this line. */
5478
- rateCard?: components['schemas']['InvoiceFlatFeeRateCard'];
5492
+ readonly updatedAt: Date;
5479
5493
  /**
5480
- * @description Category of the flat fee.
5481
- * @default regular
5494
+ * Deletion Time
5495
+ * Format: date-time
5496
+ * @description Timestamp of when the resource was permanently deleted.
5497
+ * @example 2024-01-01T01:01:01.001Z
5482
5498
  */
5483
- category?: components['schemas']['InvoiceFlatFeeCategory'];
5499
+ readonly deletedAt?: Date;
5484
5500
  /**
5485
- * @description The ID of the line.
5501
+ * @description ID of the line.
5486
5502
  * @example 01G65Z755AFWAKHE12NY0CQ9FH
5487
5503
  */
5488
- id?: string;
5489
- };
5490
- /** @description InvoiceFlatFeePendingLineCreate represents the create model for an invoice line that is sold to the customer as a manually added fee. */
5491
- InvoiceFlatFeePendingLineCreate: {
5492
- /**
5493
- * Display name
5494
- * @description Human-readable name for the resource. Between 1 and 256 characters.
5495
- */
5496
- name: string;
5497
- /**
5498
- * Description
5499
- * @description Optional description of the resource. Maximum 1024 characters.
5500
- */
5501
- description?: string;
5502
- /**
5503
- * Metadata
5504
- * @description Additional metadata for the resource.
5505
- */
5506
- metadata?: components['schemas']['Metadata'] | null;
5504
+ id: string;
5505
+ /** @description managedBy specifies if the line is manually added via the api or managed by OpenMeter. */
5506
+ readonly managedBy: components['schemas']['InvoiceLineManagedBy'];
5507
+ /** @description Status of the line.
5508
+ *
5509
+ * External calls always create valid lines, other line types are managed by the
5510
+ * billing engine of OpenMeter. */
5511
+ readonly status: components['schemas']['InvoiceLineStatus'];
5512
+ /** @description Discounts detailes applied to this line.
5513
+ *
5514
+ * New discounts can be added via the invoice's discounts API, to facilitate
5515
+ * discounts that are affecting multiple lines. */
5516
+ readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
5517
+ /** @description The invoice this item belongs to. */
5518
+ invoice?: components['schemas']['InvoiceReference'];
5519
+ /** @description The currency of this line. */
5520
+ currency: components['schemas']['CurrencyCode'];
5521
+ /** @description Taxes applied to the invoice totals. */
5522
+ readonly taxes?: components['schemas']['InvoiceLineTaxItem'][];
5507
5523
  /**
5508
5524
  * @deprecated
5509
5525
  * @description Tax config specify the tax configuration for this line.
5510
5526
  */
5511
5527
  taxConfig?: components['schemas']['TaxConfig'];
5528
+ /** @description Totals for this line. */
5529
+ readonly totals: components['schemas']['InvoiceTotals'];
5512
5530
  /** @description Period of the line item applies to for revenue recognition pruposes.
5513
5531
  *
5514
5532
  * Billing always treats periods as start being inclusive and end being exclusive. */
@@ -5519,78 +5537,49 @@ export interface components {
5519
5537
  * @example 2023-01-01T01:01:01.001Z
5520
5538
  */
5521
5539
  invoiceAt: Date;
5522
- /**
5523
- * @description Type of the line. (enum property replaced by openapi-typescript)
5524
- * @enum {string}
5525
- */
5526
- type: 'flat_fee';
5540
+ /** @description External IDs of the invoice in other apps such as Stripe. */
5541
+ readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
5542
+ /** @description Subscription are the references to the subscritpions that this line is related to. */
5543
+ readonly subscription?: components['schemas']['InvoiceLineSubscriptionReference'];
5527
5544
  /**
5528
5545
  * @deprecated
5529
- * @description Price of the item being sold.
5546
+ * @description Type of the line.
5547
+ * @enum {string}
5530
5548
  */
5531
- perUnitAmount?: components['schemas']['Numeric'];
5549
+ readonly type: 'usage_based';
5532
5550
  /**
5533
5551
  * @deprecated
5534
- * @description Payment term of the line.
5535
- * @default in_advance
5552
+ * @description Price of the usage-based item being sold.
5536
5553
  */
5537
- paymentTerm?: components['schemas']['PricePaymentTerm'];
5554
+ price?: components['schemas']['RateCardUsageBasedPrice'];
5538
5555
  /**
5539
5556
  * @deprecated
5540
- * @description Quantity of the item being sold.
5541
- */
5542
- quantity?: components['schemas']['Numeric'];
5543
- /** @description The rate card that is used for this line. */
5544
- rateCard?: components['schemas']['InvoiceFlatFeeRateCard'];
5545
- /**
5546
- * @description Category of the flat fee.
5547
- * @default regular
5548
- */
5549
- category?: components['schemas']['InvoiceFlatFeeCategory'];
5550
- };
5551
- /** @description InvoiceFlatFeeRateCard represents the rate card (intent) for a flat fee line. */
5552
- InvoiceFlatFeeRateCard: {
5553
- /**
5554
- * Tax config
5555
- * @description The tax config of the rate card.
5556
- * When undefined, the tax config of the feature or the default tax config of the plan is used.
5557
- */
5558
- taxConfig?: components['schemas']['TaxConfig'];
5559
- /**
5560
- * Price
5561
- * @description The price of the rate card.
5562
- * When null, the feature or service is free.
5563
- * @example {
5564
- * "type": "flat",
5565
- * "amount": "100",
5566
- * "paymentTerm": "in_arrears"
5567
- * }
5557
+ * @description The feature that the usage is based on.
5568
5558
  */
5569
- price: components['schemas']['FlatPriceWithPaymentTerm'] | null;
5570
- /** @description Quantity of the item being sold.
5559
+ featureKey?: string;
5560
+ /** @description The lines detailing the item or service sold. */
5561
+ readonly children?: components['schemas']['InvoiceDetailedLine'][];
5562
+ /** @description The rate card that is used for this line.
5571
5563
  *
5572
- * Default: 1 */
5573
- quantity?: components['schemas']['Numeric'];
5574
- /** @description The discounts that are applied to the line. */
5575
- discounts?: components['schemas']['BillingDiscounts'];
5576
- };
5577
- /**
5578
- * InvoiceGenericDocumentRef is used to describe an existing document or a specific part of it's contents.
5579
- * @description Omitted fields:
5580
- * period: Tax period in which the referred document had an effect required by some tax regimes and formats.
5581
- * stamps: Seals of approval from other organisations that may need to be listed.
5582
- * ext: Extensions for additional codes that may be required.
5583
- */
5584
- InvoiceGenericDocumentRef: {
5585
- /** @description Type of the document referenced. */
5586
- readonly type: components['schemas']['InvoiceDocumentRefType'];
5587
- /** @description Human readable description on why this reference is here or needs to be used. */
5588
- readonly reason?: string;
5589
- /** @description Additional details about the document. */
5590
- readonly description?: string;
5564
+ * The rate card captures the intent of the price and discounts for the usage-based item. */
5565
+ rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
5566
+ /** @description The quantity of the item being sold.
5567
+ *
5568
+ * Any usage discounts applied previously are deducted from this quantity. */
5569
+ readonly quantity?: components['schemas']['Numeric'];
5570
+ /** @description The quantity of the item that has been metered for the period before any discounts were applied. */
5571
+ readonly meteredQuantity?: components['schemas']['Numeric'];
5572
+ /** @description The quantity of the item used before this line's period.
5573
+ *
5574
+ * It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
5575
+ *
5576
+ * Any usage discounts applied previously are deducted from this quantity. */
5577
+ readonly preLinePeriodQuantity?: components['schemas']['Numeric'];
5578
+ /** @description The metered quantity of the item used in before this line's period without any discounts applied.
5579
+ *
5580
+ * It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */
5581
+ readonly meteredPreLinePeriodQuantity?: components['schemas']['Numeric'];
5591
5582
  };
5592
- /** @description BillingInvoiceLine represents a line item that is sold to the customer based on a specific (unit) price. */
5593
- InvoiceLine: components['schemas']['InvoiceUsageBasedLine'] | components['schemas']['InvoiceFlatFeeLine'];
5594
5583
  /** @description InvoiceLineAmountDiscount represents an amount deducted from the line, and will be applied before taxes. */
5595
5584
  InvoiceLineAmountDiscount: {
5596
5585
  /**
@@ -5654,19 +5643,71 @@ export interface components {
5654
5643
  * @enum {string}
5655
5644
  */
5656
5645
  InvoiceLineManagedBy: 'subscription' | 'system' | 'manual';
5657
- /** @description InvoiceLineReplaceUpdate represents the update model for an invoice line. */
5658
- InvoiceLineReplaceUpdate: components['schemas']['InvoiceUsageBasedLineReplaceUpdate'] | components['schemas']['InvoiceFlatFeeLineReplaceUpdate'];
5659
- /**
5660
- * @description Line status specifies the status of the line.
5661
- * @enum {string}
5662
- */
5663
- InvoiceLineStatus: 'valid' | 'detail' | 'split';
5664
- /** @description InvoiceLineSubscriptionReference contains the references to the subscription that this line is related to. */
5665
- InvoiceLineSubscriptionReference: {
5666
- /** @description The subscription. */
5667
- readonly subscription: components['schemas']['IDResource'];
5668
- /** @description The phase of the subscription. */
5669
- readonly phase: components['schemas']['IDResource'];
5646
+ /** @description InvoiceLineReplaceUpdate represents the update model for an UBP invoice line.
5647
+ *
5648
+ * This type makes ID optional to allow for creating new lines as part of the update. */
5649
+ InvoiceLineReplaceUpdate: {
5650
+ /**
5651
+ * Display name
5652
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
5653
+ */
5654
+ name: string;
5655
+ /**
5656
+ * Description
5657
+ * @description Optional description of the resource. Maximum 1024 characters.
5658
+ */
5659
+ description?: string;
5660
+ /**
5661
+ * Metadata
5662
+ * @description Additional metadata for the resource.
5663
+ */
5664
+ metadata?: components['schemas']['Metadata'] | null;
5665
+ /**
5666
+ * @deprecated
5667
+ * @description Tax config specify the tax configuration for this line.
5668
+ */
5669
+ taxConfig?: components['schemas']['TaxConfig'];
5670
+ /** @description Period of the line item applies to for revenue recognition pruposes.
5671
+ *
5672
+ * Billing always treats periods as start being inclusive and end being exclusive. */
5673
+ period: components['schemas']['Period'];
5674
+ /**
5675
+ * Format: date-time
5676
+ * @description The time this line item should be invoiced.
5677
+ * @example 2023-01-01T01:01:01.001Z
5678
+ */
5679
+ invoiceAt: Date;
5680
+ /**
5681
+ * @deprecated
5682
+ * @description Price of the usage-based item being sold.
5683
+ */
5684
+ price?: components['schemas']['RateCardUsageBasedPrice'];
5685
+ /**
5686
+ * @deprecated
5687
+ * @description The feature that the usage is based on.
5688
+ */
5689
+ featureKey?: string;
5690
+ /** @description The rate card that is used for this line.
5691
+ *
5692
+ * The rate card captures the intent of the price and discounts for the usage-based item. */
5693
+ rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
5694
+ /**
5695
+ * @description The ID of the line.
5696
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
5697
+ */
5698
+ id?: string;
5699
+ };
5700
+ /**
5701
+ * @description Line status specifies the status of the line.
5702
+ * @enum {string}
5703
+ */
5704
+ InvoiceLineStatus: 'valid' | 'detail' | 'split';
5705
+ /** @description InvoiceLineSubscriptionReference contains the references to the subscription that this line is related to. */
5706
+ InvoiceLineSubscriptionReference: {
5707
+ /** @description The subscription. */
5708
+ readonly subscription: components['schemas']['IDResource'];
5709
+ /** @description The phase of the subscription. */
5710
+ readonly phase: components['schemas']['IDResource'];
5670
5711
  /** @description The item this line is related to. */
5671
5712
  readonly item: components['schemas']['IDResource'];
5672
5713
  };
@@ -5780,8 +5821,53 @@ export interface components {
5780
5821
  /** @description The terms of payment for the invoice. */
5781
5822
  terms?: components['schemas']['PaymentTerms'];
5782
5823
  };
5783
- /** @description InvoiceLineCreate represents the create model for an invoice line. */
5784
- InvoicePendingLineCreate: components['schemas']['InvoiceUsageBasedPendingLineCreate'] | components['schemas']['InvoiceFlatFeePendingLineCreate'];
5824
+ /** @description InvoicePendingLineCreate represents the create model for an invoice line that is sold to the customer based on usage. */
5825
+ InvoicePendingLineCreate: {
5826
+ /**
5827
+ * Display name
5828
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
5829
+ */
5830
+ name: string;
5831
+ /**
5832
+ * Description
5833
+ * @description Optional description of the resource. Maximum 1024 characters.
5834
+ */
5835
+ description?: string;
5836
+ /**
5837
+ * Metadata
5838
+ * @description Additional metadata for the resource.
5839
+ */
5840
+ metadata?: components['schemas']['Metadata'] | null;
5841
+ /**
5842
+ * @deprecated
5843
+ * @description Tax config specify the tax configuration for this line.
5844
+ */
5845
+ taxConfig?: components['schemas']['TaxConfig'];
5846
+ /** @description Period of the line item applies to for revenue recognition pruposes.
5847
+ *
5848
+ * Billing always treats periods as start being inclusive and end being exclusive. */
5849
+ period: components['schemas']['Period'];
5850
+ /**
5851
+ * Format: date-time
5852
+ * @description The time this line item should be invoiced.
5853
+ * @example 2023-01-01T01:01:01.001Z
5854
+ */
5855
+ invoiceAt: Date;
5856
+ /**
5857
+ * @deprecated
5858
+ * @description Price of the usage-based item being sold.
5859
+ */
5860
+ price?: components['schemas']['RateCardUsageBasedPrice'];
5861
+ /**
5862
+ * @deprecated
5863
+ * @description The feature that the usage is based on.
5864
+ */
5865
+ featureKey?: string;
5866
+ /** @description The rate card that is used for this line.
5867
+ *
5868
+ * The rate card captures the intent of the price and discounts for the usage-based item. */
5869
+ rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
5870
+ };
5785
5871
  /** @description InvoicePendingLineCreate represents the create model for a pending invoice line. */
5786
5872
  InvoicePendingLineCreateInput: {
5787
5873
  /** @description The currency of the lines to be created. */
@@ -5865,74 +5951,6 @@ export interface components {
5865
5951
  /** @description The workflow settings for the invoice. */
5866
5952
  workflow: components['schemas']['InvoiceWorkflowReplaceUpdate'];
5867
5953
  };
5868
- /** @description InvoiceSimulationFlatFeeLine represents a flat fee line item that can be input to the simulation endpoint. */
5869
- InvoiceSimulationFlatFeeLine: {
5870
- /**
5871
- * Display name
5872
- * @description Human-readable name for the resource. Between 1 and 256 characters.
5873
- */
5874
- name: string;
5875
- /**
5876
- * Description
5877
- * @description Optional description of the resource. Maximum 1024 characters.
5878
- */
5879
- description?: string;
5880
- /**
5881
- * Metadata
5882
- * @description Additional metadata for the resource.
5883
- */
5884
- metadata?: components['schemas']['Metadata'] | null;
5885
- /**
5886
- * @deprecated
5887
- * @description Tax config specify the tax configuration for this line.
5888
- */
5889
- taxConfig?: components['schemas']['TaxConfig'];
5890
- /** @description Period of the line item applies to for revenue recognition pruposes.
5891
- *
5892
- * Billing always treats periods as start being inclusive and end being exclusive. */
5893
- period: components['schemas']['Period'];
5894
- /**
5895
- * Format: date-time
5896
- * @description The time this line item should be invoiced.
5897
- * @example 2023-01-01T01:01:01.001Z
5898
- */
5899
- invoiceAt: Date;
5900
- /**
5901
- * @description Type of the line. (enum property replaced by openapi-typescript)
5902
- * @enum {string}
5903
- */
5904
- type: 'flat_fee';
5905
- /**
5906
- * @deprecated
5907
- * @description Price of the item being sold.
5908
- */
5909
- perUnitAmount?: components['schemas']['Numeric'];
5910
- /**
5911
- * @deprecated
5912
- * @description Payment term of the line.
5913
- * @default in_advance
5914
- */
5915
- paymentTerm?: components['schemas']['PricePaymentTerm'];
5916
- /**
5917
- * @deprecated
5918
- * @description Quantity of the item being sold.
5919
- */
5920
- quantity?: components['schemas']['Numeric'];
5921
- /** @description The rate card that is used for this line. */
5922
- rateCard?: components['schemas']['InvoiceFlatFeeRateCard'];
5923
- /**
5924
- * @description Category of the flat fee.
5925
- * @default regular
5926
- */
5927
- category?: components['schemas']['InvoiceFlatFeeCategory'];
5928
- /**
5929
- * @description ID of the line. If not specified it will be auto-generated.
5930
- *
5931
- * When discounts are specified, this must be provided, so that the discount can reference it.
5932
- * @example 01G65Z755AFWAKHE12NY0CQ9FH
5933
- */
5934
- id?: string;
5935
- };
5936
5954
  /** @description InvoiceSimulationInput is the input for simulating an invoice. */
5937
5955
  InvoiceSimulationInput: {
5938
5956
  /** @description The number of the invoice. */
@@ -5944,10 +5962,8 @@ export interface components {
5944
5962
  /** @description Lines to be included in the generated invoice. */
5945
5963
  lines: components['schemas']['InvoiceSimulationLine'][];
5946
5964
  };
5947
- /** @description InvoiceSimulationInput represents a line item that can be input to the simulation endpoint. */
5948
- InvoiceSimulationLine: components['schemas']['InvoiceSimulationUsageBasedLine'] | components['schemas']['InvoiceSimulationFlatFeeLine'];
5949
- /** @description InvoiceSimulationUsageBasedLine represents a usage-based line item that can be input to the simulation endpoint. */
5950
- InvoiceSimulationUsageBasedLine: {
5965
+ /** @description InvoiceSimulationLine represents a usage-based line item that can be input to the simulation endpoint. */
5966
+ InvoiceSimulationLine: {
5951
5967
  /**
5952
5968
  * Display name
5953
5969
  * @description Human-readable name for the resource. Between 1 and 256 characters.
@@ -5978,11 +5994,6 @@ export interface components {
5978
5994
  * @example 2023-01-01T01:01:01.001Z
5979
5995
  */
5980
5996
  invoiceAt: Date;
5981
- /**
5982
- * @description Type of the line. (enum property replaced by openapi-typescript)
5983
- * @enum {string}
5984
- */
5985
- type: 'usage_based';
5986
5997
  /**
5987
5998
  * @deprecated
5988
5999
  * @description Price of the usage-based item being sold.
@@ -6052,237 +6063,6 @@ export interface components {
6052
6063
  * @enum {string}
6053
6064
  */
6054
6065
  InvoiceType: 'standard' | 'credit_note';
6055
- /** @description InvoiceUsageBasedLine represents a line item that is sold to the customer based on usage. */
6056
- InvoiceUsageBasedLine: {
6057
- /**
6058
- * Display name
6059
- * @description Human-readable name for the resource. Between 1 and 256 characters.
6060
- */
6061
- name: string;
6062
- /**
6063
- * Description
6064
- * @description Optional description of the resource. Maximum 1024 characters.
6065
- */
6066
- description?: string;
6067
- /**
6068
- * Metadata
6069
- * @description Additional metadata for the resource.
6070
- */
6071
- metadata?: components['schemas']['Metadata'] | null;
6072
- /**
6073
- * Creation Time
6074
- * Format: date-time
6075
- * @description Timestamp of when the resource was created.
6076
- * @example 2024-01-01T01:01:01.001Z
6077
- */
6078
- readonly createdAt: Date;
6079
- /**
6080
- * Last Update Time
6081
- * Format: date-time
6082
- * @description Timestamp of when the resource was last updated.
6083
- * @example 2024-01-01T01:01:01.001Z
6084
- */
6085
- readonly updatedAt: Date;
6086
- /**
6087
- * Deletion Time
6088
- * Format: date-time
6089
- * @description Timestamp of when the resource was permanently deleted.
6090
- * @example 2024-01-01T01:01:01.001Z
6091
- */
6092
- readonly deletedAt?: Date;
6093
- /**
6094
- * @description ID of the line.
6095
- * @example 01G65Z755AFWAKHE12NY0CQ9FH
6096
- */
6097
- id: string;
6098
- /** @description managedBy specifies if the line is manually added via the api or managed by OpenMeter. */
6099
- readonly managedBy: components['schemas']['InvoiceLineManagedBy'];
6100
- /** @description Status of the line.
6101
- *
6102
- * External calls always create valid lines, other line types are managed by the
6103
- * billing engine of OpenMeter. */
6104
- readonly status: components['schemas']['InvoiceLineStatus'];
6105
- /** @description Discounts detailes applied to this line.
6106
- *
6107
- * New discounts can be added via the invoice's discounts API, to facilitate
6108
- * discounts that are affecting multiple lines. */
6109
- readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
6110
- /** @description The invoice this item belongs to. */
6111
- invoice?: components['schemas']['InvoiceReference'];
6112
- /** @description The currency of this line. */
6113
- currency: components['schemas']['CurrencyCode'];
6114
- /** @description Taxes applied to the invoice totals. */
6115
- readonly taxes?: components['schemas']['InvoiceLineTaxItem'][];
6116
- /**
6117
- * @deprecated
6118
- * @description Tax config specify the tax configuration for this line.
6119
- */
6120
- taxConfig?: components['schemas']['TaxConfig'];
6121
- /** @description The lines detailing the item or service sold. */
6122
- readonly children?: components['schemas']['InvoiceLine'][];
6123
- /** @description Totals for this line. */
6124
- readonly totals: components['schemas']['InvoiceTotals'];
6125
- /** @description Period of the line item applies to for revenue recognition pruposes.
6126
- *
6127
- * Billing always treats periods as start being inclusive and end being exclusive. */
6128
- period: components['schemas']['Period'];
6129
- /**
6130
- * Format: date-time
6131
- * @description The time this line item should be invoiced.
6132
- * @example 2023-01-01T01:01:01.001Z
6133
- */
6134
- invoiceAt: Date;
6135
- /** @description External IDs of the invoice in other apps such as Stripe. */
6136
- readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
6137
- /** @description Subscription are the references to the subscritpions that this line is related to. */
6138
- readonly subscription?: components['schemas']['InvoiceLineSubscriptionReference'];
6139
- /**
6140
- * @description Type of the line. (enum property replaced by openapi-typescript)
6141
- * @enum {string}
6142
- */
6143
- type: 'usage_based';
6144
- /**
6145
- * @deprecated
6146
- * @description Price of the usage-based item being sold.
6147
- */
6148
- price?: components['schemas']['RateCardUsageBasedPrice'];
6149
- /**
6150
- * @deprecated
6151
- * @description The feature that the usage is based on.
6152
- */
6153
- featureKey?: string;
6154
- /** @description The rate card that is used for this line.
6155
- *
6156
- * The rate card captures the intent of the price and discounts for the usage-based item. */
6157
- rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
6158
- /** @description The quantity of the item being sold.
6159
- *
6160
- * Any usage discounts applied previously are deducted from this quantity. */
6161
- readonly quantity?: components['schemas']['Numeric'];
6162
- /** @description The quantity of the item that has been metered for the period before any discounts were applied. */
6163
- readonly meteredQuantity?: components['schemas']['Numeric'];
6164
- /** @description The quantity of the item used before this line's period.
6165
- *
6166
- * It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
6167
- *
6168
- * Any usage discounts applied previously are deducted from this quantity. */
6169
- readonly preLinePeriodQuantity?: components['schemas']['Numeric'];
6170
- /** @description The metered quantity of the item used in before this line's period without any discounts applied.
6171
- *
6172
- * It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */
6173
- readonly meteredPreLinePeriodQuantity?: components['schemas']['Numeric'];
6174
- };
6175
- /** @description InvoiceUpdateUsageBasedLineReplaceUpdate represents the update model for an UBP invoice line.
6176
- *
6177
- * This type makes ID optional to allow for creating new lines as part of the update. */
6178
- InvoiceUsageBasedLineReplaceUpdate: {
6179
- /**
6180
- * Display name
6181
- * @description Human-readable name for the resource. Between 1 and 256 characters.
6182
- */
6183
- name: string;
6184
- /**
6185
- * Description
6186
- * @description Optional description of the resource. Maximum 1024 characters.
6187
- */
6188
- description?: string;
6189
- /**
6190
- * Metadata
6191
- * @description Additional metadata for the resource.
6192
- */
6193
- metadata?: components['schemas']['Metadata'] | null;
6194
- /**
6195
- * @deprecated
6196
- * @description Tax config specify the tax configuration for this line.
6197
- */
6198
- taxConfig?: components['schemas']['TaxConfig'];
6199
- /** @description Period of the line item applies to for revenue recognition pruposes.
6200
- *
6201
- * Billing always treats periods as start being inclusive and end being exclusive. */
6202
- period: components['schemas']['Period'];
6203
- /**
6204
- * Format: date-time
6205
- * @description The time this line item should be invoiced.
6206
- * @example 2023-01-01T01:01:01.001Z
6207
- */
6208
- invoiceAt: Date;
6209
- /**
6210
- * @description Type of the line. (enum property replaced by openapi-typescript)
6211
- * @enum {string}
6212
- */
6213
- type: 'usage_based';
6214
- /**
6215
- * @deprecated
6216
- * @description Price of the usage-based item being sold.
6217
- */
6218
- price?: components['schemas']['RateCardUsageBasedPrice'];
6219
- /**
6220
- * @deprecated
6221
- * @description The feature that the usage is based on.
6222
- */
6223
- featureKey?: string;
6224
- /** @description The rate card that is used for this line.
6225
- *
6226
- * The rate card captures the intent of the price and discounts for the usage-based item. */
6227
- rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
6228
- /**
6229
- * @description The ID of the line.
6230
- * @example 01G65Z755AFWAKHE12NY0CQ9FH
6231
- */
6232
- id?: string;
6233
- };
6234
- /** @description InvoiceUsageBasedLineCreateWithCustomer represents the create model for an invoice line that is sold to the customer based on usage. */
6235
- InvoiceUsageBasedPendingLineCreate: {
6236
- /**
6237
- * Display name
6238
- * @description Human-readable name for the resource. Between 1 and 256 characters.
6239
- */
6240
- name: string;
6241
- /**
6242
- * Description
6243
- * @description Optional description of the resource. Maximum 1024 characters.
6244
- */
6245
- description?: string;
6246
- /**
6247
- * Metadata
6248
- * @description Additional metadata for the resource.
6249
- */
6250
- metadata?: components['schemas']['Metadata'] | null;
6251
- /**
6252
- * @deprecated
6253
- * @description Tax config specify the tax configuration for this line.
6254
- */
6255
- taxConfig?: components['schemas']['TaxConfig'];
6256
- /** @description Period of the line item applies to for revenue recognition pruposes.
6257
- *
6258
- * Billing always treats periods as start being inclusive and end being exclusive. */
6259
- period: components['schemas']['Period'];
6260
- /**
6261
- * Format: date-time
6262
- * @description The time this line item should be invoiced.
6263
- * @example 2023-01-01T01:01:01.001Z
6264
- */
6265
- invoiceAt: Date;
6266
- /**
6267
- * @description Type of the line. (enum property replaced by openapi-typescript)
6268
- * @enum {string}
6269
- */
6270
- type: 'usage_based';
6271
- /**
6272
- * @deprecated
6273
- * @description Price of the usage-based item being sold.
6274
- */
6275
- price?: components['schemas']['RateCardUsageBasedPrice'];
6276
- /**
6277
- * @deprecated
6278
- * @description The feature that the usage is based on.
6279
- */
6280
- featureKey?: string;
6281
- /** @description The rate card that is used for this line.
6282
- *
6283
- * The rate card captures the intent of the price and discounts for the usage-based item. */
6284
- rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
6285
- };
6286
6066
  /** @description InvoiceUsageBasedRateCard represents the rate card (intent) for an usage-based line. */
6287
6067
  InvoiceUsageBasedRateCard: {
6288
6068
  /**
@@ -10344,14 +10124,12 @@ export type InvoiceAppExternalIds = components['schemas']['InvoiceAppExternalIds
10344
10124
  export type InvoiceAvailableActionDetails = components['schemas']['InvoiceAvailableActionDetails'];
10345
10125
  export type InvoiceAvailableActionInvoiceDetails = components['schemas']['InvoiceAvailableActionInvoiceDetails'];
10346
10126
  export type InvoiceAvailableActions = components['schemas']['InvoiceAvailableActions'];
10127
+ export type InvoiceDetailedLine = components['schemas']['InvoiceDetailedLine'];
10128
+ export type InvoiceDetailedLineCostCategory = components['schemas']['InvoiceDetailedLineCostCategory'];
10129
+ export type InvoiceDetailedLineRateCard = components['schemas']['InvoiceDetailedLineRateCard'];
10347
10130
  export type InvoiceDocumentRef = components['schemas']['InvoiceDocumentRef'];
10348
10131
  export type InvoiceDocumentRefType = components['schemas']['InvoiceDocumentRefType'];
10349
10132
  export type InvoiceExpand = components['schemas']['InvoiceExpand'];
10350
- export type InvoiceFlatFeeCategory = components['schemas']['InvoiceFlatFeeCategory'];
10351
- export type InvoiceFlatFeeLine = components['schemas']['InvoiceFlatFeeLine'];
10352
- export type InvoiceFlatFeeLineReplaceUpdate = components['schemas']['InvoiceFlatFeeLineReplaceUpdate'];
10353
- export type InvoiceFlatFeePendingLineCreate = components['schemas']['InvoiceFlatFeePendingLineCreate'];
10354
- export type InvoiceFlatFeeRateCard = components['schemas']['InvoiceFlatFeeRateCard'];
10355
10133
  export type InvoiceGenericDocumentRef = components['schemas']['InvoiceGenericDocumentRef'];
10356
10134
  export type InvoiceLine = components['schemas']['InvoiceLine'];
10357
10135
  export type InvoiceLineAmountDiscount = components['schemas']['InvoiceLineAmountDiscount'];
@@ -10375,17 +10153,12 @@ export type InvoicePendingLinesActionFiltersInput = components['schemas']['Invoi
10375
10153
  export type InvoicePendingLinesActionInput = components['schemas']['InvoicePendingLinesActionInput'];
10376
10154
  export type InvoiceReference = components['schemas']['InvoiceReference'];
10377
10155
  export type InvoiceReplaceUpdate = components['schemas']['InvoiceReplaceUpdate'];
10378
- export type InvoiceSimulationFlatFeeLine = components['schemas']['InvoiceSimulationFlatFeeLine'];
10379
10156
  export type InvoiceSimulationInput = components['schemas']['InvoiceSimulationInput'];
10380
10157
  export type InvoiceSimulationLine = components['schemas']['InvoiceSimulationLine'];
10381
- export type InvoiceSimulationUsageBasedLine = components['schemas']['InvoiceSimulationUsageBasedLine'];
10382
10158
  export type InvoiceStatus = components['schemas']['InvoiceStatus'];
10383
10159
  export type InvoiceStatusDetails = components['schemas']['InvoiceStatusDetails'];
10384
10160
  export type InvoiceTotals = components['schemas']['InvoiceTotals'];
10385
10161
  export type InvoiceType = components['schemas']['InvoiceType'];
10386
- export type InvoiceUsageBasedLine = components['schemas']['InvoiceUsageBasedLine'];
10387
- export type InvoiceUsageBasedLineReplaceUpdate = components['schemas']['InvoiceUsageBasedLineReplaceUpdate'];
10388
- export type InvoiceUsageBasedPendingLineCreate = components['schemas']['InvoiceUsageBasedPendingLineCreate'];
10389
10162
  export type InvoiceUsageBasedRateCard = components['schemas']['InvoiceUsageBasedRateCard'];
10390
10163
  export type InvoiceWorkflowInvoicingSettingsReplaceUpdate = components['schemas']['InvoiceWorkflowInvoicingSettingsReplaceUpdate'];
10391
10164
  export type InvoiceWorkflowReplaceUpdate = components['schemas']['InvoiceWorkflowReplaceUpdate'];