@flexprice/sdk 2.1.6 → 2.1.10
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 +2 -2
- package/docs/sdk/models/create-subscription-request.md +38 -37
- package/docs/sdk/models/customer-filter.md +1 -0
- package/docs/sdk/models/execute-subscription-modify-request.md +7 -6
- package/docs/sdk/models/export-metadata-entity-type.md +17 -0
- package/docs/sdk/models/export-metadata-field.md +20 -0
- package/docs/sdk/models/grouped-invoicing-action.md +15 -0
- package/docs/sdk/models/invoice-billing-reason.md +2 -2
- package/docs/sdk/models/list-subscription-line-items-response.md +50 -0
- package/docs/sdk/models/plan-filter.md +1 -0
- package/docs/sdk/models/s3-job-config.md +10 -9
- package/docs/sdk/models/scheduled-task-entity-type.md +1 -1
- package/docs/sdk/models/sub-modify-grouped-invoicing-params.md +19 -0
- package/docs/sdk/models/subscription-inheritance-config.md +6 -5
- package/docs/sdk/models/subscription-line-item-filter-order.md +15 -0
- package/docs/sdk/models/subscription-line-item-filter.md +34 -0
- package/docs/sdk/models/subscription-modify-type.md +2 -2
- package/docs/sdk/models/subscription-response-v2.md +1 -0
- package/docs/sdk/models/subscription-response.md +1 -0
- package/docs/sdk/models/subscription-type.md +1 -1
- package/docs/sdks/scheduledtasks/README.md +2 -2
- package/docs/sdks/subscriptions/README.md +74 -2
- package/esm/funcs/subscriptions-query-subscription-line-items.d.ts +17 -0
- package/esm/funcs/subscriptions-query-subscription-line-items.d.ts.map +1 -0
- package/esm/funcs/subscriptions-query-subscription-line-items.js +83 -0
- package/esm/funcs/subscriptions-query-subscription-line-items.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/config.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +11 -0
- 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-filter.d.ts +6 -0
- package/esm/sdk/models/customer-filter.d.ts.map +1 -1
- package/esm/sdk/models/customer-filter.js +1 -0
- package/esm/sdk/models/customer-filter.js.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.d.ts +3 -0
- package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.js +3 -0
- package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
- package/esm/sdk/models/export-metadata-entity-type.d.ts +12 -0
- package/esm/sdk/models/export-metadata-entity-type.d.ts.map +1 -0
- package/esm/sdk/models/export-metadata-entity-type.js +13 -0
- package/esm/sdk/models/export-metadata-entity-type.js.map +1 -0
- package/esm/sdk/models/export-metadata-field.d.ts +28 -0
- package/esm/sdk/models/export-metadata-field.d.ts.map +1 -0
- package/esm/sdk/models/export-metadata-field.js +39 -0
- package/esm/sdk/models/export-metadata-field.js.map +1 -0
- package/esm/sdk/models/grouped-invoicing-action.d.ts +10 -0
- package/esm/sdk/models/grouped-invoicing-action.d.ts.map +1 -0
- package/esm/sdk/models/grouped-invoicing-action.js +11 -0
- package/esm/sdk/models/grouped-invoicing-action.js.map +1 -0
- package/esm/sdk/models/index.d.ts +6 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +6 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.d.ts +2 -0
- package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.js +2 -0
- package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
- package/esm/sdk/models/list-subscription-line-items-response.d.ts +13 -0
- package/esm/sdk/models/list-subscription-line-items-response.d.ts.map +1 -0
- package/esm/sdk/models/list-subscription-line-items-response.js +17 -0
- package/esm/sdk/models/list-subscription-line-items-response.js.map +1 -0
- package/esm/sdk/models/plan-filter.d.ts +6 -0
- package/esm/sdk/models/plan-filter.d.ts.map +1 -1
- package/esm/sdk/models/plan-filter.js +1 -0
- package/esm/sdk/models/plan-filter.js.map +1 -1
- package/esm/sdk/models/s3-job-config.d.ts +7 -1
- package/esm/sdk/models/s3-job-config.d.ts.map +1 -1
- package/esm/sdk/models/s3-job-config.js +5 -0
- package/esm/sdk/models/s3-job-config.js.map +1 -1
- package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
- package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
- package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
- package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts +20 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.js +21 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.js.map +1 -0
- package/esm/sdk/models/subscription-inheritance-config.d.ts +26 -0
- package/esm/sdk/models/subscription-inheritance-config.d.ts.map +1 -1
- package/esm/sdk/models/subscription-inheritance-config.js +2 -0
- package/esm/sdk/models/subscription-inheritance-config.js.map +1 -1
- package/esm/sdk/models/subscription-line-item-entity-type.d.ts +2 -0
- package/esm/sdk/models/subscription-line-item-entity-type.d.ts.map +1 -1
- package/esm/sdk/models/subscription-line-item-entity-type.js +2 -0
- package/esm/sdk/models/subscription-line-item-entity-type.js.map +1 -1
- package/esm/sdk/models/subscription-line-item-filter.d.ts +65 -0
- package/esm/sdk/models/subscription-line-item-filter.d.ts.map +1 -0
- package/esm/sdk/models/subscription-line-item-filter.js +57 -0
- package/esm/sdk/models/subscription-line-item-filter.js.map +1 -0
- package/esm/sdk/models/subscription-modify-type.d.ts +1 -0
- package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
- package/esm/sdk/models/subscription-modify-type.js +1 -0
- package/esm/sdk/models/subscription-modify-type.js.map +1 -1
- package/esm/sdk/models/subscription-response-v2.d.ts +8 -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 +8 -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/subscription-type.d.ts +2 -0
- package/esm/sdk/models/subscription-type.d.ts.map +1 -1
- package/esm/sdk/models/subscription-type.js +2 -0
- package/esm/sdk/models/subscription-type.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +7 -0
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +10 -0
- package/esm/sdk/subscriptions.js.map +1 -1
- package/esm/types/primitives.d.ts +1 -1
- package/esm/types/primitives.d.ts.map +1 -1
- package/esm/types/primitives.js +2 -3
- package/esm/types/primitives.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/subscriptions-query-subscription-line-items.ts +172 -0
- package/src/lib/config.ts +3 -3
- package/src/sdk/models/create-subscription-request.ts +13 -0
- package/src/sdk/models/customer-filter.ts +3 -0
- package/src/sdk/models/execute-subscription-modify-request.ts +13 -0
- package/src/sdk/models/export-metadata-entity-type.ts +26 -0
- package/src/sdk/models/export-metadata-field.ts +88 -0
- package/src/sdk/models/grouped-invoicing-action.ts +17 -0
- package/src/sdk/models/index.ts +6 -0
- package/src/sdk/models/invoice-billing-reason.ts +2 -0
- package/src/sdk/models/list-subscription-line-items-response.ts +41 -0
- package/src/sdk/models/plan-filter.ts +3 -0
- package/src/sdk/models/s3-job-config.ts +20 -1
- package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
- package/src/sdk/models/sub-modify-grouped-invoicing-params.ts +54 -0
- package/src/sdk/models/subscription-inheritance-config.ts +29 -0
- package/src/sdk/models/subscription-line-item-entity-type.ts +5 -0
- package/src/sdk/models/subscription-line-item-filter.ts +140 -0
- package/src/sdk/models/subscription-modify-type.ts +1 -0
- package/src/sdk/models/subscription-response-v2.ts +10 -0
- package/src/sdk/models/subscription-response.ts +10 -0
- package/src/sdk/models/subscription-type.ts +2 -0
- package/src/sdk/subscriptions.ts +18 -0
- package/src/types/primitives.ts +2 -4
package/FUNCTIONS.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Standalone Functions
|
|
2
2
|
|
|
3
3
|
> [!NOTE]
|
|
4
|
-
> This section is useful if you are using a bundler and
|
|
4
|
+
> This section is useful if you are using a bundler and targeting browsers and
|
|
5
5
|
> runtimes where the size of an application affects performance and load times.
|
|
6
6
|
|
|
7
7
|
Every method in this SDK is also available as a standalone function. This
|
|
8
|
-
alternative API is suitable when
|
|
8
|
+
alternative API is suitable when targeting the browser or serverless runtimes
|
|
9
9
|
and using a bundler to build your application since all unused functionality
|
|
10
10
|
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
|
11
11
|
encoding helpers and response handlers. The result is dramatically smaller
|
|
@@ -14,40 +14,41 @@ let value: CreateSubscriptionRequest = {
|
|
|
14
14
|
|
|
15
15
|
## Fields
|
|
16
16
|
|
|
17
|
-
| Field
|
|
18
|
-
|
|
|
19
|
-
| `addons`
|
|
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
|
-
| `
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
49
|
-
| `
|
|
50
|
-
| `
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
17
|
+
| Field | Type | Required | Description |
|
|
18
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
19
|
+
| `addons` | [models.AddAddonToSubscriptionRequest](../../sdk/models/add-addon-to-subscription-request.md)[] | :heavy_minus_sign: | Addons represents addons to be added to the subscription during creation |
|
|
20
|
+
| `autoInvoiceThreshold` | *string* | :heavy_minus_sign: | AutoInvoiceThreshold is the usage amount (in subscription currency) that triggers<br/>an intermediate invoice mid-period. Set once at creation; cannot be changed later.<br/>Allowed only when the subscription resolves to type standalone (no parent hierarchy rows).<br/>Plan line items must be usage-based only (no fixed or other non-usage plan prices).<br/>Nil means auto invoice threshold billing is disabled for this subscription. |
|
|
21
|
+
| `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | BillingAnchor overrides the derived billing anchor when billing_cycle is anniversary.<br/>For monthly billing, the day-of-month (and time-of-day) define cycle boundaries: if start_date<br/>is before that day in the month, the first billing period ends on the next occurrence of that<br/>day in the same month (a shorter first period); subsequent periods follow the usual interval. |
|
|
22
|
+
| `billingCycle` | [models.BillingCycle](../../sdk/models/billing-cycle.md) | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_check_mark: | N/A |
|
|
24
|
+
| `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `collectionMethod` | [models.CollectionMethod](../../sdk/models/collection-method.md) | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `commitmentAmount` | *string* | :heavy_minus_sign: | CommitmentAmount is the minimum amount a customer commits to paying for a billing period |
|
|
27
|
+
| `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `coupons` | *string*[] | :heavy_minus_sign: | N/A |
|
|
29
|
+
| `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | Credit grants to be applied when subscription is created |
|
|
30
|
+
| `currency` | *string* | :heavy_check_mark: | N/A |
|
|
31
|
+
| `customerId` | *string* | :heavy_minus_sign: | customer_id is the flexprice customer id<br/>and it is prioritized over external_customer_id in case both are provided. |
|
|
32
|
+
| `customerTimezone` | *string* | :heavy_minus_sign: | Timezone of the customer.<br/>If not set, the default value is UTC. |
|
|
33
|
+
| `enableTrueUp` | *boolean* | :heavy_minus_sign: | Enable Commitment True Up Fee |
|
|
34
|
+
| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
35
|
+
| `externalCustomerId` | *string* | :heavy_minus_sign: | external_customer_id is the customer id in your DB<br/>and must be same as what you provided as external_id while creating the customer in flexprice. |
|
|
36
|
+
| `gatewayPaymentMethodId` | *string* | :heavy_minus_sign: | N/A |
|
|
37
|
+
| `inheritance` | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md) | :heavy_minus_sign: | N/A |
|
|
38
|
+
| `lineItemCommitments` | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)> | :heavy_minus_sign: | LineItemCommitments allows setting commitment configuration per line item (keyed by price_id) |
|
|
39
|
+
| `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: | N/A |
|
|
40
|
+
| `lineItems` | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[] | :heavy_minus_sign: | LineItems are extra line items to add at creation (each with price_id or price), in addition to plan prices |
|
|
41
|
+
| `lookupKey` | *string* | :heavy_minus_sign: | N/A |
|
|
42
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
43
|
+
| `overageFactor` | *string* | :heavy_minus_sign: | OverageFactor is a multiplier applied to usage beyond the commitment amount |
|
|
44
|
+
| `overrideEntitlements` | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[] | :heavy_minus_sign: | OverrideEntitlements allows customizing specific entitlements for this subscription |
|
|
45
|
+
| `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows customizing specific prices for this subscription |
|
|
46
|
+
| `paymentBehavior` | [models.PaymentBehavior](../../sdk/models/payment-behavior.md) | :heavy_minus_sign: | N/A |
|
|
47
|
+
| `paymentTerms` | [models.PaymentTerms](../../sdk/models/payment-terms.md) | :heavy_minus_sign: | N/A |
|
|
48
|
+
| `phases` | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[] | :heavy_minus_sign: | Phases represents subscription phases to be created with the subscription |
|
|
49
|
+
| `planId` | *string* | :heavy_check_mark: | N/A |
|
|
50
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
51
|
+
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
52
|
+
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
53
|
+
| `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 |
|
|
54
|
+
| `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. |
|
|
@@ -20,6 +20,7 @@ let value: CustomerFilter = {};
|
|
|
20
20
|
| `externalIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
21
21
|
| `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
22
22
|
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
23
24
|
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
|
24
25
|
| `order` | [models.CustomerFilterOrder](../../sdk/models/customer-filter-order.md) | :heavy_minus_sign: | N/A |
|
|
25
26
|
| `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -6,14 +6,15 @@
|
|
|
6
6
|
import { ExecuteSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
8
|
let value: ExecuteSubscriptionModifyRequest = {
|
|
9
|
-
type: "
|
|
9
|
+
type: "grouped_invoicing",
|
|
10
10
|
};
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Fields
|
|
14
14
|
|
|
15
|
-
| Field
|
|
16
|
-
|
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `groupedInvoicingParams` | [models.SubModifyGroupedInvoicingParams](../../sdk/models/sub-modify-grouped-invoicing-params.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ExportMetadataEntityType
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ExportMetadataEntityType } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ExportMetadataEntityType = "wallet";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"customer" | "wallet" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ExportMetadataField
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ExportMetadataField } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ExportMetadataField = {
|
|
9
|
+
entityType: "customer",
|
|
10
|
+
fieldKey: "<value>",
|
|
11
|
+
};
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Description |
|
|
17
|
+
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
18
|
+
| `columnName` | *string* | :heavy_minus_sign: | CSV column header to be shown in the exported file |
|
|
19
|
+
| `entityType` | [models.ExportMetadataEntityType](../../sdk/models/export-metadata-entity-type.md) | :heavy_check_mark: | N/A |
|
|
20
|
+
| `fieldKey` | *string* | :heavy_check_mark: | metadata key to look up |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# GroupedInvoicingAction
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { GroupedInvoicingAction } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: GroupedInvoicingAction = "remove";
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Values
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
"add" | "remove"
|
|
15
|
+
```
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { InvoiceBillingReason } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: InvoiceBillingReason = "
|
|
8
|
+
let value: InvoiceBillingReason = "SUBSCRIPTION_UPDATE";
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Values
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
"SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "PRORATION" | "MANUAL"
|
|
14
|
+
"SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD"
|
|
15
15
|
```
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# ListSubscriptionLineItemsResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ListSubscriptionLineItemsResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ListSubscriptionLineItemsResponse = {
|
|
9
|
+
items: [
|
|
10
|
+
{
|
|
11
|
+
price: {
|
|
12
|
+
addon: {
|
|
13
|
+
prices: [
|
|
14
|
+
{
|
|
15
|
+
addon: {},
|
|
16
|
+
meter: {
|
|
17
|
+
createdAt: new Date("2024-03-20T15:04:05Z"),
|
|
18
|
+
eventName: "api_request",
|
|
19
|
+
id: "550e8400-e29b-41d4-a716-446655440000",
|
|
20
|
+
name: "API Usage Meter",
|
|
21
|
+
status: "published",
|
|
22
|
+
tenantId: "tenant123",
|
|
23
|
+
updatedAt: new Date("2024-03-20T15:04:05Z"),
|
|
24
|
+
},
|
|
25
|
+
plan: {},
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
},
|
|
29
|
+
meter: {
|
|
30
|
+
createdAt: new Date("2024-03-20T15:04:05Z"),
|
|
31
|
+
eventName: "api_request",
|
|
32
|
+
id: "550e8400-e29b-41d4-a716-446655440000",
|
|
33
|
+
name: "API Usage Meter",
|
|
34
|
+
status: "published",
|
|
35
|
+
tenantId: "tenant123",
|
|
36
|
+
updatedAt: new Date("2024-03-20T15:04:05Z"),
|
|
37
|
+
},
|
|
38
|
+
plan: {},
|
|
39
|
+
},
|
|
40
|
+
},
|
|
41
|
+
],
|
|
42
|
+
};
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Fields
|
|
46
|
+
|
|
47
|
+
| Field | Type | Required | Description |
|
|
48
|
+
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
49
|
+
| `items` | [models.SubscriptionLineItemResponse](../../sdk/models/subscription-line-item-response.md)[] | :heavy_minus_sign: | N/A |
|
|
50
|
+
| `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
|
|
@@ -17,6 +17,7 @@ let value: PlanFilter = {};
|
|
|
17
17
|
| `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | filters allows complex filtering based on multiple fields |
|
|
18
18
|
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
19
19
|
| `lookupKey` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
|
21
22
|
| `order` | [models.PlanFilterOrder](../../sdk/models/plan-filter-order.md) | :heavy_minus_sign: | N/A |
|
|
22
23
|
| `planIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
@@ -10,12 +10,13 @@ let value: S3JobConfig = {};
|
|
|
10
10
|
|
|
11
11
|
## Fields
|
|
12
12
|
|
|
13
|
-
| Field
|
|
14
|
-
|
|
|
15
|
-
| `bucket`
|
|
16
|
-
| `compression`
|
|
17
|
-
| `encryption`
|
|
18
|
-
| `endpointUrl`
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
|
15
|
+
| `bucket` | *string* | :heavy_minus_sign: | S3 bucket name |
|
|
16
|
+
| `compression` | [models.S3CompressionType](../../sdk/models/s3-compression-type.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `encryption` | [models.S3EncryptionType](../../sdk/models/s3-encryption-type.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `endpointUrl` | *string* | :heavy_minus_sign: | Custom S3 endpoint URL (e.g., "http://minio:9000" for MinIO) |
|
|
19
|
+
| `exportMetadataFields` | [models.ExportMetadataField](../../sdk/models/export-metadata-field.md)[] | :heavy_minus_sign: | Optional user-selected metadata columns |
|
|
20
|
+
| `keyPrefix` | *string* | :heavy_minus_sign: | Optional prefix for S3 keys (e.g., "flexprice-exports/") |
|
|
21
|
+
| `region` | *string* | :heavy_minus_sign: | AWS region (e.g., "us-west-2") |
|
|
22
|
+
| `usePathStyle` | *boolean* | :heavy_minus_sign: | Use path-style addressing (required for MinIO) |
|
|
@@ -13,5 +13,5 @@ let value: ScheduledTaskEntityType = "invoice";
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"events" | "invoice" | "credit_topups" | "credit_usage" | Unrecognized<string>
|
|
16
|
+
"events" | "invoice" | "credit_topups" | "credit_usage" | "usage_analytics" | Unrecognized<string>
|
|
17
17
|
```
|