@flexprice/sdk 2.1.49-dev.26 → 2.1.49-dev.28

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.
Files changed (43) hide show
  1. package/docs/sdk/models/add-addon-request.md +13 -13
  2. package/docs/sdk/models/add-addon-to-subscription-request.md +11 -11
  3. package/docs/sdk/models/commitment-info.md +15 -12
  4. package/docs/sdk/models/create-subscription-line-item-request.md +6 -6
  5. package/docs/sdk/models/create-subscription-request.md +4 -4
  6. package/docs/sdk/models/grouped-invoicing-child-request.md +4 -4
  7. package/docs/sdk/models/update-subscription-line-item-request.md +20 -20
  8. package/docs/sdk/models/usage-analytic-point.md +3 -0
  9. package/esm/lib/config.d.ts +2 -2
  10. package/esm/lib/config.js +2 -2
  11. package/esm/sdk/models/add-addon-request.d.ts +1 -1
  12. package/esm/sdk/models/add-addon-to-subscription-request.d.ts +1 -1
  13. package/esm/sdk/models/commitment-info.d.ts +15 -0
  14. package/esm/sdk/models/commitment-info.d.ts.map +1 -1
  15. package/esm/sdk/models/commitment-info.js +12 -0
  16. package/esm/sdk/models/commitment-info.js.map +1 -1
  17. package/esm/sdk/models/create-subscription-line-item-request.d.ts +16 -1
  18. package/esm/sdk/models/create-subscription-line-item-request.d.ts.map +1 -1
  19. package/esm/sdk/models/create-subscription-line-item-request.js.map +1 -1
  20. package/esm/sdk/models/create-subscription-request.d.ts +10 -1
  21. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  22. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  23. package/esm/sdk/models/grouped-invoicing-child-request.d.ts +10 -1
  24. package/esm/sdk/models/grouped-invoicing-child-request.d.ts.map +1 -1
  25. package/esm/sdk/models/grouped-invoicing-child-request.js.map +1 -1
  26. package/esm/sdk/models/update-subscription-line-item-request.d.ts +17 -1
  27. package/esm/sdk/models/update-subscription-line-item-request.d.ts.map +1 -1
  28. package/esm/sdk/models/update-subscription-line-item-request.js.map +1 -1
  29. package/esm/sdk/models/usage-analytic-point.d.ts +6 -0
  30. package/esm/sdk/models/usage-analytic-point.d.ts.map +1 -1
  31. package/esm/sdk/models/usage-analytic-point.js +6 -0
  32. package/esm/sdk/models/usage-analytic-point.js.map +1 -1
  33. package/jsr.json +1 -1
  34. package/package.json +2 -2
  35. package/src/lib/config.ts +2 -2
  36. package/src/sdk/models/add-addon-request.ts +1 -1
  37. package/src/sdk/models/add-addon-to-subscription-request.ts +1 -1
  38. package/src/sdk/models/commitment-info.ts +29 -0
  39. package/src/sdk/models/create-subscription-line-item-request.ts +16 -1
  40. package/src/sdk/models/create-subscription-request.ts +10 -1
  41. package/src/sdk/models/grouped-invoicing-child-request.ts +10 -1
  42. package/src/sdk/models/update-subscription-line-item-request.ts +17 -1
  43. package/src/sdk/models/usage-analytic-point.ts +13 -0
