@flexprice/sdk 2.1.49-dev.3 → 2.1.49-dev.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/sdk/models/add-addon-request.md +13 -13
- package/docs/sdk/models/add-addon-to-subscription-request.md +11 -11
- package/docs/sdk/models/billingterm-instalment.md +1 -0
- package/docs/sdk/models/commitment-info.md +15 -12
- package/docs/sdk/models/commitment-response.md +0 -1
- package/docs/sdk/models/create-commitment-request.md +0 -1
- package/docs/sdk/models/create-customer-request.md +1 -0
- package/docs/sdk/models/create-subscription-line-item-request.md +6 -6
- package/docs/sdk/models/create-subscription-request.md +5 -4
- package/docs/sdk/models/customer-response.md +1 -0
- package/docs/sdk/models/customer.md +1 -0
- package/docs/sdk/models/get-usage-analytics-request.md +1 -1
- package/docs/sdk/models/get-usage-analytics-response.md +10 -8
- package/docs/sdk/models/grouped-invoicing-child-request.md +4 -4
- package/docs/sdk/models/invoice-payment-failure-reason.md +17 -0
- package/docs/sdk/models/payment-response.md +33 -32
- package/docs/sdk/models/price-response.md +2 -1
- package/docs/sdk/models/settings-override.md +15 -0
- package/docs/sdk/models/subscription-config-override.md +16 -0
- package/docs/sdk/models/subscription-response-v2.md +1 -0
- package/docs/sdk/models/subscription-response.md +1 -0
- package/docs/sdk/models/update-customer-request.md +1 -0
- package/docs/sdk/models/update-subscription-line-item-request.md +20 -20
- package/docs/sdk/models/update-subscription-request.md +1 -0
- package/docs/sdk/models/usage-analytic-instalment.md +24 -0
- package/docs/sdk/models/usage-analytic-point.md +3 -0
- package/docs/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.md +21 -0
- package/docs/sdk/models/webhook-dto-payment.md +1 -0
- package/docs/sdk/models/webhook-event-name.md +1 -1
- package/docs/sdks/scheduledtasks/README.md +0 -143
- package/docs/sdks/webhookevents/README.md +69 -0
- package/esm/funcs/{scheduled-tasks-schedule-update-billing-period.d.ts → webhook-events-post-webhook-events-invoice-payment-failed.d.ts} +4 -4
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-failed.d.ts.map +1 -0
- package/esm/funcs/{scheduled-tasks-schedule-draft-finalization.js → webhook-events-post-webhook-events-invoice-payment-failed.js} +7 -10
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-failed.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.d.ts.map +1 -1
- package/esm/lib/config.js +3 -3
- package/esm/lib/config.js.map +1 -1
- package/esm/sdk/models/add-addon-request.d.ts +1 -1
- package/esm/sdk/models/add-addon-to-subscription-request.d.ts +1 -1
- package/esm/sdk/models/billingterm-instalment.d.ts +4 -0
- package/esm/sdk/models/billingterm-instalment.d.ts.map +1 -1
- package/esm/sdk/models/billingterm-instalment.js +2 -0
- package/esm/sdk/models/billingterm-instalment.js.map +1 -1
- package/esm/sdk/models/commitment-info.d.ts +15 -0
- package/esm/sdk/models/commitment-info.d.ts.map +1 -1
- package/esm/sdk/models/commitment-info.js +12 -0
- package/esm/sdk/models/commitment-info.js.map +1 -1
- package/esm/sdk/models/commitment-response.d.ts +0 -1
- package/esm/sdk/models/commitment-response.d.ts.map +1 -1
- package/esm/sdk/models/commitment-response.js +0 -1
- package/esm/sdk/models/commitment-response.js.map +1 -1
- package/esm/sdk/models/create-commitment-request.d.ts +0 -2
- package/esm/sdk/models/create-commitment-request.d.ts.map +1 -1
- package/esm/sdk/models/create-commitment-request.js +0 -1
- package/esm/sdk/models/create-commitment-request.js.map +1 -1
- package/esm/sdk/models/create-customer-request.d.ts +3 -0
- package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/create-customer-request.js +2 -0
- package/esm/sdk/models/create-customer-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-line-item-request.d.ts +16 -1
- package/esm/sdk/models/create-subscription-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-line-item-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +13 -1
- package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-request.js +2 -0
- package/esm/sdk/models/create-subscription-request.js.map +1 -1
- package/esm/sdk/models/customer-response.d.ts +2 -0
- package/esm/sdk/models/customer-response.d.ts.map +1 -1
- package/esm/sdk/models/customer-response.js +2 -0
- package/esm/sdk/models/customer-response.js.map +1 -1
- package/esm/sdk/models/customer.d.ts +2 -0
- package/esm/sdk/models/customer.d.ts.map +1 -1
- package/esm/sdk/models/customer.js +2 -0
- package/esm/sdk/models/customer.js.map +1 -1
- package/esm/sdk/models/get-usage-analytics-request.d.ts +1 -1
- package/esm/sdk/models/get-usage-analytics-response.d.ts +12 -0
- package/esm/sdk/models/get-usage-analytics-response.d.ts.map +1 -1
- package/esm/sdk/models/get-usage-analytics-response.js +4 -0
- package/esm/sdk/models/get-usage-analytics-response.js.map +1 -1
- package/esm/sdk/models/grouped-invoicing-child-request.d.ts +10 -1
- package/esm/sdk/models/grouped-invoicing-child-request.d.ts.map +1 -1
- package/esm/sdk/models/grouped-invoicing-child-request.js.map +1 -1
- package/esm/sdk/models/index.d.ts +5 -2
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +5 -2
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-payment-failure-reason.d.ts +11 -0
- package/esm/sdk/models/invoice-payment-failure-reason.d.ts.map +1 -0
- package/esm/sdk/models/invoice-payment-failure-reason.js +12 -0
- package/esm/sdk/models/invoice-payment-failure-reason.js.map +1 -0
- package/esm/sdk/models/payment-response.d.ts +4 -0
- package/esm/sdk/models/payment-response.d.ts.map +1 -1
- package/esm/sdk/models/payment-response.js +2 -0
- package/esm/sdk/models/payment-response.js.map +1 -1
- package/esm/sdk/models/price-response.d.ts +4 -0
- package/esm/sdk/models/price-response.d.ts.map +1 -1
- package/esm/sdk/models/price-response.js +1 -0
- package/esm/sdk/models/price-response.js.map +1 -1
- package/esm/sdk/models/settings-override.d.ts +18 -0
- package/esm/sdk/models/settings-override.d.ts.map +1 -0
- package/esm/sdk/models/settings-override.js +31 -0
- package/esm/sdk/models/settings-override.js.map +1 -0
- package/esm/sdk/models/subscription-config-override.d.ts +19 -0
- package/esm/sdk/models/subscription-config-override.d.ts.map +1 -0
- package/esm/sdk/models/subscription-config-override.js +34 -0
- package/esm/sdk/models/subscription-config-override.js.map +1 -0
- package/esm/sdk/models/subscription-response-v2.d.ts +2 -0
- package/esm/sdk/models/subscription-response-v2.d.ts.map +1 -1
- package/esm/sdk/models/subscription-response-v2.js +2 -0
- package/esm/sdk/models/subscription-response-v2.js.map +1 -1
- package/esm/sdk/models/subscription-response.d.ts +2 -0
- package/esm/sdk/models/subscription-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-response.js +2 -0
- package/esm/sdk/models/subscription-response.js.map +1 -1
- package/esm/sdk/models/update-customer-request.d.ts +3 -0
- package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/update-customer-request.js +2 -0
- package/esm/sdk/models/update-customer-request.js.map +1 -1
- package/esm/sdk/models/update-subscription-line-item-request.d.ts +17 -1
- package/esm/sdk/models/update-subscription-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/update-subscription-line-item-request.js.map +1 -1
- package/esm/sdk/models/update-subscription-request.d.ts +3 -0
- package/esm/sdk/models/update-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/update-subscription-request.js +2 -0
- package/esm/sdk/models/update-subscription-request.js.map +1 -1
- package/esm/sdk/models/usage-analytic-instalment.d.ts +22 -0
- package/esm/sdk/models/usage-analytic-instalment.d.ts.map +1 -0
- package/esm/sdk/models/usage-analytic-instalment.js +34 -0
- package/esm/sdk/models/usage-analytic-instalment.js.map +1 -0
- package/esm/sdk/models/usage-analytic-point.d.ts +6 -0
- package/esm/sdk/models/usage-analytic-point.d.ts.map +1 -1
- package/esm/sdk/models/usage-analytic-point.js +6 -0
- package/esm/sdk/models/usage-analytic-point.js.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.d.ts +20 -0
- package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.js +31 -0
- package/esm/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-payment.d.ts +1 -0
- package/esm/sdk/models/webhook-dto-payment.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-payment.js +2 -0
- package/esm/sdk/models/webhook-dto-payment.js.map +1 -1
- package/esm/sdk/models/webhook-event-name.d.ts +1 -0
- package/esm/sdk/models/webhook-event-name.d.ts.map +1 -1
- package/esm/sdk/models/webhook-event-name.js +1 -0
- package/esm/sdk/models/webhook-event-name.js.map +1 -1
- package/esm/sdk/scheduled-tasks.d.ts +0 -14
- package/esm/sdk/scheduled-tasks.d.ts.map +1 -1
- package/esm/sdk/scheduled-tasks.js +0 -20
- package/esm/sdk/scheduled-tasks.js.map +1 -1
- package/esm/sdk/webhook-events.d.ts +7 -0
- package/esm/sdk/webhook-events.d.ts.map +1 -1
- package/esm/sdk/webhook-events.js +10 -0
- package/esm/sdk/webhook-events.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +2 -2
- package/src/funcs/{scheduled-tasks-schedule-draft-finalization.ts → webhook-events-post-webhook-events-invoice-payment-failed.ts} +13 -19
- package/src/lib/config.ts +4 -3
- package/src/sdk/models/add-addon-request.ts +1 -1
- package/src/sdk/models/add-addon-to-subscription-request.ts +1 -1
- package/src/sdk/models/billingterm-instalment.ts +6 -0
- package/src/sdk/models/commitment-info.ts +29 -0
- package/src/sdk/models/commitment-response.ts +0 -2
- package/src/sdk/models/create-commitment-request.ts +0 -3
- package/src/sdk/models/create-customer-request.ts +8 -0
- package/src/sdk/models/create-subscription-line-item-request.ts +16 -1
- package/src/sdk/models/create-subscription-request.ts +18 -1
- package/src/sdk/models/customer-response.ts +6 -0
- package/src/sdk/models/customer.ts +6 -0
- package/src/sdk/models/get-usage-analytics-request.ts +1 -1
- package/src/sdk/models/get-usage-analytics-response.ts +18 -0
- package/src/sdk/models/grouped-invoicing-child-request.ts +10 -1
- package/src/sdk/models/index.ts +5 -2
- package/src/sdk/models/invoice-payment-failure-reason.ts +22 -0
- package/src/sdk/models/payment-response.ts +6 -0
- package/src/sdk/models/price-response.ts +5 -0
- package/src/sdk/models/settings-override.ts +73 -0
- package/src/sdk/models/subscription-config-override.ts +71 -0
- package/src/sdk/models/subscription-response-v2.ts +6 -0
- package/src/sdk/models/subscription-response.ts +6 -0
- package/src/sdk/models/update-customer-request.ts +8 -0
- package/src/sdk/models/update-subscription-line-item-request.ts +17 -1
- package/src/sdk/models/update-subscription-request.ts +8 -0
- package/src/sdk/models/usage-analytic-instalment.ts +66 -0
- package/src/sdk/models/usage-analytic-point.ts +13 -0
- package/src/sdk/models/webhook-dto-invoice-payment-failed-webhook-payload.ts +73 -0
- package/src/sdk/models/webhook-dto-payment.ts +3 -0
- package/src/sdk/models/webhook-event-name.ts +1 -0
- package/src/sdk/scheduled-tasks.ts +0 -34
- package/src/sdk/webhook-events.ts +16 -0
- package/docs/sdk/models/schedule-draft-finalization-response.md +0 -16
- package/docs/sdk/models/schedule-update-billing-period-request.md +0 -16
- package/docs/sdk/models/schedule-update-billing-period-response.md +0 -16
- package/esm/funcs/scheduled-tasks-schedule-draft-finalization.d.ts +0 -17
- package/esm/funcs/scheduled-tasks-schedule-draft-finalization.d.ts.map +0 -1
- package/esm/funcs/scheduled-tasks-schedule-draft-finalization.js.map +0 -1
- package/esm/funcs/scheduled-tasks-schedule-update-billing-period.d.ts.map +0 -1
- package/esm/funcs/scheduled-tasks-schedule-update-billing-period.js +0 -73
- package/esm/funcs/scheduled-tasks-schedule-update-billing-period.js.map +0 -1
- package/esm/sdk/models/schedule-draft-finalization-op.d.ts +0 -11
- package/esm/sdk/models/schedule-draft-finalization-op.d.ts.map +0 -1
- package/esm/sdk/models/schedule-draft-finalization-op.js +0 -11
- package/esm/sdk/models/schedule-draft-finalization-op.js.map +0 -1
- package/esm/sdk/models/schedule-update-billing-period-op.d.ts +0 -20
- package/esm/sdk/models/schedule-update-billing-period-op.d.ts.map +0 -1
- package/esm/sdk/models/schedule-update-billing-period-op.js +0 -16
- package/esm/sdk/models/schedule-update-billing-period-op.js.map +0 -1
- package/src/funcs/scheduled-tasks-schedule-update-billing-period.ts +0 -157
- package/src/sdk/models/schedule-draft-finalization-op.ts +0 -29
- package/src/sdk/models/schedule-update-billing-period-op.ts +0 -54
|
@@ -14,7 +14,7 @@ let value: GetUsageAnalyticsRequest = {};
|
|
|
14
14
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
15
|
| `breakdownBucket` | *boolean* | :heavy_minus_sign: | BreakdownBucket when true augments each time-series point with BucketID/PriceID<br/>and appends a BucketSummaries rollup to each item. Requires WindowSize to be set<br/>and the item to be linked to a subscription line item that has CommitmentTimeBuckets.<br/>Default: false (opt-in, backward compatible). |
|
|
16
16
|
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
17
|
-
| `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon"
|
|
17
|
+
| `expand` | *string*[] | :heavy_minus_sign: | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon","source","instalments" |
|
|
18
18
|
| `externalCustomerId` | *string* | :heavy_minus_sign: | ExternalCustomerID is the single external customer ID.<br/>Optional when ExternalCustomerIDs is provided; required otherwise. |
|
|
19
19
|
| `featureIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
20
20
|
| `groupBy` | *string*[] | :heavy_minus_sign: | allowed values: "source", "feature_id", "properties.<field_name>" |
|
|
@@ -44,11 +44,13 @@ let value: GetUsageAnalyticsResponse = {
|
|
|
44
44
|
|
|
45
45
|
## Fields
|
|
46
46
|
|
|
47
|
-
| Field
|
|
48
|
-
|
|
|
49
|
-
| `currency`
|
|
50
|
-
| `customAnalytics`
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
47
|
+
| Field | Type | Required | Description |
|
|
48
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
49
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
50
|
+
| `customAnalytics` | [models.CustomAnalyticItem](../../sdk/models/custom-analytic-item.md)[] | :heavy_minus_sign: | N/A |
|
|
51
|
+
| `instalments` | [models.UsageAnalyticInstalment](../../sdk/models/usage-analytic-instalment.md)[] | :heavy_minus_sign: | Instalments lists, with expand "instalments", the instalments invoiced in the range for the v2 commitments covering<br/>a queried meter; it is empty with property or source filters, or when no usage line runs in the range. |
|
|
52
|
+
| `items` | [models.UsageAnalyticItem](../../sdk/models/usage-analytic-item.md)[] | :heavy_minus_sign: | N/A |
|
|
53
|
+
| `subtotal` | *string* | :heavy_minus_sign: | N/A |
|
|
54
|
+
| `totalCost` | *string* | :heavy_minus_sign: | TotalCost is the final cost after discount (Subtotal - TotalDiscount) |
|
|
55
|
+
| `totalCostWithInstalments` | *string* | :heavy_minus_sign: | TotalCostWithInstalments is TotalCost plus the amounts of Instalments, set when expand includes "instalments". |
|
|
56
|
+
| `totalDiscount` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -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: |
|
|
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: |
|
|
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: |
|
|
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: |
|
|
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 |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# InvoicePaymentFailureReason
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { InvoicePaymentFailureReason } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: InvoicePaymentFailureReason = "provider_error";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"payment_method_unavailable" | "provider_error" | "declined" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -10,35 +10,36 @@ let value: PaymentResponse = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `amount`
|
|
16
|
-
| `attempts`
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
35
|
-
| `
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `
|
|
40
|
-
| `
|
|
41
|
-
| `
|
|
42
|
-
| `
|
|
43
|
-
| `
|
|
44
|
-
| `
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
15
|
+
| `amount` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `attempts` | [models.PaymentAttemptResponse](../../sdk/models/payment-attempt-response.md)[] | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `connectionId` | *string* | :heavy_minus_sign: | connection_id is the connection that took this payment; null when no gateway connection was used |
|
|
18
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `destinationId` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `destinationType` | [models.PaymentDestinationType](../../sdk/models/payment-destination-type.md) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `environmentId` | *string* | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `errorMessage` | *string* | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `failedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `gatewayMetadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `gatewayPaymentId` | *string* | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `gatewayTrackingId` | *string* | :heavy_minus_sign: | N/A |
|
|
29
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
30
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
|
|
31
|
+
| `invoiceNumber` | *string* | :heavy_minus_sign: | N/A |
|
|
32
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
33
|
+
| `paymentGateway` | *string* | :heavy_minus_sign: | N/A |
|
|
34
|
+
| `paymentMethodId` | *string* | :heavy_minus_sign: | N/A |
|
|
35
|
+
| `paymentMethodType` | [models.PaymentMethodType](../../sdk/models/payment-method-type.md) | :heavy_minus_sign: | N/A |
|
|
36
|
+
| `paymentStatus` | [models.PaymentStatus](../../sdk/models/payment-status.md) | :heavy_minus_sign: | N/A |
|
|
37
|
+
| `paymentUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
38
|
+
| `refundedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
39
|
+
| `saveCardAndMakeDefault` | *boolean* | :heavy_minus_sign: | N/A |
|
|
40
|
+
| `succeededAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
41
|
+
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
42
|
+
| `trackAttempts` | *boolean* | :heavy_minus_sign: | N/A |
|
|
43
|
+
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
44
|
+
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
45
|
+
| `voidedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
@@ -88,4 +88,5 @@ let value: PriceResponse = {
|
|
|
88
88
|
| `trialPeriodDays` | *number* | :heavy_minus_sign: | TrialPeriodDays is the number of days for the trial period<br/>Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING) |
|
|
89
89
|
| `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
|
|
90
90
|
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
91
|
-
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
91
|
+
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
92
|
+
| `warnings` | *string*[] | :heavy_minus_sign: | Warnings lists defaults applied on create that the caller may want to set explicitly. |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# SettingsOverride
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { SettingsOverride } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: SettingsOverride = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
|
15
|
+
| `subscriptionConfig` | [models.SubscriptionConfigOverride](../../sdk/models/subscription-config-override.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# SubscriptionConfigOverride
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { SubscriptionConfigOverride } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: SubscriptionConfigOverride = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
|
15
|
+
| `autoCancellationEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `gracePeriodDays` | *number* | :heavy_minus_sign: | N/A |
|
|
@@ -126,6 +126,7 @@ let value: SubscriptionResponseV2 = {
|
|
|
126
126
|
| `planId` | *string* | :heavy_minus_sign: | PlanID is the identifier for the plan in our system |
|
|
127
127
|
| `planPricesOutOfSync` | *boolean* | :heavy_minus_sign: | PlanPricesOutOfSync is true when the subscription's synced_price_sequence<br/>is behind the plan's current max prices.sequence — i.e. plan-price<br/>changes have not yet been reconciled into this subscription's line items. |
|
|
128
128
|
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
129
|
+
| `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
|
|
129
130
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate is the start date of the subscription |
|
|
130
131
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
131
132
|
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
@@ -165,6 +165,7 @@ let value: SubscriptionResponse = {
|
|
|
165
165
|
| `plan` | [models.PlanResponse](../../sdk/models/plan-response.md) | :heavy_minus_sign: | N/A |
|
|
166
166
|
| `planId` | *string* | :heavy_minus_sign: | PlanID is the identifier for the plan in our system |
|
|
167
167
|
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
168
|
+
| `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
|
|
168
169
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | StartDate is the start date of the subscription |
|
|
169
170
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
170
171
|
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
@@ -29,5 +29,6 @@ let value: UpdateCustomerRequest = {};
|
|
|
29
29
|
| `integrationEntityMapping` | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[] | :heavy_minus_sign: | integration_entity_mapping contains provider integration mappings for this customer |
|
|
30
30
|
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | metadata contains updated key-value pairs that will replace existing metadata |
|
|
31
31
|
| `name` | *string* | :heavy_minus_sign: | name is the updated name or company name for the customer |
|
|
32
|
+
| `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
|
|
32
33
|
| `taxTreatment` | [models.TaxTreatment](../../sdk/models/tax-treatment.md) | :heavy_minus_sign: | N/A |
|
|
33
34
|
| `timezone` | *string* | :heavy_minus_sign: | timezone is the updated IANA timezone name for the customer (e.g. "Asia/Kolkata", "America/New_York") |
|
|
@@ -10,23 +10,23 @@ let value: UpdateSubscriptionLineItemRequest = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `amount`
|
|
16
|
-
| `billingModel`
|
|
17
|
-
| `bucketSize`
|
|
18
|
-
| `commitmentAmount`
|
|
19
|
-
| `commitmentDuration`
|
|
20
|
-
| `commitmentOverageFactor`
|
|
21
|
-
| `commitmentQuantity`
|
|
22
|
-
| `commitmentTimeBuckets`
|
|
23
|
-
| `commitmentTrueUpEnabled`
|
|
24
|
-
| `commitmentType`
|
|
25
|
-
| `commitmentWindowed`
|
|
26
|
-
| `effectiveFrom`
|
|
27
|
-
| `metadata`
|
|
28
|
-
| `priceUnitAmount`
|
|
29
|
-
| `priceUnitTiers`
|
|
30
|
-
| `tierMode`
|
|
31
|
-
| `tiers`
|
|
32
|
-
| `transformQuantity`
|
|
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 |
|
|
@@ -16,4 +16,5 @@ let value: UpdateSubscriptionRequest = {};
|
|
|
16
16
|
| `cancelAtPeriodEnd` | *boolean* | :heavy_minus_sign: | Pointer so omitting the field leaves the stored value unchanged; sending it sets the flag. |
|
|
17
17
|
| `parentSubscriptionId` | *string* | :heavy_minus_sign: | ParentSubscriptionID sets or clears the parent subscription. Omit to leave unchanged; send "" to clear. |
|
|
18
18
|
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `settings` | [models.SettingsOverride](../../sdk/models/settings-override.md) | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `status` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UsageAnalyticInstalment
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UsageAnalyticInstalment } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UsageAnalyticInstalment = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `amount` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `commitmentId` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `invoiceId` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `invoiceLabel` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `invoicedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | when the invoice billing it was finalized |
|
|
22
|
+
| `servicePeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `servicePeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -14,8 +14,11 @@ let value: UsageAnalyticPoint = {};
|
|
|
14
14
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
15
|
| `buckets` | [models.PointBucket](../../sdk/models/point-bucket.md)[] | :heavy_minus_sign: | Buckets lists every commitment bucket this (possibly rolled-up) window<br/>overlaps — only populated when BreakdownBucket=true and the line item has<br/>CommitmentTimeBuckets. A coarse window can overlap more than one bucket, and<br/>only partially, so this is a list. Empty when the window touches no bucket.<br/>It is an informational HINT only: the point's single cost/computed_* totals<br/>mix all overlapped buckets and out-of-bucket time and CANNOT be split per<br/>bucket — read bucket_summaries for exact per-bucket cost. |
|
|
16
16
|
| `computedCommitmentUtilizedAmount` | *string* | :heavy_minus_sign: | Commitment breakdown (only populated for windowed commitments) |
|
|
17
|
+
| `computedCommitmentUtilizedQuantity` | *string* | :heavy_minus_sign: | Usage units behind the commitment breakdown, for v2 commitments |
|
|
17
18
|
| `computedOverageAmount` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `computedOverageQuantity` | *string* | :heavy_minus_sign: | N/A |
|
|
18
20
|
| `computedTrueUpAmount` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `computedTrueUpQuantity` | *string* | :heavy_minus_sign: | N/A |
|
|
19
22
|
| `cost` | *string* | :heavy_minus_sign: | Cost is the final cost after discount (Subtotal - Discount) |
|
|
20
23
|
| `discount` | *string* | :heavy_minus_sign: | N/A |
|
|
21
24
|
| `eventCount` | *number* | :heavy_minus_sign: | Number of events in this time window |
|