@flexprice/sdk 2.1.1 → 2.1.3
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/billing-cadence.md +1 -3
- package/docs/sdk/models/billing-period.md +1 -1
- package/docs/sdk/models/changed-invoice-action.md +19 -0
- package/docs/sdk/models/changed-invoice-status.md +19 -0
- package/docs/sdk/models/changed-invoice.md +30 -0
- package/docs/sdk/models/changed-line-item-action.md +19 -0
- package/docs/sdk/models/changed-line-item.md +20 -0
- package/docs/sdk/models/changed-resources.md +32 -0
- package/docs/sdk/models/changed-subscription-action.md +19 -0
- package/docs/sdk/models/changed-subscription.md +17 -0
- package/docs/sdk/models/clone-environment-request-request.md +19 -0
- package/docs/sdk/models/clone-environment-request.md +17 -0
- package/docs/sdk/models/clone-feature-request-request.md +19 -0
- package/docs/sdk/models/clone-feature-request.md +18 -0
- package/docs/sdk/models/{post-plans-id-clone-request.md → clone-plan-request-request.md} +3 -3
- package/docs/sdk/models/create-price-request.md +7 -9
- package/docs/sdk/models/create-subscription-request.md +40 -41
- package/docs/sdk/models/environment-type.md +15 -0
- package/docs/sdk/models/execute-subscription-change-request.md +2 -2
- package/docs/sdk/models/execute-subscription-modify-request-request.md +21 -0
- package/docs/sdk/models/execute-subscription-modify-request.md +6 -6
- package/docs/sdk/models/invoice-filter.md +1 -0
- package/docs/sdk/models/invoice-response.md +1 -0
- package/docs/sdk/models/line-item-quantity-change.md +20 -0
- package/docs/sdk/models/meter-usage-analytics-request.md +30 -0
- package/docs/sdk/models/meter-usage-analytics-response.md +30 -0
- package/docs/sdk/models/meter-usage-point.md +21 -0
- package/docs/sdk/models/meter-usage-query-request.md +28 -0
- package/docs/sdk/models/meter-usage-query-response.md +30 -0
- package/docs/sdk/models/preview-subscription-change-request.md +2 -2
- package/docs/sdk/models/preview-subscription-modify-request.md +21 -0
- package/docs/sdk/models/secret-provider.md +2 -2
- package/docs/sdk/models/{execute-subscription-inheritance-request.md → sub-modify-inheritance-request.md} +3 -3
- package/docs/sdk/models/sub-modify-quantity-change-request.md +22 -0
- package/docs/sdk/models/subscription-change-request.md +1 -1
- package/docs/sdk/models/subscription-modify-response.md +41 -0
- package/docs/sdk/models/subscription-modify-type.md +15 -0
- package/docs/sdk/models/subscription-phase-create-request.md +9 -8
- package/docs/sdk/models/subscription-price-create-request.md +3 -5
- package/docs/sdks/environments/README.md +79 -0
- package/docs/sdks/features/README.md +73 -0
- package/docs/sdks/invoices/README.md +76 -0
- package/docs/sdks/meterusage/README.md +182 -0
- package/docs/sdks/plans/README.md +7 -7
- package/docs/sdks/prices/README.md +12 -14
- package/docs/sdks/subscriptions/README.md +101 -22
- package/esm/funcs/environments-clone-environment.d.ts +17 -0
- package/esm/funcs/environments-clone-environment.d.ts.map +1 -0
- package/esm/funcs/environments-clone-environment.js +92 -0
- package/esm/funcs/environments-clone-environment.js.map +1 -0
- package/esm/funcs/features-clone-feature.d.ts +17 -0
- package/esm/funcs/features-clone-feature.d.ts.map +1 -0
- package/esm/funcs/features-clone-feature.js +92 -0
- package/esm/funcs/features-clone-feature.js.map +1 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.d.ts +17 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.d.ts.map +1 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.js +82 -0
- package/esm/funcs/invoices-get-meter-usage-preview-invoice.js.map +1 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.d.ts +17 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.d.ts.map +1 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.js +82 -0
- package/esm/funcs/meter-usage-get-meter-usage-analytics.js.map +1 -0
- package/esm/funcs/meter-usage-query-meter-usage.d.ts +17 -0
- package/esm/funcs/meter-usage-query-meter-usage.d.ts.map +1 -0
- package/esm/funcs/meter-usage-query-meter-usage.js +82 -0
- package/esm/funcs/meter-usage-query-meter-usage.js.map +1 -0
- package/esm/funcs/{plans-post-plans-id-clone.d.ts → plans-clone-plan.d.ts} +2 -2
- package/esm/funcs/plans-clone-plan.d.ts.map +1 -0
- package/esm/funcs/{plans-post-plans-id-clone.js → plans-clone-plan.js} +4 -4
- package/esm/funcs/plans-clone-plan.js.map +1 -0
- package/esm/funcs/subscriptions-execute-subscription-modify.d.ts +3 -3
- package/esm/funcs/subscriptions-execute-subscription-modify.d.ts.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-modify.js +4 -4
- package/esm/funcs/subscriptions-execute-subscription-modify.js.map +1 -1
- package/esm/funcs/subscriptions-preview-subscription-modify.d.ts +17 -0
- package/esm/funcs/subscriptions-preview-subscription-modify.d.ts.map +1 -0
- package/esm/funcs/subscriptions-preview-subscription-modify.js +92 -0
- package/esm/funcs/subscriptions-preview-subscription-modify.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/lib/encodings.d.ts +1 -0
- package/esm/lib/encodings.d.ts.map +1 -1
- package/esm/lib/encodings.js +6 -0
- package/esm/lib/encodings.js.map +1 -1
- package/esm/sdk/environments.d.ts +12 -0
- package/esm/sdk/environments.d.ts.map +1 -0
- package/esm/sdk/environments.js +18 -0
- package/esm/sdk/environments.js.map +1 -0
- package/esm/sdk/features.d.ts +7 -0
- package/esm/sdk/features.d.ts.map +1 -1
- package/esm/sdk/features.js +10 -0
- package/esm/sdk/features.js.map +1 -1
- package/esm/sdk/invoices.d.ts +7 -0
- package/esm/sdk/invoices.d.ts.map +1 -1
- package/esm/sdk/invoices.js +10 -0
- package/esm/sdk/invoices.js.map +1 -1
- package/esm/sdk/meter-usage.d.ts +19 -0
- package/esm/sdk/meter-usage.d.ts.map +1 -0
- package/esm/sdk/meter-usage.js +28 -0
- package/esm/sdk/meter-usage.js.map +1 -0
- package/esm/sdk/models/billing-cadence.d.ts +4 -5
- package/esm/sdk/models/billing-cadence.d.ts.map +1 -1
- package/esm/sdk/models/billing-cadence.js +3 -4
- package/esm/sdk/models/billing-cadence.js.map +1 -1
- package/esm/sdk/models/billing-period.d.ts +1 -0
- package/esm/sdk/models/billing-period.d.ts.map +1 -1
- package/esm/sdk/models/billing-period.js +1 -0
- package/esm/sdk/models/billing-period.js.map +1 -1
- package/esm/sdk/models/changed-invoice-action.d.ts +16 -0
- package/esm/sdk/models/changed-invoice-action.d.ts.map +1 -0
- package/esm/sdk/models/changed-invoice-action.js +14 -0
- package/esm/sdk/models/changed-invoice-action.js.map +1 -0
- package/esm/sdk/models/changed-invoice-status.d.ts +16 -0
- package/esm/sdk/models/changed-invoice-status.d.ts.map +1 -0
- package/esm/sdk/models/changed-invoice-status.js +14 -0
- package/esm/sdk/models/changed-invoice-status.js.map +1 -0
- package/esm/sdk/models/changed-invoice.d.ts +24 -0
- package/esm/sdk/models/changed-invoice.d.ts.map +1 -0
- package/esm/sdk/models/changed-invoice.js +27 -0
- package/esm/sdk/models/changed-invoice.js.map +1 -0
- package/esm/sdk/models/changed-line-item-action.d.ts +17 -0
- package/esm/sdk/models/changed-line-item-action.d.ts.map +1 -0
- package/esm/sdk/models/changed-line-item-action.js +15 -0
- package/esm/sdk/models/changed-line-item-action.js.map +1 -0
- package/esm/sdk/models/changed-line-item.d.ts +19 -0
- package/esm/sdk/models/changed-line-item.d.ts.map +1 -0
- package/esm/sdk/models/changed-line-item.js +28 -0
- package/esm/sdk/models/changed-line-item.js.map +1 -0
- package/esm/sdk/models/changed-resources.d.ts +15 -0
- package/esm/sdk/models/changed-resources.d.ts.map +1 -0
- package/esm/sdk/models/changed-resources.js +24 -0
- package/esm/sdk/models/changed-resources.js.map +1 -0
- package/esm/sdk/models/changed-subscription-action.d.ts +16 -0
- package/esm/sdk/models/changed-subscription-action.d.ts.map +1 -0
- package/esm/sdk/models/changed-subscription-action.js +14 -0
- package/esm/sdk/models/changed-subscription-action.js.map +1 -0
- package/esm/sdk/models/changed-subscription.d.ts +17 -0
- package/esm/sdk/models/changed-subscription.d.ts.map +1 -0
- package/esm/sdk/models/changed-subscription.js +18 -0
- package/esm/sdk/models/changed-subscription.js.map +1 -0
- package/esm/sdk/models/clone-environment-op.d.ts +21 -0
- package/esm/sdk/models/clone-environment-op.d.ts.map +1 -0
- package/esm/sdk/models/clone-environment-op.js +14 -0
- package/esm/sdk/models/clone-environment-op.js.map +1 -0
- package/esm/sdk/models/clone-environment-request.d.ts +26 -0
- package/esm/sdk/models/clone-environment-request.d.ts.map +1 -0
- package/esm/sdk/models/clone-environment-request.js +20 -0
- package/esm/sdk/models/clone-environment-request.js.map +1 -0
- package/esm/sdk/models/clone-feature-op.d.ts +21 -0
- package/esm/sdk/models/clone-feature-op.d.ts.map +1 -0
- package/esm/sdk/models/clone-feature-op.js +14 -0
- package/esm/sdk/models/clone-feature-op.js.map +1 -0
- package/esm/sdk/models/clone-feature-request.d.ts +31 -0
- package/esm/sdk/models/clone-feature-request.d.ts.map +1 -0
- package/esm/sdk/models/clone-feature-request.js +20 -0
- package/esm/sdk/models/clone-feature-request.js.map +1 -0
- package/esm/sdk/models/clone-plan-op.d.ts +21 -0
- package/esm/sdk/models/clone-plan-op.d.ts.map +1 -0
- package/esm/sdk/models/{post-plans-id-clone-op.js → clone-plan-op.js} +4 -4
- package/esm/sdk/models/clone-plan-op.js.map +1 -0
- package/esm/sdk/models/create-price-request.d.ts +0 -3
- package/esm/sdk/models/create-price-request.d.ts.map +1 -1
- package/esm/sdk/models/create-price-request.js +0 -3
- package/esm/sdk/models/create-price-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +10 -3
- package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-request.js +2 -3
- package/esm/sdk/models/create-subscription-request.js.map +1 -1
- package/esm/sdk/models/environment-type.d.ts +10 -0
- package/esm/sdk/models/environment-type.d.ts.map +1 -0
- package/esm/sdk/models/environment-type.js +11 -0
- package/esm/sdk/models/environment-type.js.map +1 -0
- package/esm/sdk/models/execute-subscription-modify-op.d.ts +8 -8
- package/esm/sdk/models/execute-subscription-modify-op.d.ts.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-op.js +5 -5
- package/esm/sdk/models/execute-subscription-modify-op.js.map +1 -1
- package/esm/sdk/models/execute-subscription-modify-request.d.ts +19 -0
- package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -0
- package/esm/sdk/models/execute-subscription-modify-request.js +23 -0
- package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -0
- package/esm/sdk/models/index.d.ts +26 -2
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +26 -2
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-filter.d.ts +5 -0
- package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
- package/esm/sdk/models/invoice-filter.js +2 -0
- package/esm/sdk/models/invoice-filter.js.map +1 -1
- package/esm/sdk/models/invoice-response.d.ts +7 -0
- package/esm/sdk/models/invoice-response.d.ts.map +1 -1
- package/esm/sdk/models/invoice-response.js +2 -0
- package/esm/sdk/models/invoice-response.js.map +1 -1
- package/esm/sdk/models/line-item-quantity-change.d.ts +22 -0
- package/esm/sdk/models/line-item-quantity-change.d.ts.map +1 -0
- package/esm/sdk/models/line-item-quantity-change.js +19 -0
- package/esm/sdk/models/line-item-quantity-change.js.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-request.d.ts +26 -0
- package/esm/sdk/models/meter-usage-analytics-request.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-request.js +31 -0
- package/esm/sdk/models/meter-usage-analytics-request.js.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-response.d.ts +11 -0
- package/esm/sdk/models/meter-usage-analytics-response.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-analytics-response.js +15 -0
- package/esm/sdk/models/meter-usage-analytics-response.js.map +1 -0
- package/esm/sdk/models/meter-usage-point.d.ts +12 -0
- package/esm/sdk/models/meter-usage-point.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-point.js +21 -0
- package/esm/sdk/models/meter-usage-point.js.map +1 -0
- package/esm/sdk/models/meter-usage-query-request.d.ts +26 -0
- package/esm/sdk/models/meter-usage-query-request.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-query-request.js +31 -0
- package/esm/sdk/models/meter-usage-query-request.js.map +1 -0
- package/esm/sdk/models/meter-usage-query-response.d.ts +16 -0
- package/esm/sdk/models/meter-usage-query-response.d.ts.map +1 -0
- package/esm/sdk/models/meter-usage-query-response.js +28 -0
- package/esm/sdk/models/meter-usage-query-response.js.map +1 -0
- package/esm/sdk/models/preview-subscription-modify-op.d.ts +21 -0
- package/esm/sdk/models/preview-subscription-modify-op.d.ts.map +1 -0
- package/esm/sdk/models/preview-subscription-modify-op.js +14 -0
- package/esm/sdk/models/preview-subscription-modify-op.js.map +1 -0
- package/esm/sdk/models/secret-provider.d.ts +1 -0
- package/esm/sdk/models/secret-provider.d.ts.map +1 -1
- package/esm/sdk/models/secret-provider.js +1 -0
- package/esm/sdk/models/secret-provider.js.map +1 -1
- package/esm/sdk/models/sub-modify-inheritance-request.d.ts +12 -0
- package/esm/sdk/models/sub-modify-inheritance-request.d.ts.map +1 -0
- package/esm/sdk/models/{execute-subscription-inheritance-request.js → sub-modify-inheritance-request.js} +4 -4
- package/esm/sdk/models/sub-modify-inheritance-request.js.map +1 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.d.ts +13 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.d.ts.map +1 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.js +18 -0
- package/esm/sdk/models/sub-modify-quantity-change-request.js.map +1 -0
- package/esm/sdk/models/subscription-modify-response.d.ts +13 -0
- package/esm/sdk/models/subscription-modify-response.d.ts.map +1 -0
- package/esm/sdk/models/subscription-modify-response.js +22 -0
- package/esm/sdk/models/subscription-modify-response.js.map +1 -0
- package/esm/sdk/models/subscription-modify-type.d.ts +10 -0
- package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -0
- package/esm/sdk/models/subscription-modify-type.js +11 -0
- package/esm/sdk/models/subscription-modify-type.js.map +1 -0
- package/esm/sdk/models/subscription-phase-create-request.d.ts +9 -0
- package/esm/sdk/models/subscription-phase-create-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-phase-create-request.js +3 -0
- package/esm/sdk/models/subscription-phase-create-request.js.map +1 -1
- package/esm/sdk/models/subscription-price-create-request.d.ts +0 -3
- package/esm/sdk/models/subscription-price-create-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-price-create-request.js +0 -3
- package/esm/sdk/models/subscription-price-create-request.js.map +1 -1
- package/esm/sdk/plans.d.ts +1 -1
- package/esm/sdk/plans.d.ts.map +1 -1
- package/esm/sdk/plans.js +3 -3
- package/esm/sdk/plans.js.map +1 -1
- package/esm/sdk/sdk.d.ts +6 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +10 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +10 -3
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +12 -2
- package/esm/sdk/subscriptions.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +3 -3
- package/src/funcs/environments-clone-environment.ts +185 -0
- package/src/funcs/features-clone-feature.ts +184 -0
- package/src/funcs/invoices-get-meter-usage-preview-invoice.ts +170 -0
- package/src/funcs/meter-usage-get-meter-usage-analytics.ts +170 -0
- package/src/funcs/meter-usage-query-meter-usage.ts +170 -0
- package/src/funcs/{plans-post-plans-id-clone.ts → plans-clone-plan.ts} +4 -4
- package/src/funcs/subscriptions-execute-subscription-modify.ts +13 -10
- package/src/funcs/subscriptions-preview-subscription-modify.ts +185 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/encodings.ts +9 -0
- package/src/sdk/environments.ts +29 -0
- package/src/sdk/features.ts +20 -0
- package/src/sdk/invoices.ts +18 -0
- package/src/sdk/meter-usage.ts +45 -0
- package/src/sdk/models/billing-cadence.ts +8 -12
- package/src/sdk/models/billing-period.ts +1 -0
- package/src/sdk/models/changed-invoice-action.ts +25 -0
- package/src/sdk/models/changed-invoice-status.ts +25 -0
- package/src/sdk/models/changed-invoice.ts +69 -0
- package/src/sdk/models/changed-line-item-action.ts +26 -0
- package/src/sdk/models/changed-line-item.ts +59 -0
- package/src/sdk/models/changed-resources.ts +55 -0
- package/src/sdk/models/changed-subscription-action.ts +27 -0
- package/src/sdk/models/changed-subscription.ts +46 -0
- package/src/sdk/models/clone-environment-op.ts +46 -0
- package/src/sdk/models/clone-environment-request.ts +57 -0
- package/src/sdk/models/clone-feature-op.ts +44 -0
- package/src/sdk/models/clone-feature-request.ts +56 -0
- package/src/sdk/models/{post-plans-id-clone-op.ts → clone-plan-op.ts} +8 -8
- package/src/sdk/models/create-price-request.ts +0 -8
- package/src/sdk/models/create-subscription-request.ts +14 -8
- package/src/sdk/models/environment-type.ts +17 -0
- package/src/sdk/models/execute-subscription-modify-op.ts +22 -20
- package/src/sdk/models/execute-subscription-modify-request.ts +63 -0
- package/src/sdk/models/index.ts +26 -2
- package/src/sdk/models/invoice-filter.ts +7 -0
- package/src/sdk/models/invoice-response.ts +9 -0
- package/src/sdk/models/line-item-quantity-change.ts +52 -0
- package/src/sdk/models/meter-usage-analytics-request.ts +69 -0
- package/src/sdk/models/meter-usage-analytics-response.ts +35 -0
- package/src/sdk/models/meter-usage-point.ts +43 -0
- package/src/sdk/models/meter-usage-query-request.ts +69 -0
- package/src/sdk/models/meter-usage-query-response.ts +58 -0
- package/src/sdk/models/preview-subscription-modify-op.ts +46 -0
- package/src/sdk/models/secret-provider.ts +1 -0
- package/src/sdk/models/sub-modify-inheritance-request.ts +41 -0
- package/src/sdk/models/sub-modify-quantity-change-request.ts +45 -0
- package/src/sdk/models/subscription-modify-response.ts +49 -0
- package/src/sdk/models/subscription-modify-type.ts +17 -0
- package/src/sdk/models/subscription-phase-create-request.ts +17 -0
- package/src/sdk/models/subscription-price-create-request.ts +0 -8
- package/src/sdk/plans.ts +3 -3
- package/src/sdk/sdk.ts +12 -0
- package/src/sdk/subscriptions.ts +24 -4
- package/esm/funcs/plans-post-plans-id-clone.d.ts.map +0 -1
- package/esm/funcs/plans-post-plans-id-clone.js.map +0 -1
- package/esm/sdk/models/execute-subscription-inheritance-request.d.ts +0 -12
- package/esm/sdk/models/execute-subscription-inheritance-request.d.ts.map +0 -1
- package/esm/sdk/models/execute-subscription-inheritance-request.js.map +0 -1
- package/esm/sdk/models/post-plans-id-clone-op.d.ts +0 -21
- package/esm/sdk/models/post-plans-id-clone-op.d.ts.map +0 -1
- package/esm/sdk/models/post-plans-id-clone-op.js.map +0 -1
- package/src/sdk/models/execute-subscription-inheritance-request.ts +0 -42
|
@@ -6,50 +6,49 @@
|
|
|
6
6
|
import { CreateSubscriptionRequest } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
8
|
let value: CreateSubscriptionRequest = {
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
currency: "Zimbabwe Dollar",
|
|
9
|
+
billingPeriod: "ONETIME",
|
|
10
|
+
currency: "East Caribbean Dollar",
|
|
12
11
|
planId: "<id>",
|
|
13
12
|
};
|
|
14
13
|
```
|
|
15
14
|
|
|
16
15
|
## Fields
|
|
17
16
|
|
|
18
|
-
| Field
|
|
19
|
-
|
|
|
20
|
-
| `addons`
|
|
21
|
-
| `
|
|
22
|
-
| `billingCycle`
|
|
23
|
-
| `billingPeriod`
|
|
24
|
-
| `billingPeriodCount`
|
|
25
|
-
| `collectionMethod`
|
|
26
|
-
| `commitmentAmount`
|
|
27
|
-
| `commitmentDuration`
|
|
28
|
-
| `coupons`
|
|
29
|
-
| `creditGrants`
|
|
30
|
-
| `currency`
|
|
31
|
-
| `customerId`
|
|
32
|
-
| `customerTimezone`
|
|
33
|
-
| `enableTrueUp`
|
|
34
|
-
| `endDate`
|
|
35
|
-
| `externalCustomerId`
|
|
36
|
-
| `gatewayPaymentMethodId`
|
|
37
|
-
| `inheritance`
|
|
38
|
-
| `lineItemCommitments`
|
|
39
|
-
| `lineItemCoupons`
|
|
40
|
-
| `lineItems`
|
|
41
|
-
| `lookupKey`
|
|
42
|
-
| `metadata`
|
|
43
|
-
| `overageFactor`
|
|
44
|
-
| `overrideEntitlements`
|
|
45
|
-
| `overrideLineItems`
|
|
46
|
-
| `paymentBehavior`
|
|
47
|
-
| `paymentTerms`
|
|
48
|
-
| `phases`
|
|
49
|
-
| `planId`
|
|
50
|
-
| `prorationBehavior`
|
|
51
|
-
| `startDate`
|
|
52
|
-
| `subscriptionStatus`
|
|
53
|
-
| `taxRateOverrides`
|
|
54
|
-
| `trialEnd`
|
|
55
|
-
| `trialStart`
|
|
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
|
+
| `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. |
|
|
21
|
+
| `billingCycle` | [models.BillingCycle](../../sdk/models/billing-cycle.md) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_check_mark: | N/A |
|
|
23
|
+
| `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `collectionMethod` | [models.CollectionMethod](../../sdk/models/collection-method.md) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `commitmentAmount` | *string* | :heavy_minus_sign: | CommitmentAmount is the minimum amount a customer commits to paying for a billing period |
|
|
26
|
+
| `commitmentDuration` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `coupons` | *string*[] | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `creditGrants` | [models.CreateCreditGrantRequest](../../sdk/models/create-credit-grant-request.md)[] | :heavy_minus_sign: | Credit grants to be applied when subscription is created |
|
|
29
|
+
| `currency` | *string* | :heavy_check_mark: | N/A |
|
|
30
|
+
| `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. |
|
|
31
|
+
| `customerTimezone` | *string* | :heavy_minus_sign: | Timezone of the customer.<br/>If not set, the default value is UTC. |
|
|
32
|
+
| `enableTrueUp` | *boolean* | :heavy_minus_sign: | Enable Commitment True Up Fee |
|
|
33
|
+
| `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
34
|
+
| `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. |
|
|
35
|
+
| `gatewayPaymentMethodId` | *string* | :heavy_minus_sign: | N/A |
|
|
36
|
+
| `inheritance` | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md) | :heavy_minus_sign: | N/A |
|
|
37
|
+
| `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) |
|
|
38
|
+
| `lineItemCoupons` | Record<string, *string*[]> | :heavy_minus_sign: | N/A |
|
|
39
|
+
| `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 |
|
|
40
|
+
| `lookupKey` | *string* | :heavy_minus_sign: | N/A |
|
|
41
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
42
|
+
| `overageFactor` | *string* | :heavy_minus_sign: | OverageFactor is a multiplier applied to usage beyond the commitment amount |
|
|
43
|
+
| `overrideEntitlements` | [models.OverrideEntitlementRequest](../../sdk/models/override-entitlement-request.md)[] | :heavy_minus_sign: | OverrideEntitlements allows customizing specific entitlements for this subscription |
|
|
44
|
+
| `overrideLineItems` | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[] | :heavy_minus_sign: | OverrideLineItems allows customizing specific prices for this subscription |
|
|
45
|
+
| `paymentBehavior` | [models.PaymentBehavior](../../sdk/models/payment-behavior.md) | :heavy_minus_sign: | N/A |
|
|
46
|
+
| `paymentTerms` | [models.PaymentTerms](../../sdk/models/payment-terms.md) | :heavy_minus_sign: | N/A |
|
|
47
|
+
| `phases` | [models.SubscriptionPhaseCreateRequest](../../sdk/models/subscription-phase-create-request.md)[] | :heavy_minus_sign: | Phases represents subscription phases to be created with the subscription |
|
|
48
|
+
| `planId` | *string* | :heavy_check_mark: | N/A |
|
|
49
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
|
|
50
|
+
| `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
51
|
+
| `subscriptionStatus` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
|
|
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
|
+
| `trialEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
54
|
+
| `trialStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
@@ -10,8 +10,8 @@ let value: ExecuteSubscriptionChangeRequest = {
|
|
|
10
10
|
body: {
|
|
11
11
|
billingCadence: "RECURRING",
|
|
12
12
|
billingCycle: "anniversary",
|
|
13
|
-
billingPeriod: "
|
|
14
|
-
prorationBehavior: "
|
|
13
|
+
billingPeriod: "WEEKLY",
|
|
14
|
+
prorationBehavior: "none",
|
|
15
15
|
targetPlanId: "<id>",
|
|
16
16
|
},
|
|
17
17
|
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ExecuteSubscriptionModifyRequestRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { ExecuteSubscriptionModifyRequestRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: ExecuteSubscriptionModifyRequestRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
body: {
|
|
11
|
+
type: "quantity_change",
|
|
12
|
+
},
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Fields
|
|
17
|
+
|
|
18
|
+
| Field | Type | Required | Description |
|
|
19
|
+
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
20
|
+
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
21
|
+
| `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification request |
|
|
@@ -6,14 +6,14 @@
|
|
|
6
6
|
import { ExecuteSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
8
|
let value: ExecuteSubscriptionModifyRequest = {
|
|
9
|
-
|
|
10
|
-
body: {},
|
|
9
|
+
type: "quantity_change",
|
|
11
10
|
};
|
|
12
11
|
```
|
|
13
12
|
|
|
14
13
|
## Fields
|
|
15
14
|
|
|
16
|
-
| Field
|
|
17
|
-
|
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
15
|
+
| Field | Type | Required | Description |
|
|
16
|
+
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
17
|
+
| `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
|
|
@@ -34,4 +34,5 @@ let value: InvoiceFilter = {};
|
|
|
34
34
|
| `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
35
35
|
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
36
36
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
37
|
+
| `subscriptionCustomerId` | *string*[] | :heavy_minus_sign: | subscription_customer_id filters invoices by the subscription owner's customer ID |
|
|
37
38
|
| `subscriptionId` | *string* | :heavy_minus_sign: | subscription_id filters invoices generated for a specific subscription<br/>Only returns invoices that were created as part of the specified subscription's billing |
|
|
@@ -56,6 +56,7 @@ let value: InvoiceResponse = {
|
|
|
56
56
|
| `refundedAmount` | *string* | :heavy_minus_sign: | refunded_amount is the total sum of credit notes of type "refund".<br/>These are actual refunds issued to the customer. |
|
|
57
57
|
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
58
58
|
| `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
|
|
59
|
+
| `subscriptionCustomerId` | *string* | :heavy_minus_sign: | subscription_customer_id is the subscription owner's customer ID (Subscription.CustomerID).<br/>It may differ from customer_id when the subscription uses an invoicing customer. Set internally; nullable in DB. |
|
|
59
60
|
| `subscriptionId` | *string* | :heavy_minus_sign: | subscription_id is the ID of the subscription this invoice is associated with (only present for subscription-based invoices) |
|
|
60
61
|
| `subtotal` | *string* | :heavy_minus_sign: | subtotal is the sum of all line items before any taxes, discounts, or additional fees |
|
|
61
62
|
| `taxes` | [models.TaxAppliedResponse](../../sdk/models/tax-applied-response.md)[] | :heavy_minus_sign: | tax_applied_records contains the tax applied records associated with this invoice |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LineItemQuantityChange
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { LineItemQuantityChange } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: LineItemQuantityChange = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
quantity: "<value>",
|
|
11
|
+
};
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Description |
|
|
17
|
+
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
18
|
+
| `effectiveDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EffectiveDate is when the quantity change takes effect.<br/>If omitted, the change is effective immediately (now). |
|
|
19
|
+
| `id` | *string* | :heavy_check_mark: | N/A |
|
|
20
|
+
| `quantity` | *string* | :heavy_check_mark: | N/A |
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# MeterUsageAnalyticsRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { MeterUsageAnalyticsRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: MeterUsageAnalyticsRequest = {
|
|
9
|
+
aggregationType: "SUM",
|
|
10
|
+
endTime: new Date("2024-02-01T00:00:00Z"),
|
|
11
|
+
externalCustomerId: "cust_123",
|
|
12
|
+
meterIds: [
|
|
13
|
+
"mtr_abc",
|
|
14
|
+
"mtr_def",
|
|
15
|
+
],
|
|
16
|
+
startTime: new Date("2024-01-01T00:00:00Z"),
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Fields
|
|
21
|
+
|
|
22
|
+
| Field | Type | Required | Description | Example |
|
|
23
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
24
|
+
| `aggregationType` | [models.AggregationType](../../sdk/models/aggregation-type.md) | :heavy_check_mark: | N/A | |
|
|
25
|
+
| `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | |
|
|
26
|
+
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-02-01T00:00:00Z |
|
|
27
|
+
| `externalCustomerId` | *string* | :heavy_check_mark: | N/A | cust_123 |
|
|
28
|
+
| `meterIds` | *string*[] | :heavy_check_mark: | N/A | [<br/>"mtr_abc",<br/>"mtr_def"<br/>] |
|
|
29
|
+
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-01-01T00:00:00Z |
|
|
30
|
+
| `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A | |
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# MeterUsageAnalyticsResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { MeterUsageAnalyticsResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: MeterUsageAnalyticsResponse = {
|
|
9
|
+
items: [
|
|
10
|
+
{
|
|
11
|
+
eventCount: 42,
|
|
12
|
+
meterId: "mtr_abc",
|
|
13
|
+
points: [
|
|
14
|
+
{
|
|
15
|
+
eventCount: 10,
|
|
16
|
+
timestamp: "2024-01-01T00:00:00Z",
|
|
17
|
+
value: "100.0000",
|
|
18
|
+
},
|
|
19
|
+
],
|
|
20
|
+
totalValue: "1234.5678",
|
|
21
|
+
},
|
|
22
|
+
],
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Fields
|
|
27
|
+
|
|
28
|
+
| Field | Type | Required | Description |
|
|
29
|
+
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
30
|
+
| `items` | [models.MeterUsageQueryResponse](../../sdk/models/meter-usage-query-response.md)[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# MeterUsagePoint
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { MeterUsagePoint } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: MeterUsagePoint = {
|
|
9
|
+
eventCount: 10,
|
|
10
|
+
timestamp: "2024-01-01T00:00:00Z",
|
|
11
|
+
value: "100.0000",
|
|
12
|
+
};
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Description | Example |
|
|
18
|
+
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
|
19
|
+
| `eventCount` | *number* | :heavy_minus_sign: | N/A | 10 |
|
|
20
|
+
| `timestamp` | *string* | :heavy_minus_sign: | N/A | 2024-01-01T00:00:00Z |
|
|
21
|
+
| `value` | *string* | :heavy_minus_sign: | N/A | 100.0000 |
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MeterUsageQueryRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { MeterUsageQueryRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: MeterUsageQueryRequest = {
|
|
9
|
+
aggregationType: "MAX",
|
|
10
|
+
billingAnchor: new Date("2024-01-15T00:00:00Z"),
|
|
11
|
+
endTime: new Date("2024-02-01T00:00:00Z"),
|
|
12
|
+
externalCustomerId: "cust_123",
|
|
13
|
+
meterId: "mtr_abc",
|
|
14
|
+
startTime: new Date("2024-01-01T00:00:00Z"),
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Fields
|
|
19
|
+
|
|
20
|
+
| Field | Type | Required | Description | Example |
|
|
21
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
22
|
+
| `aggregationType` | [models.AggregationType](../../sdk/models/aggregation-type.md) | :heavy_check_mark: | N/A | |
|
|
23
|
+
| `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2024-01-15T00:00:00Z |
|
|
24
|
+
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-02-01T00:00:00Z |
|
|
25
|
+
| `externalCustomerId` | *string* | :heavy_check_mark: | N/A | cust_123 |
|
|
26
|
+
| `meterId` | *string* | :heavy_check_mark: | N/A | mtr_abc |
|
|
27
|
+
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-01-01T00:00:00Z |
|
|
28
|
+
| `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A | |
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# MeterUsageQueryResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { MeterUsageQueryResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: MeterUsageQueryResponse = {
|
|
9
|
+
eventCount: 42,
|
|
10
|
+
meterId: "mtr_abc",
|
|
11
|
+
points: [
|
|
12
|
+
{
|
|
13
|
+
eventCount: 10,
|
|
14
|
+
timestamp: "2024-01-01T00:00:00Z",
|
|
15
|
+
value: "100.0000",
|
|
16
|
+
},
|
|
17
|
+
],
|
|
18
|
+
totalValue: "1234.5678",
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Fields
|
|
23
|
+
|
|
24
|
+
| Field | Type | Required | Description | Example |
|
|
25
|
+
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
26
|
+
| `aggregationType` | [models.AggregationType](../../sdk/models/aggregation-type.md) | :heavy_minus_sign: | N/A | |
|
|
27
|
+
| `eventCount` | *number* | :heavy_minus_sign: | N/A | 42 |
|
|
28
|
+
| `meterId` | *string* | :heavy_minus_sign: | N/A | mtr_abc |
|
|
29
|
+
| `points` | [models.MeterUsagePoint](../../sdk/models/meter-usage-point.md)[] | :heavy_minus_sign: | N/A | |
|
|
30
|
+
| `totalValue` | *string* | :heavy_minus_sign: | N/A | 1234.5678 |
|
|
@@ -10,8 +10,8 @@ let value: PreviewSubscriptionChangeRequest = {
|
|
|
10
10
|
body: {
|
|
11
11
|
billingCadence: "RECURRING",
|
|
12
12
|
billingCycle: "anniversary",
|
|
13
|
-
billingPeriod: "
|
|
14
|
-
prorationBehavior: "
|
|
13
|
+
billingPeriod: "WEEKLY",
|
|
14
|
+
prorationBehavior: "none",
|
|
15
15
|
targetPlanId: "<id>",
|
|
16
16
|
},
|
|
17
17
|
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# PreviewSubscriptionModifyRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { PreviewSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: PreviewSubscriptionModifyRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
body: {
|
|
11
|
+
type: "quantity_change",
|
|
12
|
+
},
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Fields
|
|
17
|
+
|
|
18
|
+
| Field | Type | Required | Description |
|
|
19
|
+
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
20
|
+
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
21
|
+
| `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification preview request |
|