package/docs/sdk/models/add-addon-request.md CHANGED
@@ -13,16 +13,16 @@ let value: AddAddonRequest = {
13
13
 
14
14
  ## Fields
15
15
 
16
- | Field | Type | Required | Description |
17
- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
18
- | `addonId` | *string* | :heavy_check_mark: | N/A |
19
- | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
20
- | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
21
- | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
22
- | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
23
- | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
24
- | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
25
- | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
26
- | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
27
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
28
- | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
16
+ | Field | Type | Required | Description |
17
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
18
+ | `addonId` | *string* | :heavy_check_mark: | N/A |
19
+ | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
20
+ | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
21
+ | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
22
+ | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
23
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
24
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
25
+ | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
26
+ | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
27
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
28
+ | `subscriptionId` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/add-addon-to-subscription-request.md CHANGED
@@ -12,14 +12,14 @@ let value: AddAddonToSubscriptionRequest = {
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
17
- | `addonId` | *string* | :heavy_check_mark: | N/A |
18
- | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
19
- | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
20
- | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
21
- | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
22
- | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
23
- | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
24
- | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
25
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
15
+ | Field | Type | Required | Description |
16
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
17
+ | `addonId` | *string* | :heavy_check_mark: | N/A |
18
+ | `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
19
+ | `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
20
+ | `coupons` | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[] | :heavy_minus_sign: | Coupons apply to this addon's line items; price_id targets one price, omitted targets all. |
21
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
22
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
23
+ | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices |
24
+ | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
25
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/commitment-info.md CHANGED
@@ -10,15 +10,18 @@ let value: CommitmentInfo = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | N/A |
16
- | `computedCommitmentUtilizedAmount` | *string* | :heavy_minus_sign: | N/A |
17
- | `computedOverageAmount` | *string* | :heavy_minus_sign: | N/A |
18
- | `computedTrueUpAmount` | *string* | :heavy_minus_sign: | total_cost = computed_commitment_utilized_amount + computed_overage_amount + computed_true_up_amount |
19
- | `duration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
20
- | `isWindowed` | *boolean* | :heavy_minus_sign: | N/A |
21
- | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
22
- | `quantity` | *string* | :heavy_minus_sign: | Only used for quantity-based commitments |
23
- | `trueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
24
- | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15
+ | `amount` | *string* | :heavy_minus_sign: | Amount is the commitment amount (v1), or computed_commitment_utilized_amount + computed_true_up_amount (v2). |
16
+ | `computedCommitmentUtilizedAmount` | *string* | :heavy_minus_sign: | N/A |
17
+ | `computedCommitmentUtilizedQuantity` | *string* | :heavy_minus_sign: | Usage units behind the computed amounts: usage a billing-terms commitment covers counts as utilized at no<br/>charge, and a quantity commitment's true-up counts its unused units. |
18
+ | `computedOverageAmount` | *string* | :heavy_minus_sign: | N/A |
19
+ | `computedOverageQuantity` | *string* | :heavy_minus_sign: | N/A |
20
+ | `computedTrueUpAmount` | *string* | :heavy_minus_sign: | total_cost = computed_commitment_utilized_amount + computed_overage_amount + computed_true_up_amount |
21
+ | `computedTrueUpQuantity` | *string* | :heavy_minus_sign: | N/A |
22
+ | `duration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
23
+ | `isWindowed` | *boolean* | :heavy_minus_sign: | N/A |
24
+ | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
25
+ | `quantity` | *string* | :heavy_minus_sign: | Only used for quantity-based commitments |
26
+ | `trueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
27
+ | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-subscription-line-item-request.md CHANGED
@@ -12,14 +12,14 @@ let value: CreateSubscriptionLineItemRequest = {};
12
12
 
13
13
  | Field | Type | Required | Description |
14
14
  | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
15
- | `commitmentAmount` | *number* | :heavy_minus_sign: | Commitment fields |
15
+ | `commitmentAmount` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
16
16
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
17
- | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | N/A |
18
- | `commitmentQuantity` | *number* | :heavy_minus_sign: | N/A |
19
- | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | N/A |
20
- | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
17
+ | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
18
+ | `commitmentQuantity` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
19
+ | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
20
+ | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
21
21
  | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
22
- | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | N/A |
22
+ | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
23
23
  | `displayName` | *string* | :heavy_minus_sign: | N/A |
24
24
  | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
25
25
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-subscription-request.md CHANGED
@@ -24,27 +24,27 @@ let value: CreateSubscriptionRequest = {
24
24
  | `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
25
25
  | `checkout` | [models.CheckoutParams](../../sdk/models/checkout-params.md) | :heavy_minus_sign: | N/A |
26
26
  | `collectionMethod` | [models.CollectionMethod](../../sdk/models/collection-method.md) | :heavy_minus_sign: | N/A |
27
- | `commitmentAmount` | *string* | :heavy_minus_sign: | N/A |
27
+ | `commitmentAmount` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
28
28
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
29
29
  | `commitments` | [models.CreateCommitmentRequest](../../sdk/models/create-commitment-request.md)[] | :heavy_minus_sign: | Commitments are created with the subscription. subscription_id, and entity_id on a subscription scope,<br/>are set server-side. |
30
30
  | `coupons` | *string*[] | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
31
31
  | `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | N/A |
32
32
  | `currency` | *string* | :heavy_check_mark: | N/A |
33
33
  | `customerId` | *string* | :heavy_minus_sign: | CustomerID takes priority over ExternalCustomerID when both are provided. |
34
- | `enableTrueUp` | *boolean* | :heavy_minus_sign: | N/A |
34
+ | `enableTrueUp` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
35
35
  | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
36
36
  | `externalCustomerId` | *string* | :heavy_minus_sign: | N/A |
37
37
  | `fxRates` | [models.InlineFXRate](../../sdk/models/inline-fx-rate.md)[] | :heavy_minus_sign: | FxRates sets subscription-scope rates to the invoicing customer's billing currency, one per<br/>non-overlapping window. Rejected when nothing needs converting or the pair has no tenant rate. |
38
38
  | `gatewayPaymentMethodId` | *string* | :heavy_minus_sign: | N/A |
39
39
  | `includePriceIds` | *string*[] | :heavy_minus_sign: | IncludePriceIDs selects which plan prices to attach. Nil/omitted attaches matching-cadence<br/>prices plus ONETIME; [] attaches none (LineItems extras still apply); a non-empty list<br/>attaches only those IDs. Each listed ID must belong to the plan, match the subscription<br/>currency, and have a cadence that equals or strictly divides the subscription cadence.<br/>Pointer-slice distinguishes nil from [].<br/>NOTE: no `dive,required` on this tag — swaggo misinterprets `required`<br/>inside `dive` as marking the whole field required, which then shows up<br/>in the OpenAPI schema and breaks callers that omit the field. Per-element<br/>non-emptiness is enforced explicitly in Validate() below. |
40
40
  | `inheritance` | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md) | :heavy_minus_sign: | N/A |
41
- | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments sets per-line-item commitment config, keyed by price_id. |
41
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
42
42
  | `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
43
43
  | `lineItemGrouping` | [models.LineItemGrouping](../../sdk/models/line-item-grouping.md) | :heavy_minus_sign: | N/A |
44
44
  | `lineItems` | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[] | :heavy_minus_sign: | LineItems are extra (non-plan) line items added at creation. |
45
45
  | `lookupKey` | *string* | :heavy_minus_sign: | N/A |
46
46
  | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
47
- | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
47
+ | `overageFactor` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
48
48
  | `overrideEntitlements` | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[] | :heavy_minus_sign: | N/A |
49
49
  | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems overrides specific plan prices for this subscription. |
50
50
  | `paymentBehavior` | [models.PaymentBehavior](../../sdk/models/payment-behavior.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/grouped-invoicing-child-request.md CHANGED
@@ -16,16 +16,16 @@ let value: GroupedInvoicingChildRequest = {
16
16
  | Field | Type | Required | Description |
17
17
  | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
18
18
  | `addons` | [models.AddAddonToSubscriptionRequest](../../sdk/models/add-addon-to-subscription-request.md)[] | :heavy_minus_sign: | N/A |
19
- | `commitmentAmount` | *string* | :heavy_minus_sign: | N/A |
19
+ | `commitmentAmount` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
20
20
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
21
21
  | `coupons` | *string*[] | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
22
22
  | `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | N/A |
23
- | `enableTrueUp` | *boolean* | :heavy_minus_sign: | N/A |
23
+ | `enableTrueUp` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
24
24
  | `externalCustomerId` | *string* | :heavy_check_mark: | N/A |
25
- | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments sets per-line-item commitment config, keyed by price_id. |
25
+ | `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
26
26
  | `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: | Deprecated: use SubscriptionCoupons instead. |
27
27
  | `lineItems` | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[] | :heavy_minus_sign: | LineItems are extra (non-plan) line items added at creation. |
28
- | `overageFactor` | *string* | :heavy_minus_sign: | N/A |
28
+ | `overageFactor` | *string* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
29
29
  | `overrideEntitlements` | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[] | :heavy_minus_sign: | N/A |
30
30
  | `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems overrides specific plan prices for this subscription. |
31
31
  | `phases` | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/update-subscription-line-item-request.md CHANGED
@@ -10,23 +10,23 @@ let value: UpdateSubscriptionLineItemRequest = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
- | `amount` | *string* | :heavy_minus_sign: | Amount is the new price amount that overrides the original price |
16
- | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
17
- | `bucketSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
18
- | `commitmentAmount` | *number* | :heavy_minus_sign: | Commitment fields |
19
- | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
20
- | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | N/A |
21
- | `commitmentQuantity` | *number* | :heavy_minus_sign: | N/A |
22
- | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | Pointer so an explicit empty array can clear existing buckets (omission keeps them). |
23
- | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | N/A |
24
- | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
25
- | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | N/A |
26
- | `effectiveFrom` | *string* | :heavy_minus_sign: | EffectiveFrom for the existing line item (if not provided, defaults to now) |
27
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | Metadata for the new line item |
28
- | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount for a CUSTOM price unit price (FLAT_FEE/PACKAGE billing models) |
29
- | `priceUnitTiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for a CUSTOM price unit price (TIERED billing model) |
30
- | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
31
- | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | Tiers determines the pricing tiers for this line item |
32
- | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `amount` | *string* | :heavy_minus_sign: | Amount is the new price amount that overrides the original price |
16
+ | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
17
+ | `bucketSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A |
18
+ | `commitmentAmount` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
19
+ | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
20
+ | `commitmentOverageFactor` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
21
+ | `commitmentQuantity` | *number* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
22
+ | `commitmentTimeBuckets` | [models.CommitmentBucketRequest](../../sdk/models/commitment-bucket-request.md)[] | :heavy_minus_sign: | Pointer so an explicit empty array can clear existing buckets (omission keeps them).<br/><br/>Deprecated: use POST /commitments instead. |
23
+ | `commitmentTrueUpEnabled` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
24
+ | `commitmentType` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_minus_sign: | N/A |
25
+ | `commitmentWindowed` | *boolean* | :heavy_minus_sign: | Deprecated: use POST /commitments instead. |
26
+ | `effectiveFrom` | *string* | :heavy_minus_sign: | EffectiveFrom for the existing line item (if not provided, defaults to now) |
27
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | Metadata for the new line item |
28
+ | `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount for a CUSTOM price unit price (FLAT_FEE/PACKAGE billing models) |
29
+ | `priceUnitTiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for a CUSTOM price unit price (TIERED billing model) |
30
+ | `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
31
+ | `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | Tiers determines the pricing tiers for this line item |
32
+ | `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |