@flexprice/sdk 2.1.4 → 2.1.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.
- package/FUNCTIONS.md +0 -1
- package/USAGE.md +0 -1
- package/docs/sdk/models/add-addon-request.md +2 -0
- package/docs/sdk/models/add-addon-to-subscription-request.md +2 -0
- package/docs/sdk/models/addon-cadence.md +15 -0
- package/docs/sdk/models/addon-filter.md +0 -1
- package/docs/sdk/models/addon-response.md +0 -1
- package/docs/sdk/models/addon-status.md +1 -1
- package/docs/sdk/models/addon.md +0 -1
- package/docs/sdk/models/create-addon-request.md +6 -8
- package/docs/sdk/models/create-addon-response.md +0 -1
- package/docs/sdk/models/create-price-request.md +1 -1
- package/docs/sdk/models/create-subscription-line-item-request.md +1 -0
- package/docs/sdk/models/create-subscription-request.md +1 -2
- package/docs/sdk/models/delete-subscription-line-item-request.md +4 -3
- package/docs/sdk/models/invoice-billing-reason.md +1 -1
- package/docs/sdk/models/price-price.md +42 -42
- package/docs/sdk/models/price-response.md +47 -47
- package/docs/sdk/models/remove-addon-request.md +6 -4
- package/docs/sdk/models/subscription-filter.md +1 -0
- package/docs/sdk/models/subscription-line-item-response.md +1 -1
- package/docs/sdk/models/subscription-price-create-request.md +1 -1
- package/docs/sdk/models/subscription-subscription-line-item.md +1 -1
- package/docs/sdks/addons/README.md +0 -2
- package/docs/sdks/subscriptions/README.md +0 -226
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/sdks.js +0 -2
- package/esm/lib/sdks.js.map +1 -1
- package/esm/sdk/models/add-addon-request.d.ts +6 -0
- package/esm/sdk/models/add-addon-request.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-request.js +5 -0
- package/esm/sdk/models/add-addon-request.js.map +1 -1
- package/esm/sdk/models/add-addon-to-subscription-request.d.ts +6 -0
- package/esm/sdk/models/add-addon-to-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-to-subscription-request.js +5 -0
- package/esm/sdk/models/add-addon-to-subscription-request.js.map +1 -1
- package/esm/sdk/models/addon-cadence.d.ts +10 -0
- package/esm/sdk/models/addon-cadence.d.ts.map +1 -0
- package/esm/sdk/models/addon-cadence.js +12 -0
- package/esm/sdk/models/addon-cadence.js.map +1 -0
- package/esm/sdk/models/addon-filter.d.ts +0 -3
- package/esm/sdk/models/addon-filter.d.ts.map +1 -1
- package/esm/sdk/models/addon-filter.js +0 -3
- package/esm/sdk/models/addon-filter.js.map +1 -1
- package/esm/sdk/models/addon-response.d.ts +0 -2
- package/esm/sdk/models/addon-response.d.ts.map +1 -1
- package/esm/sdk/models/addon-response.js +0 -2
- package/esm/sdk/models/addon-response.js.map +1 -1
- package/esm/sdk/models/addon-status.d.ts +1 -1
- package/esm/sdk/models/addon-status.js +1 -1
- package/esm/sdk/models/addon-status.js.map +1 -1
- package/esm/sdk/models/addon.d.ts +0 -2
- package/esm/sdk/models/addon.d.ts.map +1 -1
- package/esm/sdk/models/addon.js +0 -2
- package/esm/sdk/models/addon.js.map +1 -1
- package/esm/sdk/models/create-addon-request.d.ts +0 -3
- package/esm/sdk/models/create-addon-request.d.ts.map +1 -1
- package/esm/sdk/models/create-addon-request.js +0 -2
- package/esm/sdk/models/create-addon-request.js.map +1 -1
- package/esm/sdk/models/create-addon-response.d.ts +0 -2
- package/esm/sdk/models/create-addon-response.d.ts.map +1 -1
- package/esm/sdk/models/create-addon-response.js +0 -2
- package/esm/sdk/models/create-addon-response.js.map +1 -1
- package/esm/sdk/models/create-price-request.d.ts +2 -2
- package/esm/sdk/models/create-price-request.d.ts.map +1 -1
- package/esm/sdk/models/create-price-request.js +2 -2
- package/esm/sdk/models/create-price-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-line-item-request.d.ts +3 -0
- package/esm/sdk/models/create-subscription-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-line-item-request.js +3 -0
- package/esm/sdk/models/create-subscription-line-item-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +8 -4
- package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-request.js +2 -4
- package/esm/sdk/models/create-subscription-request.js.map +1 -1
- package/esm/sdk/models/delete-subscription-line-item-request.d.ts +3 -0
- package/esm/sdk/models/delete-subscription-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/delete-subscription-line-item-request.js +3 -0
- package/esm/sdk/models/delete-subscription-line-item-request.js.map +1 -1
- package/esm/sdk/models/index.d.ts +1 -8
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +1 -8
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.d.ts +1 -0
- package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.js +1 -0
- package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
- package/esm/sdk/models/pause-mode.d.ts +0 -2
- package/esm/sdk/models/pause-mode.d.ts.map +1 -1
- package/esm/sdk/models/pause-mode.js +0 -2
- package/esm/sdk/models/pause-mode.js.map +1 -1
- package/esm/sdk/models/price-price.d.ts +2 -2
- package/esm/sdk/models/price-price.d.ts.map +1 -1
- package/esm/sdk/models/price-price.js +2 -2
- package/esm/sdk/models/price-price.js.map +1 -1
- package/esm/sdk/models/price-response.d.ts +2 -2
- package/esm/sdk/models/price-response.d.ts.map +1 -1
- package/esm/sdk/models/price-response.js +2 -2
- package/esm/sdk/models/price-response.js.map +1 -1
- package/esm/sdk/models/remove-addon-request.d.ts +13 -0
- package/esm/sdk/models/remove-addon-request.d.ts.map +1 -1
- package/esm/sdk/models/remove-addon-request.js +5 -0
- package/esm/sdk/models/remove-addon-request.js.map +1 -1
- package/esm/sdk/models/resume-mode.d.ts +0 -2
- package/esm/sdk/models/resume-mode.d.ts.map +1 -1
- package/esm/sdk/models/resume-mode.js +0 -2
- package/esm/sdk/models/resume-mode.js.map +1 -1
- package/esm/sdk/models/subscription-filter.d.ts +8 -0
- package/esm/sdk/models/subscription-filter.d.ts.map +1 -1
- package/esm/sdk/models/subscription-filter.js +2 -0
- package/esm/sdk/models/subscription-filter.js.map +1 -1
- package/esm/sdk/models/subscription-line-item-response.d.ts +1 -1
- package/esm/sdk/models/subscription-line-item-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-line-item-response.js +2 -2
- package/esm/sdk/models/subscription-line-item-response.js.map +1 -1
- package/esm/sdk/models/subscription-price-create-request.d.ts +2 -2
- package/esm/sdk/models/subscription-price-create-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-price-create-request.js +2 -2
- package/esm/sdk/models/subscription-price-create-request.js.map +1 -1
- package/esm/sdk/models/subscription-subscription-line-item.d.ts +1 -1
- package/esm/sdk/models/subscription-subscription-line-item.d.ts.map +1 -1
- package/esm/sdk/models/subscription-subscription-line-item.js +2 -2
- package/esm/sdk/models/subscription-subscription-line-item.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +0 -21
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +0 -30
- package/esm/sdk/subscriptions.js.map +1 -1
- package/examples/addonsCreateAddon.example.ts +0 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/sdks.ts +0 -2
- package/src/sdk/models/add-addon-request.ts +12 -0
- package/src/sdk/models/add-addon-to-subscription-request.ts +12 -0
- package/src/sdk/models/addon-cadence.ts +16 -0
- package/src/sdk/models/addon-filter.ts +0 -5
- package/src/sdk/models/addon-response.ts +0 -3
- package/src/sdk/models/addon-status.ts +1 -1
- package/src/sdk/models/addon.ts +0 -3
- package/src/sdk/models/create-addon-request.ts +0 -4
- package/src/sdk/models/create-addon-response.ts +0 -3
- package/src/sdk/models/create-price-request.ts +4 -4
- package/src/sdk/models/create-subscription-line-item-request.ts +8 -0
- package/src/sdk/models/create-subscription-request.ts +10 -8
- package/src/sdk/models/delete-subscription-line-item-request.ts +8 -0
- package/src/sdk/models/index.ts +1 -8
- package/src/sdk/models/invoice-billing-reason.ts +1 -0
- package/src/sdk/models/pause-mode.ts +0 -3
- package/src/sdk/models/price-price.ts +4 -4
- package/src/sdk/models/price-response.ts +4 -4
- package/src/sdk/models/remove-addon-request.ts +22 -0
- package/src/sdk/models/resume-mode.ts +0 -3
- package/src/sdk/models/subscription-filter.ts +12 -0
- package/src/sdk/models/subscription-line-item-response.ts +3 -3
- package/src/sdk/models/subscription-price-create-request.ts +4 -4
- package/src/sdk/models/subscription-subscription-line-item.ts +3 -3
- package/src/sdk/subscriptions.ts +0 -58
- package/docs/sdk/models/addon-type.md +0 -17
- package/docs/sdk/models/list-subscription-pauses-request.md +0 -17
- package/docs/sdk/models/list-subscription-pauses-response.md +0 -18
- package/docs/sdk/models/pause-subscription-request-request.md +0 -21
- package/docs/sdk/models/pause-subscription-request.md +0 -25
- package/docs/sdk/models/resume-subscription-request-request.md +0 -21
- package/docs/sdk/models/resume-subscription-request.md +0 -21
- package/docs/sdk/models/subscription-pause-response.md +0 -35
- package/esm/funcs/subscriptions-list-subscription-pauses.d.ts +0 -17
- package/esm/funcs/subscriptions-list-subscription-pauses.d.ts.map +0 -1
- package/esm/funcs/subscriptions-list-subscription-pauses.js +0 -91
- package/esm/funcs/subscriptions-list-subscription-pauses.js.map +0 -1
- package/esm/funcs/subscriptions-pause-subscription.d.ts +0 -17
- package/esm/funcs/subscriptions-pause-subscription.d.ts.map +0 -1
- package/esm/funcs/subscriptions-pause-subscription.js +0 -93
- package/esm/funcs/subscriptions-pause-subscription.js.map +0 -1
- package/esm/funcs/subscriptions-resume-subscription.d.ts +0 -17
- package/esm/funcs/subscriptions-resume-subscription.d.ts.map +0 -1
- package/esm/funcs/subscriptions-resume-subscription.js +0 -93
- package/esm/funcs/subscriptions-resume-subscription.js.map +0 -1
- package/esm/sdk/models/addon-type.d.ts +0 -12
- package/esm/sdk/models/addon-type.d.ts.map +0 -1
- package/esm/sdk/models/addon-type.js +0 -13
- package/esm/sdk/models/addon-type.js.map +0 -1
- package/esm/sdk/models/list-subscription-pauses-op.d.ts +0 -15
- package/esm/sdk/models/list-subscription-pauses-op.d.ts.map +0 -1
- package/esm/sdk/models/list-subscription-pauses-op.js +0 -12
- package/esm/sdk/models/list-subscription-pauses-op.js.map +0 -1
- package/esm/sdk/models/list-subscription-pauses-response.d.ts +0 -27
- package/esm/sdk/models/list-subscription-pauses-response.d.ts.map +0 -1
- package/esm/sdk/models/list-subscription-pauses-response.js +0 -16
- package/esm/sdk/models/list-subscription-pauses-response.js.map +0 -1
- package/esm/sdk/models/pause-subscription-op.d.ts +0 -21
- package/esm/sdk/models/pause-subscription-op.d.ts.map +0 -1
- package/esm/sdk/models/pause-subscription-op.js +0 -14
- package/esm/sdk/models/pause-subscription-op.js.map +0 -1
- package/esm/sdk/models/pause-subscription-request.d.ts +0 -74
- package/esm/sdk/models/pause-subscription-request.d.ts.map +0 -1
- package/esm/sdk/models/pause-subscription-request.js +0 -28
- package/esm/sdk/models/pause-subscription-request.js.map +0 -1
- package/esm/sdk/models/resume-subscription-op.d.ts +0 -21
- package/esm/sdk/models/resume-subscription-op.d.ts.map +0 -1
- package/esm/sdk/models/resume-subscription-op.js +0 -14
- package/esm/sdk/models/resume-subscription-op.js.map +0 -1
- package/esm/sdk/models/resume-subscription-request.d.ts +0 -38
- package/esm/sdk/models/resume-subscription-request.d.ts.map +0 -1
- package/esm/sdk/models/resume-subscription-request.js +0 -21
- package/esm/sdk/models/resume-subscription-request.js.map +0 -1
- package/esm/sdk/models/subscription-pause-response.d.ts +0 -64
- package/esm/sdk/models/subscription-pause-response.d.ts.map +0 -1
- package/esm/sdk/models/subscription-pause-response.js +0 -55
- package/esm/sdk/models/subscription-pause-response.js.map +0 -1
- package/src/funcs/subscriptions-list-subscription-pauses.ts +0 -182
- package/src/funcs/subscriptions-pause-subscription.ts +0 -187
- package/src/funcs/subscriptions-resume-subscription.ts +0 -187
- package/src/sdk/models/addon-type.ts +0 -20
- package/src/sdk/models/list-subscription-pauses-op.ts +0 -35
- package/src/sdk/models/list-subscription-pauses-response.ts +0 -52
- package/src/sdk/models/pause-subscription-op.ts +0 -46
- package/src/sdk/models/pause-subscription-request.ts +0 -106
- package/src/sdk/models/resume-subscription-op.ts +0 -46
- package/src/sdk/models/resume-subscription-request.ts +0 -63
- package/src/sdk/models/subscription-pause-response.ts +0 -123
package/FUNCTIONS.md
CHANGED
package/USAGE.md
CHANGED
|
@@ -16,7 +16,9 @@ let value: AddAddonRequest = {
|
|
|
16
16
|
| Field | Type | Required | Description |
|
|
17
17
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
18
18
|
| `addonId` | *string* | :heavy_check_mark: | N/A |
|
|
19
|
+
| `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `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) |
|
|
20
21
|
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
21
23
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
22
24
|
| `subscriptionId` | *string* | :heavy_check_mark: | N/A |
|
|
@@ -15,6 +15,8 @@ let value: AddAddonToSubscriptionRequest = {
|
|
|
15
15
|
| Field | Type | Required | Description |
|
|
16
16
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
17
17
|
| `addonId` | *string* | :heavy_check_mark: | N/A |
|
|
18
|
+
| `cadence` | [models.AddonCadence](../../sdk/models/addon-cadence.md) | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `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) |
|
|
19
20
|
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
20
22
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
@@ -13,7 +13,6 @@ let value: AddonFilter = {};
|
|
|
13
13
|
| Field | Type | Required | Description |
|
|
14
14
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
15
|
| `addonIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
16
|
-
| `addonType` | [models.AddonType](../../sdk/models/addon-type.md) | :heavy_minus_sign: | N/A |
|
|
17
16
|
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
18
17
|
| `expand` | *string* | :heavy_minus_sign: | N/A |
|
|
19
18
|
| `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | filters allows complex filtering based on multiple fields |
|
|
@@ -73,6 +73,5 @@ let value: AddonResponse = {
|
|
|
73
73
|
| `prices` | [models.PriceResponse](../../sdk/models/price-response.md)[] | :heavy_minus_sign: | Optional expanded fields |
|
|
74
74
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
75
75
|
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
76
|
-
| `type` | [models.AddonType](../../sdk/models/addon-type.md) | :heavy_minus_sign: | N/A |
|
|
77
76
|
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
78
77
|
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
package/docs/sdk/models/addon.md
CHANGED
|
@@ -22,6 +22,5 @@ let value: Addon = {};
|
|
|
22
22
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
23
23
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
24
24
|
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
25
|
-
| `type` | [models.AddonType](../../sdk/models/addon-type.md) | :heavy_minus_sign: | N/A |
|
|
26
25
|
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
27
26
|
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -8,16 +8,14 @@ import { CreateAddonRequest } from "@flexprice/sdk/sdk/models";
|
|
|
8
8
|
let value: CreateAddonRequest = {
|
|
9
9
|
lookupKey: "<value>",
|
|
10
10
|
name: "<value>",
|
|
11
|
-
type: "onetime",
|
|
12
11
|
};
|
|
13
12
|
```
|
|
14
13
|
|
|
15
14
|
## Fields
|
|
16
15
|
|
|
17
|
-
| Field
|
|
18
|
-
|
|
|
19
|
-
| `description`
|
|
20
|
-
| `lookupKey`
|
|
21
|
-
| `metadata`
|
|
22
|
-
| `name`
|
|
23
|
-
| `type` | [models.AddonType](../../sdk/models/addon-type.md) | :heavy_check_mark: | N/A |
|
|
16
|
+
| Field | Type | Required | Description |
|
|
17
|
+
| --------------------- | --------------------- | --------------------- | --------------------- |
|
|
18
|
+
| `description` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `lookupKey` | *string* | :heavy_check_mark: | N/A |
|
|
20
|
+
| `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `name` | *string* | :heavy_check_mark: | N/A |
|
|
@@ -73,6 +73,5 @@ let value: CreateAddonResponse = {
|
|
|
73
73
|
| `prices` | [models.PriceResponse](../../sdk/models/price-response.md)[] | :heavy_minus_sign: | Optional expanded fields |
|
|
74
74
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
75
75
|
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
76
|
-
| `type` | [models.AddonType](../../sdk/models/addon-type.md) | :heavy_minus_sign: | N/A |
|
|
77
76
|
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
78
77
|
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -44,5 +44,5 @@ let value: CreatePriceRequest = {
|
|
|
44
44
|
| `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
|
|
45
45
|
| `tiers` | [models.CreatePriceTier](../../sdk/models/create-price-tier.md)[] | :heavy_minus_sign: | N/A |
|
|
46
46
|
| `transformQuantity` | [models.PriceTransformQuantity](../../sdk/models/price-transform-quantity.md) | :heavy_minus_sign: | N/A |
|
|
47
|
-
| `
|
|
47
|
+
| `trialPeriodDays` | *number* | :heavy_minus_sign: | N/A |
|
|
48
48
|
| `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_check_mark: | N/A |
|
|
@@ -24,6 +24,7 @@ let value: CreateSubscriptionLineItemRequest = {};
|
|
|
24
24
|
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
25
25
|
| `price` | [models.SubscriptionPriceCreateRequest](../../sdk/models/subscription-price-create-request.md) | :heavy_minus_sign: | N/A |
|
|
26
26
|
| `priceId` | *string* | :heavy_minus_sign: | PriceID references an existing price (plan, addon, or subscription-scoped). Exactly one of price_id or price must be set. |
|
|
27
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
27
28
|
| `quantity` | *number* | :heavy_minus_sign: | N/A |
|
|
28
29
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
29
30
|
| `subscriptionPhaseId` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -50,5 +50,4 @@ let value: CreateSubscriptionRequest = {
|
|
|
50
50
|
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
51
51
|
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
52
52
|
| `taxRateOverrides` | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[] | :heavy_minus_sign: | tax_rate_overrides is the tax rate overrides to be applied to the subscription |
|
|
53
|
-
| `
|
|
54
|
-
| `trialStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
53
|
+
| `trialPeriodDays` | *number* | :heavy_minus_sign: | TrialPeriodDays: nil = inherit trial length from plan recurring-fixed prices (must be uniform).<br/>0 = explicitly no trial (overrides catalog). >0 = override duration in days. |
|
|
@@ -10,6 +10,7 @@ let value: DeleteSubscriptionLineItemRequest = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `effectiveFrom`
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
|
15
|
+
| `effectiveFrom` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
@@ -11,5 +11,5 @@ let value: InvoiceBillingReason = "SUBSCRIPTION_CYCLE";
|
|
|
11
11
|
## Values
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
"SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "PRORATION" | "MANUAL"
|
|
14
|
+
"SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "PRORATION" | "MANUAL"
|
|
15
15
|
```
|
|
@@ -10,45 +10,45 @@ let value: PricePrice = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `amount`
|
|
16
|
-
| `billingCadence`
|
|
17
|
-
| `billingModel`
|
|
18
|
-
| `billingPeriod`
|
|
19
|
-
| `billingPeriodCount`
|
|
20
|
-
| `conversionRate`
|
|
21
|
-
| `createdAt`
|
|
22
|
-
| `createdBy`
|
|
23
|
-
| `currency`
|
|
24
|
-
| `description`
|
|
25
|
-
| `displayAmount`
|
|
26
|
-
| `displayName`
|
|
27
|
-
| `displayPriceUnitAmount`
|
|
28
|
-
| `endDate`
|
|
29
|
-
| `entityId`
|
|
30
|
-
| `entityType`
|
|
31
|
-
| `environmentId`
|
|
32
|
-
| `groupId`
|
|
33
|
-
| `id`
|
|
34
|
-
| `invoiceCadence`
|
|
35
|
-
| `lookupKey`
|
|
36
|
-
| `metadata`
|
|
37
|
-
| `meterId`
|
|
38
|
-
| `minQuantity`
|
|
39
|
-
| `parentPriceId`
|
|
40
|
-
| `priceUnit`
|
|
41
|
-
| `priceUnitAmount`
|
|
42
|
-
| `priceUnitId`
|
|
43
|
-
| `priceUnitTiers`
|
|
44
|
-
| `priceUnitType`
|
|
45
|
-
| `startDate`
|
|
46
|
-
| `status`
|
|
47
|
-
| `tenantId`
|
|
48
|
-
| `tierMode`
|
|
49
|
-
| `tiers`
|
|
50
|
-
| `transformQuantity`
|
|
51
|
-
| `
|
|
52
|
-
| `type`
|
|
53
|
-
| `updatedAt`
|
|
54
|
-
| `updatedBy`
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `amount` | *string* | :heavy_minus_sign: | Amount stored in main currency units (e.g., dollars, not cents)<br/>For USD: 12.50 means $12.50 |
|
|
16
|
+
| `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `billingPeriodCount` | *number* | :heavy_minus_sign: | BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12 |
|
|
20
|
+
| `conversionRate` | *string* | :heavy_minus_sign: | ConversionRate is the conversion rate of the price unit to the fiat currency |
|
|
21
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `currency` | *string* | :heavy_minus_sign: | Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp |
|
|
24
|
+
| `description` | *string* | :heavy_minus_sign: | Description of the price |
|
|
25
|
+
| `displayAmount` | *string* | :heavy_minus_sign: | DisplayAmount is the formatted amount with currency symbol<br/>For USD: $12.50 |
|
|
26
|
+
| `displayName` | *string* | :heavy_minus_sign: | DisplayName is the name of the price |
|
|
27
|
+
| `displayPriceUnitAmount` | *string* | :heavy_minus_sign: | DisplayPriceUnitAmount is the formatted amount of the price unit |
|
|
28
|
+
| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EndDate is the end date of the price |
|
|
29
|
+
| `entityId` | *string* | :heavy_minus_sign: | EntityID holds the value of the "entity_id" field. |
|
|
30
|
+
| `entityType` | [models.PriceEntityType](../../sdk/models/price-entity-type.md) | :heavy_minus_sign: | N/A |
|
|
31
|
+
| `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the price |
|
|
32
|
+
| `groupId` | *string* | :heavy_minus_sign: | GroupID references the group this price belongs to |
|
|
33
|
+
| `id` | *string* | :heavy_minus_sign: | ID uuid identifier for the price |
|
|
34
|
+
| `invoiceCadence` | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md) | :heavy_minus_sign: | N/A |
|
|
35
|
+
| `lookupKey` | *string* | :heavy_minus_sign: | LookupKey used for looking up the price in the database |
|
|
36
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
37
|
+
| `meterId` | *string* | :heavy_minus_sign: | MeterID is the id of the meter for usage based pricing |
|
|
38
|
+
| `minQuantity` | *string* | :heavy_minus_sign: | MinQuantity is the minimum quantity of the price |
|
|
39
|
+
| `parentPriceId` | *string* | :heavy_minus_sign: | ParentPriceID references the root price (always set for price lineage tracking) |
|
|
40
|
+
| `priceUnit` | *string* | :heavy_minus_sign: | PriceUnit is the code of the price unit (e.g., 'btc', 'eth') |
|
|
41
|
+
| `priceUnitAmount` | *string* | :heavy_minus_sign: | PriceUnitAmount is the amount of the price unit |
|
|
42
|
+
| `priceUnitId` | *string* | :heavy_minus_sign: | PriceUnitID is the id of the price unit (for CUSTOM type) |
|
|
43
|
+
| `priceUnitTiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED |
|
|
44
|
+
| `priceUnitType` | [models.PriceUnitType](../../sdk/models/price-unit-type.md) | :heavy_minus_sign: | N/A |
|
|
45
|
+
| `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 price |
|
|
46
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
47
|
+
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
48
|
+
| `tierMode` | [models.BillingTier](../../sdk/models/billing-tier.md) | :heavy_minus_sign: | N/A |
|
|
49
|
+
| `tiers` | [models.PricePriceTier](../../sdk/models/price-price-tier.md)[] | :heavy_minus_sign: | N/A |
|
|
50
|
+
| `transformQuantity` | [models.PriceJSONBTransformQuantity](../../sdk/models/price-jsonb-transform-quantity.md) | :heavy_minus_sign: | N/A |
|
|
51
|
+
| `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) |
|
|
52
|
+
| `type` | [models.PriceType](../../sdk/models/price-type.md) | :heavy_minus_sign: | N/A |
|
|
53
|
+
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
54
|
+
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|