@flexprice/sdk 2.1.48-dev.4 → 2.1.48-dev.6

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 (74) hide show
  1. package/docs/sdk/models/billing-term-input.md +15 -14
  2. package/docs/sdk/models/billingterm-term.md +25 -24
  3. package/docs/sdk/models/create-commitment-request.md +1 -1
  4. package/docs/sdk/models/get-subscription-v2-request.md +4 -4
  5. package/docs/sdk/models/invoice-billing-reason.md +1 -1
  6. package/docs/sdk/models/subscription-response-v2.md +1 -0
  7. package/docs/sdk/models/subscription-response.md +1 -0
  8. package/docs/sdk/models/terminate-commitment-request.md +4 -4
  9. package/docs/sdk/models/trigger-instalment-request.md +3 -3
  10. package/docs/sdk/models/update-commitment-request.md +7 -6
  11. package/docs/sdks/commitments/README.md +1 -1
  12. package/docs/sdks/subscriptions/README.md +1 -1
  13. package/docs/sdks/webhookevents/README.md +3 -3
  14. package/esm/funcs/commitments-trigger-commitment-instalment.d.ts +1 -1
  15. package/esm/funcs/commitments-trigger-commitment-instalment.js +1 -1
  16. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.d.ts +1 -1
  17. package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.js +1 -1
  18. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.d.ts +1 -1
  19. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.js +1 -1
  20. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.d.ts +1 -1
  21. package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.js +1 -1
  22. package/esm/lib/config.d.ts +2 -2
  23. package/esm/lib/config.js +2 -2
  24. package/esm/sdk/commitments.d.ts +1 -1
  25. package/esm/sdk/commitments.js +1 -1
  26. package/esm/sdk/models/billing-term-input.d.ts +11 -5
  27. package/esm/sdk/models/billing-term-input.d.ts.map +1 -1
  28. package/esm/sdk/models/billing-term-input.js +3 -0
  29. package/esm/sdk/models/billing-term-input.js.map +1 -1
  30. package/esm/sdk/models/billingterm-term.d.ts +3 -1
  31. package/esm/sdk/models/billingterm-term.d.ts.map +1 -1
  32. package/esm/sdk/models/billingterm-term.js +3 -0
  33. package/esm/sdk/models/billingterm-term.js.map +1 -1
  34. package/esm/sdk/models/create-commitment-request.d.ts +1 -1
  35. package/esm/sdk/models/get-subscription-v2-op.d.ts +1 -1
  36. package/esm/sdk/models/invoice-billing-reason.d.ts +1 -0
  37. package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
  38. package/esm/sdk/models/invoice-billing-reason.js +1 -0
  39. package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
  40. package/esm/sdk/models/subscription-response-v2.d.ts +5 -0
  41. package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
  42. package/esm/sdk/models/subscription-response-v2.js +2 -0
  43. package/esm/sdk/models/subscription-response-v2.js.map +1 -1
  44. package/esm/sdk/models/subscription-response.d.ts +5 -0
  45. package/esm/sdk/models/subscription-response.d.ts.map +1 -1
  46. package/esm/sdk/models/subscription-response.js +2 -0
  47. package/esm/sdk/models/subscription-response.js.map +1 -1
  48. package/esm/sdk/models/terminate-commitment-request.d.ts +1 -1
  49. package/esm/sdk/models/trigger-instalment-request.d.ts +1 -1
  50. package/esm/sdk/models/update-commitment-request.d.ts +5 -0
  51. package/esm/sdk/models/update-commitment-request.d.ts.map +1 -1
  52. package/esm/sdk/models/update-commitment-request.js +2 -0
  53. package/esm/sdk/models/update-commitment-request.js.map +1 -1
  54. package/esm/sdk/webhook-events.d.ts +3 -3
  55. package/esm/sdk/webhook-events.js +3 -3
  56. package/jsr.json +1 -1
  57. package/package.json +2 -2
  58. package/src/funcs/commitments-trigger-commitment-instalment.ts +1 -1
  59. package/src/funcs/webhook-events-post-webhook-events-billing-instalment-created.ts +1 -1
  60. package/src/funcs/webhook-events-post-webhook-events-billing-terms-created.ts +1 -1
  61. package/src/funcs/webhook-events-post-webhook-events-billing-terms-updated.ts +1 -1
  62. package/src/lib/config.ts +2 -2
  63. package/src/sdk/commitments.ts +1 -1
  64. package/src/sdk/models/billing-term-input.ts +16 -5
  65. package/src/sdk/models/billingterm-term.ts +8 -1
  66. package/src/sdk/models/create-commitment-request.ts +1 -1
  67. package/src/sdk/models/get-subscription-v2-op.ts +1 -1
  68. package/src/sdk/models/invoice-billing-reason.ts +1 -0
  69. package/src/sdk/models/subscription-response-v2.ts +9 -0
  70. package/src/sdk/models/subscription-response.ts +9 -0
  71. package/src/sdk/models/terminate-commitment-request.ts +1 -1
  72. package/src/sdk/models/trigger-instalment-request.ts +1 -1
  73. package/src/sdk/models/update-commitment-request.ts +7 -0
  74. package/src/sdk/webhook-events.ts +3 -3
package/docs/sdk/models/billing-term-input.md CHANGED
@@ -13,17 +13,18 @@ let value: BillingTermInput = {
13
13
 
14
14
  ## Fields
15
15
 
16
- | Field | Type | Required | Description |
17
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
- | `billOn` | *string* | :heavy_minus_sign: | BillOn is a whole second, the commitment start by default. On an edit it defaults to the start of the billing<br/>period holding now, or to the commitment start once the term has ended. |
19
- | `billTrigger` | [models.InstalmentBillTrigger](../../sdk/models/instalment-bill-trigger.md) | :heavy_minus_sign: | N/A |
20
- | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
21
- | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
22
- | `invoiceLabel` | *string* | :heavy_minus_sign: | InvoiceLabel names the term's instalments on the invoice, "Instalment {n} of {of}" by default. {n} and {of} are<br/>filled with each instalment's place among all of the commitment's instalments and their count. |
23
- | `kind` | [models.BillingTermKind](../../sdk/models/billing-term-kind.md) | :heavy_check_mark: | N/A |
24
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
25
- | `periodCount` | *number* | :heavy_minus_sign: | N/A |
26
- | `split` | [models.BillingTermSplit](../../sdk/models/billing-term-split.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: | StartDate defaults like BillOn; EndDate defaults to the commitment end. Both are whole seconds. |
28
- | `value` | *string* | :heavy_minus_sign: | N/A |
29
- | `valueType` | [models.BillingTermValueType](../../sdk/models/billing-term-value-type.md) | :heavy_check_mark: | fixed or remainder; percentage is reserved and rejected as not supported yet |
16
+ | Field | Type | Required | Description |
17
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18
+ | `billOn` | *string* | :heavy_minus_sign: | BillOn defaults to the commitment start, or on an edit to the start of the billing period holding now (the<br/>commitment start once its term has ended). A manual term omits it and waits at the commitment end. |
19
+ | `billTrigger` | [models.InstalmentBillTrigger](../../sdk/models/instalment-bill-trigger.md) | :heavy_minus_sign: | N/A |
20
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
21
+ | `instalmentInvoicing` | [models.InstalmentDelivery](../../sdk/models/instalment-delivery.md) | :heavy_minus_sign: | N/A |
22
+ | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
23
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | InvoiceLabel names the term's instalments, "Instalment {n} of {of}" by default. {n} and {of} count only the<br/>commitment's instalments whose labels use them. |
24
+ | `kind` | [models.BillingTermKind](../../sdk/models/billing-term-kind.md) | :heavy_check_mark: | N/A |
25
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
26
+ | `periodCount` | *number* | :heavy_minus_sign: | N/A |
27
+ | `split` | [models.BillingTermSplit](../../sdk/models/billing-term-split.md) | :heavy_minus_sign: | N/A |
28
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate and EndDate are edges of the periods the term steps on: billing periods, or anniversary ones when it is<br/>invoiced separately; by default, the period holding the commitment start (now, on an edit) to the commitment end. |
29
+ | `value` | *string* | :heavy_minus_sign: | N/A |
30
+ | `valueType` | [models.BillingTermValueType](../../sdk/models/billing-term-value-type.md) | :heavy_check_mark: | fixed or remainder; percentage is reserved and rejected as not supported yet |
package/docs/sdk/models/billingterm-term.md CHANGED
@@ -10,27 +10,28 @@ let value: BillingtermTerm = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
- | `billOn` | *string* | :heavy_minus_sign: | N/A |
16
- | `billTrigger` | [models.InstalmentBillTrigger](../../sdk/models/instalment-bill-trigger.md) | :heavy_minus_sign: | N/A |
17
- | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
- | `createdBy` | *string* | :heavy_minus_sign: | N/A |
19
- | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
20
- | `environmentId` | *string* | :heavy_minus_sign: | N/A |
21
- | `id` | *string* | :heavy_minus_sign: | N/A |
22
- | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
23
- | `invoiceLabel` | *string* | :heavy_minus_sign: | InvoiceLabel names its instalments on the invoice, after the owner's label. It may use {n} and {of}, which number<br/>all of the owner's instalments together. |
24
- | `kind` | [models.BillingTermKind](../../sdk/models/billing-term-kind.md) | :heavy_minus_sign: | N/A |
25
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
26
- | `ownerId` | *string* | :heavy_minus_sign: | N/A |
27
- | `ownerType` | [models.BillingTermOwnerType](../../sdk/models/billing-term-owner-type.md) | :heavy_minus_sign: | N/A |
28
- | `periodCount` | *number* | :heavy_minus_sign: | N/A |
29
- | `split` | [models.BillingTermSplit](../../sdk/models/billing-term-split.md) | :heavy_minus_sign: | N/A |
30
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Recurring terms. |
31
- | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
32
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
33
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
34
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
35
- | `value` | *string* | :heavy_minus_sign: | Value is the amount of a fixed term, per instalment on a recurring one; it is nil for a remainder term. |
36
- | `valueType` | [models.BillingTermValueType](../../sdk/models/billing-term-value-type.md) | :heavy_minus_sign: | fixed or remainder; percentage is reserved and rejected as not supported yet |
13
+ | Field | Type | Required | Description |
14
+ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
+ | `billOn` | *string* | :heavy_minus_sign: | N/A |
16
+ | `billTrigger` | [models.InstalmentBillTrigger](../../sdk/models/instalment-bill-trigger.md) | :heavy_minus_sign: | N/A |
17
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
18
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
19
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
20
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
21
+ | `id` | *string* | :heavy_minus_sign: | N/A |
22
+ | `instalmentInvoicing` | [models.InstalmentDelivery](../../sdk/models/instalment-delivery.md) | :heavy_minus_sign: | N/A |
23
+ | `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
24
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | InvoiceLabel names its instalments on the invoice, after the owner's label. It may use {n} and {of}, which number<br/>the owner's instalments whose labels use them. |
25
+ | `kind` | [models.BillingTermKind](../../sdk/models/billing-term-kind.md) | :heavy_minus_sign: | N/A |
26
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
27
+ | `ownerId` | *string* | :heavy_minus_sign: | N/A |
28
+ | `ownerType` | [models.BillingTermOwnerType](../../sdk/models/billing-term-owner-type.md) | :heavy_minus_sign: | N/A |
29
+ | `periodCount` | *number* | :heavy_minus_sign: | N/A |
30
+ | `split` | [models.BillingTermSplit](../../sdk/models/billing-term-split.md) | :heavy_minus_sign: | N/A |
31
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Recurring terms. |
32
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
33
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
34
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
35
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
36
+ | `value` | *string* | :heavy_minus_sign: | Value is the amount of a fixed term, per instalment on a recurring one; it is nil for a remainder term. |
37
+ | `valueType` | [models.BillingTermValueType](../../sdk/models/billing-term-value-type.md) | :heavy_minus_sign: | fixed or remainder; percentage is reserved and rejected as not supported yet |
package/docs/sdk/models/create-commitment-request.md CHANGED
@@ -36,7 +36,7 @@ let value: CreateCommitmentRequest = {
36
36
  | `overagePrice` | [models.CommitmentPriceInput](../../sdk/models/commitment-price-input.md) | :heavy_minus_sign: | N/A |
37
37
  | `priority` | *number* | :heavy_minus_sign: | N/A |
38
38
  | `scope` | [models.CommitmentScopeInput](../../sdk/models/commitment-scope-input.md) | :heavy_check_mark: | N/A |
39
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | StartDate and EndDate must be whole seconds. |
39
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | StartDate and EndDate within a second after a billing period edge are taken as that edge. |
40
40
  | `subscriptionId` | *string* | :heavy_minus_sign: | SubscriptionID is required on POST /commitments and set server-side on inline commitments. |
41
41
  | `timezone` | *string* | :heavy_minus_sign: | N/A |
42
42
  | `type` | [models.CommitmentType](../../sdk/models/commitment-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/get-subscription-v2-request.md CHANGED
@@ -12,7 +12,7 @@ let value: GetSubscriptionV2Request = {
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
17
- | `id` | *string* | :heavy_check_mark: | Subscription ID |
18
- | `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan') |
15
+ | Field | Type | Required | Description |
16
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
17
+ | `id` | *string* | :heavy_check_mark: | Subscription ID |
18
+ | `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan,commitments') |
package/docs/sdk/models/invoice-billing-reason.md CHANGED
@@ -11,5 +11,5 @@ let value: InvoiceBillingReason = "SUBSCRIPTION_TRIAL_END";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP" | "SUBSCRIPTION_PAUSED" | "SUBSCRIPTION_RESUME" | "BILLING_TERMS"
14
+ "SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP" | "SUBSCRIPTION_PAUSED" | "SUBSCRIPTION_RESUME" | "BILLING_TERMS" | "COMMITMENT_TERMINATION"
15
15
  ```
package/docs/sdk/models/subscription-response-v2.md CHANGED
@@ -95,6 +95,7 @@ let value: SubscriptionResponseV2 = {
95
95
  | `collectionMethod` | *string* | :heavy_minus_sign: | CollectionMethod determines how invoices are collected |
96
96
  | `commitmentAmount` | *string* | :heavy_minus_sign: | CommitmentAmount is the minimum amount a customer commits to paying for a billing period |
97
97
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
98
+ | `commitments` | [models.CommitmentResponse](../../sdk/models/commitment-response.md)[] | :heavy_minus_sign: | Commitments are included when "commitments" is in expand parameter |
98
99
  | `couponAssociations` | [models.CouponAssociationResponse](../../sdk/models/coupon-association-response.md)[] | :heavy_minus_sign: | CouponAssociations are included when "coupon_associations" is in expand parameter |
99
100
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
100
101
  | `createdBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-response.md CHANGED
@@ -133,6 +133,7 @@ let value: SubscriptionResponse = {
133
133
  | `collectionMethod` | *string* | :heavy_minus_sign: | CollectionMethod determines how invoices are collected |
134
134
  | `commitmentAmount` | *string* | :heavy_minus_sign: | CommitmentAmount is the minimum amount a customer commits to paying for a billing period |
135
135
  | `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
136
+ | `commitments` | [models.CommitmentResponse](../../sdk/models/commitment-response.md)[] | :heavy_minus_sign: | Commitments are the commitments created with the subscription; set on create only. |
136
137
  | `couponAssociations` | [models.CouponAssociationResponse](../../sdk/models/coupon-association-response.md)[] | :heavy_minus_sign: | CouponAssociations are the coupon associations for this subscription |
137
138
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
138
139
  | `createdBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/terminate-commitment-request.md CHANGED
@@ -10,7 +10,7 @@ let value: TerminateCommitmentRequest = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
- | `cancellationFee` | [models.CancellationFeeInput](../../sdk/models/cancellation-fee-input.md) | :heavy_minus_sign: | N/A |
16
- | `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EffectiveAt defaults to now; a given one must be a whole second. |
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
15
+ | `cancellationFee` | [models.CancellationFeeInput](../../sdk/models/cancellation-fee-input.md) | :heavy_minus_sign: | N/A |
16
+ | `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EffectiveAt defaults to now; within a second after a billing period edge it is taken as that edge. |
package/docs/sdk/models/trigger-instalment-request.md CHANGED
@@ -10,6 +10,6 @@ let value: TriggerInstalmentRequest = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
15
- | `billOn` | *string* | :heavy_minus_sign: | BillOn must be a whole second. |
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
15
+ | `billOn` | *string* | :heavy_minus_sign: | BillOn within a second after a billing period edge is taken as that edge. |
package/docs/sdk/models/update-commitment-request.md CHANGED
@@ -10,9 +10,10 @@ let value: UpdateCommitmentRequest = {};
10
10
 
11
11
  ## Fields
12
12
 
13
- | Field | Type | Required | Description |
14
- | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
15
- | `invoiceDescription` | *string* | :heavy_minus_sign: | N/A |
16
- | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
17
- | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
18
- | `name` | *string* | :heavy_minus_sign: | N/A |
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate can't be changed yet; terminate the commitment to end it. |
16
+ | `invoiceDescription` | *string* | :heavy_minus_sign: | N/A |
17
+ | `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
18
+ | `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
19
+ | `name` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdks/commitments/README.md CHANGED
@@ -711,7 +711,7 @@ run();
711
711
 
712
712
  ## triggerCommitmentInstalment
713
713
 
714
- Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when the commitment's instalment_invoicing is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
714
+ Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
715
715
 
716
716
  ### Example Usage
717
717
 
package/docs/sdks/subscriptions/README.md CHANGED
@@ -2253,7 +2253,7 @@ run();
2253
2253
  | Parameter | Type | Required | Description |
2254
2254
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2255
2255
  | `id` | *string* | :heavy_check_mark: | Subscription ID |
2256
- | `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan') |
2256
+ | `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan,commitments') |
2257
2257
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2258
2258
  | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
2259
2259
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
package/docs/sdks/webhookevents/README.md CHANGED
@@ -147,7 +147,7 @@ run();
147
147
 
148
148
  ## postWebhookEventsBillingInstalmentCreated
149
149
 
150
- Fired when a billing instalment is added to a commitment. Doc-only for parsing.
150
+ Fired when a billing instalment is scheduled for an entity (like a commitment). Doc-only for parsing.
151
151
 
152
152
  ### Example Usage
153
153
 
@@ -351,7 +351,7 @@ run();
351
351
 
352
352
  ## postWebhookEventsBillingTermsCreated
353
353
 
354
- Fired when billing terms are saved with a new commitment. Doc-only for parsing.
354
+ Fired when billing terms are saved against an entity (like a commitment). Doc-only for parsing.
355
355
 
356
356
  ### Example Usage
357
357
 
@@ -419,7 +419,7 @@ run();
419
419
 
420
420
  ## postWebhookEventsBillingTermsUpdated
421
421
 
422
- Fired when an edit replaces a commitment's billing terms. Doc-only for parsing.
422
+ Fired when an entity's (like a commitment's) billing terms are replaced. Doc-only for parsing.
423
423
 
424
424
  ### Example Usage
425
425
 
package/esm/funcs/commitments-trigger-commitment-instalment.d.ts CHANGED
@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
11
11
  * Trigger instalment
12
12
  *
13
13
  * @remarks
14
- * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when the commitment's instalment_invoicing is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
14
+ * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
15
15
  */
16
16
  export declare function commitmentsTriggerCommitmentInstalment(client: FlexpriceCore, id: string, instalmentId: string, body?: models.TriggerInstalmentRequest | undefined, options?: RequestOptions): APIPromise<Result<models.BillingtermInstalment, models.ErrorsErrorResponse | FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
17
17
  //# sourceMappingURL=commitments-trigger-commitment-instalment.d.ts.map
package/esm/funcs/commitments-trigger-commitment-instalment.js CHANGED
@@ -15,7 +15,7 @@ import { APIPromise } from "../types/async.js";
15
15
  * Trigger instalment
16
16
  *
17
17
  * @remarks
18
- * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when the commitment's instalment_invoicing is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
18
+ * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
19
19
  */
20
20
  export function commitmentsTriggerCommitmentInstalment(client, id, instalmentId, body, options) {
21
21
  return new APIPromise($do(client, id, instalmentId, body, options));
package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.d.ts CHANGED
@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
11
11
  * billing_instalment.created
12
12
  *
13
13
  * @remarks
14
- * Fired when a billing instalment is added to a commitment. Doc-only for parsing.
14
+ * Fired when a billing instalment is scheduled for an entity (like a commitment). Doc-only for parsing.
15
15
  */
16
16
  export declare function webhookEventsPostWebhookEventsBillingInstalmentCreated(client: FlexpriceCore, options?: RequestOptions): APIPromise<Result<models.WebhookDtoBillingInstalmentWebhookPayload, FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
17
17
  //# sourceMappingURL=webhook-events-post-webhook-events-billing-instalment-created.d.ts.map
package/esm/funcs/webhook-events-post-webhook-events-billing-instalment-created.js CHANGED
@@ -12,7 +12,7 @@ import { APIPromise } from "../types/async.js";
12
12
  * billing_instalment.created
13
13
  *
14
14
  * @remarks
15
- * Fired when a billing instalment is added to a commitment. Doc-only for parsing.
15
+ * Fired when a billing instalment is scheduled for an entity (like a commitment). Doc-only for parsing.
16
16
  */
17
17
  export function webhookEventsPostWebhookEventsBillingInstalmentCreated(client, options) {
18
18
  return new APIPromise($do(client, options));
package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.d.ts CHANGED
@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
11
11
  * billing_terms.created
12
12
  *
13
13
  * @remarks
14
- * Fired when billing terms are saved with a new commitment. Doc-only for parsing.
14
+ * Fired when billing terms are saved against an entity (like a commitment). Doc-only for parsing.
15
15
  */
16
16
  export declare function webhookEventsPostWebhookEventsBillingTermsCreated(client: FlexpriceCore, options?: RequestOptions): APIPromise<Result<models.WebhookDtoBillingTermsWebhookPayload, FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
17
17
  //# sourceMappingURL=webhook-events-post-webhook-events-billing-terms-created.d.ts.map
package/esm/funcs/webhook-events-post-webhook-events-billing-terms-created.js CHANGED
@@ -12,7 +12,7 @@ import { APIPromise } from "../types/async.js";
12
12
  * billing_terms.created
13
13
  *
14
14
  * @remarks
15
- * Fired when billing terms are saved with a new commitment. Doc-only for parsing.
15
+ * Fired when billing terms are saved against an entity (like a commitment). Doc-only for parsing.
16
16
  */
17
17
  export function webhookEventsPostWebhookEventsBillingTermsCreated(client, options) {
18
18
  return new APIPromise($do(client, options));
package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.d.ts CHANGED
@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
11
11
  * billing_terms.updated
12
12
  *
13
13
  * @remarks
14
- * Fired when an edit replaces a commitment's billing terms. Doc-only for parsing.
14
+ * Fired when an entity's (like a commitment's) billing terms are replaced. Doc-only for parsing.
15
15
  */
16
16
  export declare function webhookEventsPostWebhookEventsBillingTermsUpdated(client: FlexpriceCore, options?: RequestOptions): APIPromise<Result<models.WebhookDtoBillingTermsWebhookPayload, FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
17
17
  //# sourceMappingURL=webhook-events-post-webhook-events-billing-terms-updated.d.ts.map
package/esm/funcs/webhook-events-post-webhook-events-billing-terms-updated.js CHANGED
@@ -12,7 +12,7 @@ import { APIPromise } from "../types/async.js";
12
12
  * billing_terms.updated
13
13
  *
14
14
  * @remarks
15
- * Fired when an edit replaces a commitment's billing terms. Doc-only for parsing.
15
+ * Fired when an entity's (like a commitment's) billing terms are replaced. Doc-only for parsing.
16
16
  */
17
17
  export function webhookEventsPostWebhookEventsBillingTermsUpdated(client, options) {
18
18
  return new APIPromise($do(client, options));
package/esm/lib/config.d.ts CHANGED
@@ -35,8 +35,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
35
35
  export declare const SDK_METADATA: {
36
36
  readonly language: "typescript";
37
37
  readonly openapiDocVersion: "1.0";
38
- readonly sdkVersion: "2.1.48-dev.4";
38
+ readonly sdkVersion: "2.1.48-dev.6";
39
39
  readonly genVersion: "2.956.1";
40
- readonly userAgent: "speakeasy-sdk/typescript 2.1.48-dev.4 2.956.1 1.0 @flexprice/sdk";
40
+ readonly userAgent: "speakeasy-sdk/typescript 2.1.48-dev.6 2.956.1 1.0 @flexprice/sdk";
41
41
  };
42
42
  //# sourceMappingURL=config.d.ts.map
package/esm/lib/config.js CHANGED
@@ -39,8 +39,8 @@ export function serverURLFromOptions(options) {
39
39
  export const SDK_METADATA = {
40
40
  language: "typescript",
41
41
  openapiDocVersion: "1.0",
42
- sdkVersion: "2.1.48-dev.4",
42
+ sdkVersion: "2.1.48-dev.6",
43
43
  genVersion: "2.956.1",
44
- userAgent: "speakeasy-sdk/typescript 2.1.48-dev.4 2.956.1 1.0 @flexprice/sdk",
44
+ userAgent: "speakeasy-sdk/typescript 2.1.48-dev.6 2.956.1 1.0 @flexprice/sdk",
45
45
  };
46
46
  //# sourceMappingURL=config.js.map
package/esm/sdk/commitments.d.ts CHANGED
@@ -68,7 +68,7 @@ export declare class Commitments extends ClientSDK {
68
68
  * Trigger instalment
69
69
  *
70
70
  * @remarks
71
- * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when the commitment's instalment_invoicing is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
71
+ * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
72
72
  */
73
73
  triggerCommitmentInstalment(id: string, instalmentId: string, body?: models.TriggerInstalmentRequest | undefined, options?: RequestOptions): Promise<models.BillingtermInstalment>;
74
74
  /**
package/esm/sdk/commitments.js CHANGED
@@ -100,7 +100,7 @@ export class Commitments extends ClientSDK {
100
100
  * Trigger instalment
101
101
  *
102
102
  * @remarks
103
- * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when the commitment's instalment_invoicing is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
103
+ * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
104
104
  */
105
105
  async triggerCommitmentInstalment(id, instalmentId, body, options) {
106
106
  return unwrapAsync(commitmentsTriggerCommitmentInstalment(this, id, instalmentId, body, options));