@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
|
@@ -151,12 +151,12 @@ export type PricePrice = {
|
|
|
151
151
|
tiers?: Array<PricePriceTier> | undefined;
|
|
152
152
|
transformQuantity?: PriceJSONBTransformQuantity | undefined;
|
|
153
153
|
/**
|
|
154
|
-
*
|
|
154
|
+
* TrialPeriodDays is the number of days for the trial period
|
|
155
155
|
*
|
|
156
156
|
* @remarks
|
|
157
157
|
* Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)
|
|
158
158
|
*/
|
|
159
|
-
|
|
159
|
+
trialPeriodDays?: number | undefined;
|
|
160
160
|
type?: PriceType | undefined;
|
|
161
161
|
updatedAt?: Date | undefined;
|
|
162
162
|
updatedBy?: string | undefined;
|
|
@@ -204,7 +204,7 @@ export const PricePrice$inboundSchema: z.ZodMiniType<PricePrice, unknown> = z
|
|
|
204
204
|
transform_quantity: types.optional(
|
|
205
205
|
PriceJSONBTransformQuantity$inboundSchema,
|
|
206
206
|
),
|
|
207
|
-
|
|
207
|
+
trial_period_days: types.optional(types.number()),
|
|
208
208
|
type: types.optional(PriceType$inboundSchema),
|
|
209
209
|
updated_at: types.optional(types.date()),
|
|
210
210
|
updated_by: types.optional(types.string()),
|
|
@@ -240,7 +240,7 @@ export const PricePrice$inboundSchema: z.ZodMiniType<PricePrice, unknown> = z
|
|
|
240
240
|
"tenant_id": "tenantId",
|
|
241
241
|
"tier_mode": "tierMode",
|
|
242
242
|
"transform_quantity": "transformQuantity",
|
|
243
|
-
"
|
|
243
|
+
"trial_period_days": "trialPeriodDays",
|
|
244
244
|
"updated_at": "updatedAt",
|
|
245
245
|
"updated_by": "updatedBy",
|
|
246
246
|
});
|
|
@@ -173,12 +173,12 @@ export type PriceResponse = {
|
|
|
173
173
|
tiers?: Array<PricePriceTier> | undefined;
|
|
174
174
|
transformQuantity?: PriceJSONBTransformQuantity | undefined;
|
|
175
175
|
/**
|
|
176
|
-
*
|
|
176
|
+
* TrialPeriodDays is the number of days for the trial period
|
|
177
177
|
*
|
|
178
178
|
* @remarks
|
|
179
179
|
* Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)
|
|
180
180
|
*/
|
|
181
|
-
|
|
181
|
+
trialPeriodDays?: number | undefined;
|
|
182
182
|
type?: PriceType | undefined;
|
|
183
183
|
updatedAt?: Date | undefined;
|
|
184
184
|
updatedBy?: string | undefined;
|
|
@@ -233,7 +233,7 @@ export const PriceResponse$inboundSchema: z.ZodMiniType<
|
|
|
233
233
|
transform_quantity: types.optional(
|
|
234
234
|
PriceJSONBTransformQuantity$inboundSchema,
|
|
235
235
|
),
|
|
236
|
-
|
|
236
|
+
trial_period_days: types.optional(types.number()),
|
|
237
237
|
type: types.optional(PriceType$inboundSchema),
|
|
238
238
|
updated_at: types.optional(types.date()),
|
|
239
239
|
updated_by: types.optional(types.string()),
|
|
@@ -270,7 +270,7 @@ export const PriceResponse$inboundSchema: z.ZodMiniType<
|
|
|
270
270
|
"tenant_id": "tenantId",
|
|
271
271
|
"tier_mode": "tierMode",
|
|
272
272
|
"transform_quantity": "transformQuantity",
|
|
273
|
-
"
|
|
273
|
+
"trial_period_days": "trialPeriodDays",
|
|
274
274
|
"updated_at": "updatedAt",
|
|
275
275
|
"updated_by": "updatedBy",
|
|
276
276
|
});
|
|
@@ -4,15 +4,31 @@
|
|
|
4
4
|
|
|
5
5
|
import * as z from "zod/v4-mini";
|
|
6
6
|
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
+
import {
|
|
8
|
+
ProrationBehavior,
|
|
9
|
+
ProrationBehavior$outboundSchema,
|
|
10
|
+
} from "./proration-behavior.js";
|
|
7
11
|
|
|
8
12
|
export type RemoveAddonRequest = {
|
|
9
13
|
addonAssociationId: string;
|
|
14
|
+
/**
|
|
15
|
+
* EffectiveDate is the date the cancellation takes effect.
|
|
16
|
+
*
|
|
17
|
+
* @remarks
|
|
18
|
+
* When nil the addon is cancelled at the end of the current period.
|
|
19
|
+
* When provided it must fall within [CurrentPeriodStart, CurrentPeriodEnd]; mid-period
|
|
20
|
+
* values combined with create_prorations will issue a wallet credit for unused time.
|
|
21
|
+
*/
|
|
22
|
+
effectiveDate?: Date | undefined;
|
|
23
|
+
prorationBehavior?: ProrationBehavior | undefined;
|
|
10
24
|
reason?: string | undefined;
|
|
11
25
|
};
|
|
12
26
|
|
|
13
27
|
/** @internal */
|
|
14
28
|
export type RemoveAddonRequest$Outbound = {
|
|
15
29
|
addon_association_id: string;
|
|
30
|
+
effective_date?: string | undefined;
|
|
31
|
+
proration_behavior?: string | undefined;
|
|
16
32
|
reason?: string | undefined;
|
|
17
33
|
};
|
|
18
34
|
|
|
@@ -23,11 +39,17 @@ export const RemoveAddonRequest$outboundSchema: z.ZodMiniType<
|
|
|
23
39
|
> = z.pipe(
|
|
24
40
|
z.object({
|
|
25
41
|
addonAssociationId: z.string(),
|
|
42
|
+
effectiveDate: z.optional(
|
|
43
|
+
z.pipe(z.date(), z.transform(v => v.toISOString())),
|
|
44
|
+
),
|
|
45
|
+
prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
|
|
26
46
|
reason: z.optional(z.string()),
|
|
27
47
|
}),
|
|
28
48
|
z.transform((v) => {
|
|
29
49
|
return remap$(v, {
|
|
30
50
|
addonAssociationId: "addon_association_id",
|
|
51
|
+
effectiveDate: "effective_date",
|
|
52
|
+
prorationBehavior: "proration_behavior",
|
|
31
53
|
});
|
|
32
54
|
}),
|
|
33
55
|
);
|
|
@@ -16,6 +16,3 @@ export type ResumeMode = OpenEnum<typeof ResumeMode>;
|
|
|
16
16
|
/** @internal */
|
|
17
17
|
export const ResumeMode$inboundSchema: z.ZodMiniType<ResumeMode, unknown> =
|
|
18
18
|
openEnums.inboundSchema(ResumeMode);
|
|
19
|
-
/** @internal */
|
|
20
|
-
export const ResumeMode$outboundSchema: z.ZodMiniType<string, ResumeMode> =
|
|
21
|
-
openEnums.outboundSchema(ResumeMode);
|
|
@@ -104,6 +104,13 @@ export type SubscriptionFilter = {
|
|
|
104
104
|
* SubscriptionType filters by subscription type
|
|
105
105
|
*/
|
|
106
106
|
subscriptionType?: Array<SubscriptionType> | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* TrialEndDueLTE, when set, restricts to subscriptions with trial_end not nil and trial_end <= trial_end_due_lte.
|
|
109
|
+
*
|
|
110
|
+
* @remarks
|
|
111
|
+
* Use with subscription_status trialing for trial-end cron processing.
|
|
112
|
+
*/
|
|
113
|
+
trialEndDueLte?: Date | undefined;
|
|
107
114
|
/**
|
|
108
115
|
* WithLineItems includes line items in the response
|
|
109
116
|
*/
|
|
@@ -139,6 +146,7 @@ export type SubscriptionFilter$Outbound = {
|
|
|
139
146
|
subscription_ids?: Array<string> | undefined;
|
|
140
147
|
subscription_status?: Array<string> | undefined;
|
|
141
148
|
subscription_type?: Array<string> | undefined;
|
|
149
|
+
trial_end_due_lte?: string | undefined;
|
|
142
150
|
with_line_items?: boolean | undefined;
|
|
143
151
|
};
|
|
144
152
|
|
|
@@ -170,6 +178,9 @@ export const SubscriptionFilter$outboundSchema: z.ZodMiniType<
|
|
|
170
178
|
subscriptionIds: z.optional(z.array(z.string())),
|
|
171
179
|
subscriptionStatus: z.optional(z.array(SubscriptionStatus$outboundSchema)),
|
|
172
180
|
subscriptionType: z.optional(z.array(SubscriptionType$outboundSchema)),
|
|
181
|
+
trialEndDueLte: z.optional(
|
|
182
|
+
z.pipe(z.date(), z.transform(v => v.toISOString())),
|
|
183
|
+
),
|
|
173
184
|
withLineItems: z.optional(z.boolean()),
|
|
174
185
|
}),
|
|
175
186
|
z.transform((v) => {
|
|
@@ -189,6 +200,7 @@ export const SubscriptionFilter$outboundSchema: z.ZodMiniType<
|
|
|
189
200
|
subscriptionIds: "subscription_ids",
|
|
190
201
|
subscriptionStatus: "subscription_status",
|
|
191
202
|
subscriptionType: "subscription_type",
|
|
203
|
+
trialEndDueLte: "trial_end_due_lte",
|
|
192
204
|
withLineItems: "with_line_items",
|
|
193
205
|
});
|
|
194
206
|
}),
|
|
@@ -32,6 +32,7 @@ import {
|
|
|
32
32
|
} from "./subscription-line-item-entity-type.js";
|
|
33
33
|
|
|
34
34
|
export type SubscriptionLineItemResponse = {
|
|
35
|
+
addonAssociationId?: string | undefined;
|
|
35
36
|
billingPeriod?: BillingPeriod | undefined;
|
|
36
37
|
/**
|
|
37
38
|
* from price at create; default 1
|
|
@@ -73,7 +74,6 @@ export type SubscriptionLineItemResponse = {
|
|
|
73
74
|
subscriptionId?: string | undefined;
|
|
74
75
|
subscriptionPhaseId?: string | undefined;
|
|
75
76
|
tenantId?: string | undefined;
|
|
76
|
-
trialPeriod?: number | undefined;
|
|
77
77
|
updatedAt?: Date | undefined;
|
|
78
78
|
updatedBy?: string | undefined;
|
|
79
79
|
};
|
|
@@ -84,6 +84,7 @@ export const SubscriptionLineItemResponse$inboundSchema: z.ZodMiniType<
|
|
|
84
84
|
unknown
|
|
85
85
|
> = z.pipe(
|
|
86
86
|
z.object({
|
|
87
|
+
addon_association_id: types.optional(types.string()),
|
|
87
88
|
billing_period: types.optional(BillingPeriod$inboundSchema),
|
|
88
89
|
billing_period_count: types.optional(types.number()),
|
|
89
90
|
commitment_amount: types.optional(types.string()),
|
|
@@ -119,12 +120,12 @@ export const SubscriptionLineItemResponse$inboundSchema: z.ZodMiniType<
|
|
|
119
120
|
subscription_id: types.optional(types.string()),
|
|
120
121
|
subscription_phase_id: types.optional(types.string()),
|
|
121
122
|
tenant_id: types.optional(types.string()),
|
|
122
|
-
trial_period: types.optional(types.number()),
|
|
123
123
|
updated_at: types.optional(types.date()),
|
|
124
124
|
updated_by: types.optional(types.string()),
|
|
125
125
|
}),
|
|
126
126
|
z.transform((v) => {
|
|
127
127
|
return remap$(v, {
|
|
128
|
+
"addon_association_id": "addonAssociationId",
|
|
128
129
|
"billing_period": "billingPeriod",
|
|
129
130
|
"billing_period_count": "billingPeriodCount",
|
|
130
131
|
"commitment_amount": "commitmentAmount",
|
|
@@ -154,7 +155,6 @@ export const SubscriptionLineItemResponse$inboundSchema: z.ZodMiniType<
|
|
|
154
155
|
"subscription_id": "subscriptionId",
|
|
155
156
|
"subscription_phase_id": "subscriptionPhaseId",
|
|
156
157
|
"tenant_id": "tenantId",
|
|
157
|
-
"trial_period": "trialPeriod",
|
|
158
158
|
"updated_at": "updatedAt",
|
|
159
159
|
"updated_by": "updatedBy",
|
|
160
160
|
});
|
|
@@ -55,7 +55,7 @@ export type SubscriptionPriceCreateRequest = {
|
|
|
55
55
|
tierMode?: BillingTier | undefined;
|
|
56
56
|
tiers?: Array<CreatePriceTier> | undefined;
|
|
57
57
|
transformQuantity?: PriceTransformQuantity | undefined;
|
|
58
|
-
|
|
58
|
+
trialPeriodDays?: number | undefined;
|
|
59
59
|
type: PriceType;
|
|
60
60
|
};
|
|
61
61
|
|
|
@@ -80,7 +80,7 @@ export type SubscriptionPriceCreateRequest$Outbound = {
|
|
|
80
80
|
tier_mode?: string | undefined;
|
|
81
81
|
tiers?: Array<CreatePriceTier$Outbound> | undefined;
|
|
82
82
|
transform_quantity?: PriceTransformQuantity$Outbound | undefined;
|
|
83
|
-
|
|
83
|
+
trial_period_days?: number | undefined;
|
|
84
84
|
type: string;
|
|
85
85
|
};
|
|
86
86
|
|
|
@@ -109,7 +109,7 @@ export const SubscriptionPriceCreateRequest$outboundSchema: z.ZodMiniType<
|
|
|
109
109
|
tierMode: z.optional(BillingTier$outboundSchema),
|
|
110
110
|
tiers: z.optional(z.array(CreatePriceTier$outboundSchema)),
|
|
111
111
|
transformQuantity: z.optional(PriceTransformQuantity$outboundSchema),
|
|
112
|
-
|
|
112
|
+
trialPeriodDays: z.optional(z.int()),
|
|
113
113
|
type: PriceType$outboundSchema,
|
|
114
114
|
}),
|
|
115
115
|
z.transform((v) => {
|
|
@@ -129,7 +129,7 @@ export const SubscriptionPriceCreateRequest$outboundSchema: z.ZodMiniType<
|
|
|
129
129
|
startDate: "start_date",
|
|
130
130
|
tierMode: "tier_mode",
|
|
131
131
|
transformQuantity: "transform_quantity",
|
|
132
|
-
|
|
132
|
+
trialPeriodDays: "trial_period_days",
|
|
133
133
|
});
|
|
134
134
|
}),
|
|
135
135
|
);
|
|
@@ -29,6 +29,7 @@ import {
|
|
|
29
29
|
} from "./subscription-line-item-entity-type.js";
|
|
30
30
|
|
|
31
31
|
export type SubscriptionSubscriptionLineItem = {
|
|
32
|
+
addonAssociationId?: string | undefined;
|
|
32
33
|
billingPeriod?: BillingPeriod | undefined;
|
|
33
34
|
/**
|
|
34
35
|
* from price at create; default 1
|
|
@@ -70,7 +71,6 @@ export type SubscriptionSubscriptionLineItem = {
|
|
|
70
71
|
subscriptionId?: string | undefined;
|
|
71
72
|
subscriptionPhaseId?: string | undefined;
|
|
72
73
|
tenantId?: string | undefined;
|
|
73
|
-
trialPeriod?: number | undefined;
|
|
74
74
|
updatedAt?: Date | undefined;
|
|
75
75
|
updatedBy?: string | undefined;
|
|
76
76
|
};
|
|
@@ -81,6 +81,7 @@ export const SubscriptionSubscriptionLineItem$inboundSchema: z.ZodMiniType<
|
|
|
81
81
|
unknown
|
|
82
82
|
> = z.pipe(
|
|
83
83
|
z.object({
|
|
84
|
+
addon_association_id: types.optional(types.string()),
|
|
84
85
|
billing_period: types.optional(BillingPeriod$inboundSchema),
|
|
85
86
|
billing_period_count: types.optional(types.number()),
|
|
86
87
|
commitment_amount: types.optional(types.string()),
|
|
@@ -116,12 +117,12 @@ export const SubscriptionSubscriptionLineItem$inboundSchema: z.ZodMiniType<
|
|
|
116
117
|
subscription_id: types.optional(types.string()),
|
|
117
118
|
subscription_phase_id: types.optional(types.string()),
|
|
118
119
|
tenant_id: types.optional(types.string()),
|
|
119
|
-
trial_period: types.optional(types.number()),
|
|
120
120
|
updated_at: types.optional(types.date()),
|
|
121
121
|
updated_by: types.optional(types.string()),
|
|
122
122
|
}),
|
|
123
123
|
z.transform((v) => {
|
|
124
124
|
return remap$(v, {
|
|
125
|
+
"addon_association_id": "addonAssociationId",
|
|
125
126
|
"billing_period": "billingPeriod",
|
|
126
127
|
"billing_period_count": "billingPeriodCount",
|
|
127
128
|
"commitment_amount": "commitmentAmount",
|
|
@@ -151,7 +152,6 @@ export const SubscriptionSubscriptionLineItem$inboundSchema: z.ZodMiniType<
|
|
|
151
152
|
"subscription_id": "subscriptionId",
|
|
152
153
|
"subscription_phase_id": "subscriptionPhaseId",
|
|
153
154
|
"tenant_id": "tenantId",
|
|
154
|
-
"trial_period": "trialPeriod",
|
|
155
155
|
"updated_at": "updatedAt",
|
|
156
156
|
"updated_by": "updatedBy",
|
|
157
157
|
});
|
package/src/sdk/subscriptions.ts
CHANGED
|
@@ -19,14 +19,11 @@ import { subscriptionsGetSubscriptionUsage } from "../funcs/subscriptions-get-su
|
|
|
19
19
|
import { subscriptionsGetSubscriptionV2 } from "../funcs/subscriptions-get-subscription-v2.js";
|
|
20
20
|
import { subscriptionsGetSubscription } from "../funcs/subscriptions-get-subscription.js";
|
|
21
21
|
import { subscriptionsListAllSubscriptionSchedules } from "../funcs/subscriptions-list-all-subscription-schedules.js";
|
|
22
|
-
import { subscriptionsListSubscriptionPauses } from "../funcs/subscriptions-list-subscription-pauses.js";
|
|
23
22
|
import { subscriptionsListSubscriptionSchedules } from "../funcs/subscriptions-list-subscription-schedules.js";
|
|
24
|
-
import { subscriptionsPauseSubscription } from "../funcs/subscriptions-pause-subscription.js";
|
|
25
23
|
import { subscriptionsPreviewSubscriptionChange } from "../funcs/subscriptions-preview-subscription-change.js";
|
|
26
24
|
import { subscriptionsPreviewSubscriptionModify } from "../funcs/subscriptions-preview-subscription-modify.js";
|
|
27
25
|
import { subscriptionsQuerySubscription } from "../funcs/subscriptions-query-subscription.js";
|
|
28
26
|
import { subscriptionsRemoveSubscriptionAddon } from "../funcs/subscriptions-remove-subscription-addon.js";
|
|
29
|
-
import { subscriptionsResumeSubscription } from "../funcs/subscriptions-resume-subscription.js";
|
|
30
27
|
import { subscriptionsUpdateSubscriptionLineItem } from "../funcs/subscriptions-update-subscription-line-item.js";
|
|
31
28
|
import { subscriptionsUpdateSubscription } from "../funcs/subscriptions-update-subscription.js";
|
|
32
29
|
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
@@ -379,61 +376,6 @@ export class Subscriptions extends ClientSDK {
|
|
|
379
376
|
));
|
|
380
377
|
}
|
|
381
378
|
|
|
382
|
-
/**
|
|
383
|
-
* Pause a subscription
|
|
384
|
-
*
|
|
385
|
-
* @remarks
|
|
386
|
-
* Use when temporarily stopping a subscription (e.g. customer hold or seasonal pause). Billing and access pause; resume when ready.
|
|
387
|
-
*/
|
|
388
|
-
async pauseSubscription(
|
|
389
|
-
id: string,
|
|
390
|
-
body: models.PauseSubscriptionRequest,
|
|
391
|
-
options?: RequestOptions,
|
|
392
|
-
): Promise<models.SubscriptionPauseResponse> {
|
|
393
|
-
return unwrapAsync(subscriptionsPauseSubscription(
|
|
394
|
-
this,
|
|
395
|
-
id,
|
|
396
|
-
body,
|
|
397
|
-
options,
|
|
398
|
-
));
|
|
399
|
-
}
|
|
400
|
-
|
|
401
|
-
/**
|
|
402
|
-
* List all pauses for a subscription
|
|
403
|
-
*
|
|
404
|
-
* @remarks
|
|
405
|
-
* Use when showing pause history for a subscription (e.g. support or audit). Returns all past and future pauses.
|
|
406
|
-
*/
|
|
407
|
-
async listSubscriptionPauses(
|
|
408
|
-
id: string,
|
|
409
|
-
options?: RequestOptions,
|
|
410
|
-
): Promise<Array<models.ListSubscriptionPausesResponse>> {
|
|
411
|
-
return unwrapAsync(subscriptionsListSubscriptionPauses(
|
|
412
|
-
this,
|
|
413
|
-
id,
|
|
414
|
-
options,
|
|
415
|
-
));
|
|
416
|
-
}
|
|
417
|
-
|
|
418
|
-
/**
|
|
419
|
-
* Resume a paused subscription
|
|
420
|
-
*
|
|
421
|
-
* @remarks
|
|
422
|
-
* Use when reactivating a paused subscription (e.g. end of hold). Billing and access resume from the resume date.
|
|
423
|
-
*/
|
|
424
|
-
async resumeSubscription(
|
|
425
|
-
id: string,
|
|
426
|
-
body: models.ResumeSubscriptionRequest,
|
|
427
|
-
options?: RequestOptions,
|
|
428
|
-
): Promise<models.SubscriptionPauseResponse> {
|
|
429
|
-
return unwrapAsync(subscriptionsResumeSubscription(
|
|
430
|
-
this,
|
|
431
|
-
id,
|
|
432
|
-
body,
|
|
433
|
-
options,
|
|
434
|
-
));
|
|
435
|
-
}
|
|
436
|
-
|
|
437
379
|
/**
|
|
438
380
|
* Get subscription (V2)
|
|
439
381
|
*
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# AddonType
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { AddonType } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: AddonType = "onetime";
|
|
9
|
-
|
|
10
|
-
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Values
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
"onetime" | "multiple_instance" | Unrecognized<string>
|
|
17
|
-
```
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# ListSubscriptionPausesRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { ListSubscriptionPausesRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: ListSubscriptionPausesRequest = {
|
|
9
|
-
id: "<id>",
|
|
10
|
-
};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
-
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# ListSubscriptionPausesResponse
|
|
2
|
-
|
|
3
|
-
Response object for listing subscription pauses with total count
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { ListSubscriptionPausesResponse } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: ListSubscriptionPausesResponse = {};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
17
|
-
| `items` | [models.SubscriptionPauseResponse](../../sdk/models/subscription-pause-response.md)[] | :heavy_minus_sign: | List of subscription pause objects<br/>@Description Array of subscription pauses |
|
|
18
|
-
| `total` | *number* | :heavy_minus_sign: | Total number of pauses<br/>@Description Total count of subscription pauses in the response |
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# PauseSubscriptionRequestRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { PauseSubscriptionRequestRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: PauseSubscriptionRequestRequest = {
|
|
9
|
-
id: "<id>",
|
|
10
|
-
body: {
|
|
11
|
-
pauseMode: "period_end",
|
|
12
|
-
},
|
|
13
|
-
};
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Fields
|
|
17
|
-
|
|
18
|
-
| Field | Type | Required | Description |
|
|
19
|
-
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
|
20
|
-
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
21
|
-
| `body` | [models.PauseSubscriptionRequest](../../sdk/models/pause-subscription-request.md) | :heavy_check_mark: | Pause subscription request |
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# PauseSubscriptionRequest
|
|
2
|
-
|
|
3
|
-
Request object for pausing an active subscription with various pause modes and options
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { PauseSubscriptionRequest } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: PauseSubscriptionRequest = {
|
|
11
|
-
pauseMode: "immediate",
|
|
12
|
-
};
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Fields
|
|
16
|
-
|
|
17
|
-
| Field | Type | Required | Description |
|
|
18
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
19
|
-
| `dryRun` | *boolean* | :heavy_minus_sign: | Whether to perform a dry run<br/>@Description If true, validates the request and shows impact without actually pausing the subscription<br/>@Example false |
|
|
20
|
-
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | Additional metadata as key-value pairs<br/>@Description Optional metadata for storing additional information about the pause<br/>@Example {"requested_by": "customer", "channel": "support_ticket"} |
|
|
21
|
-
| `pauseDays` | *number* | :heavy_minus_sign: | Duration of the pause in days<br/>@Description Number of days to pause the subscription. Cannot be used together with pause_end. Must be greater than 0<br/>@Example 30 |
|
|
22
|
-
| `pauseEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | End date for the subscription pause<br/>@Description ISO 8601 timestamp when the pause should end. Cannot be used together with pause_days. Must be after pause_start<br/>@Example "2024-02-15T00:00:00Z" |
|
|
23
|
-
| `pauseMode` | [models.PauseMode](../../sdk/models/pause-mode.md) | :heavy_check_mark: | N/A |
|
|
24
|
-
| `pauseStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Start date for the subscription pause<br/>@Description ISO 8601 timestamp when the pause should begin. Required when pause_mode is "scheduled"<br/>@Example "2024-01-15T00:00:00Z" |
|
|
25
|
-
| `reason` | *string* | :heavy_minus_sign: | Reason for pausing the subscription<br/>@Description Optional reason for the pause. Maximum 255 characters<br/>@Example "Customer requested temporary suspension" |
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# ResumeSubscriptionRequestRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { ResumeSubscriptionRequestRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: ResumeSubscriptionRequestRequest = {
|
|
9
|
-
id: "<id>",
|
|
10
|
-
body: {
|
|
11
|
-
resumeMode: "scheduled",
|
|
12
|
-
},
|
|
13
|
-
};
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Fields
|
|
17
|
-
|
|
18
|
-
| Field | Type | Required | Description |
|
|
19
|
-
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
20
|
-
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
21
|
-
| `body` | [models.ResumeSubscriptionRequest](../../sdk/models/resume-subscription-request.md) | :heavy_check_mark: | Resume subscription request |
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# ResumeSubscriptionRequest
|
|
2
|
-
|
|
3
|
-
Request object for resuming a paused subscription
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { ResumeSubscriptionRequest } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: ResumeSubscriptionRequest = {
|
|
11
|
-
resumeMode: "immediate",
|
|
12
|
-
};
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Fields
|
|
16
|
-
|
|
17
|
-
| Field | Type | Required | Description |
|
|
18
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
19
|
-
| `dryRun` | *boolean* | :heavy_minus_sign: | Whether to perform a dry run<br/>@Description If true, validates the request and shows impact without actually resuming the subscription<br/>@Example false |
|
|
20
|
-
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | Additional metadata as key-value pairs<br/>@Description Optional metadata for storing additional information about the resume operation<br/>@Example {"resumed_by": "admin", "reason": "issue_resolved"} |
|
|
21
|
-
| `resumeMode` | [models.ResumeMode](../../sdk/models/resume-mode.md) | :heavy_check_mark: | N/A |
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
# SubscriptionPauseResponse
|
|
2
|
-
|
|
3
|
-
Response object containing subscription pause information
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { SubscriptionPauseResponse } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: SubscriptionPauseResponse = {};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
17
|
-
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
18
|
-
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
-
| `environmentId` | *string* | :heavy_minus_sign: | EnvironmentID is the environment identifier for the pause |
|
|
20
|
-
| `id` | *string* | :heavy_minus_sign: | ID is the unique identifier for the subscription pause |
|
|
21
|
-
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
22
|
-
| `originalPeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | OriginalPeriodEnd is the end of the billing period when the pause was created |
|
|
23
|
-
| `originalPeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | OriginalPeriodStart is the start of the billing period when the pause was created |
|
|
24
|
-
| `pauseEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | PauseEnd is when the pause will end (null for indefinite) |
|
|
25
|
-
| `pauseMode` | [models.PauseMode](../../sdk/models/pause-mode.md) | :heavy_minus_sign: | N/A |
|
|
26
|
-
| `pauseStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | PauseStart is when the pause actually started |
|
|
27
|
-
| `pauseStatus` | [models.PauseStatus](../../sdk/models/pause-status.md) | :heavy_minus_sign: | N/A |
|
|
28
|
-
| `reason` | *string* | :heavy_minus_sign: | Reason is the reason for pausing |
|
|
29
|
-
| `resumeMode` | [models.ResumeMode](../../sdk/models/resume-mode.md) | :heavy_minus_sign: | N/A |
|
|
30
|
-
| `resumedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ResumedAt is when the pause was actually ended (if manually resumed) |
|
|
31
|
-
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
32
|
-
| `subscriptionId` | *string* | :heavy_minus_sign: | SubscriptionID is the identifier for the subscription |
|
|
33
|
-
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
34
|
-
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
35
|
-
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { FlexpriceCore } from "../core.js";
|
|
2
|
-
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
-
import { FlexPriceError } from "../sdk/models/flex-price-error.js";
|
|
4
|
-
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/http-client-errors.js";
|
|
5
|
-
import * as models from "../sdk/models/index.js";
|
|
6
|
-
import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
|
|
7
|
-
import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
|
|
8
|
-
import { APIPromise } from "../types/async.js";
|
|
9
|
-
import { Result } from "../types/fp.js";
|
|
10
|
-
/**
|
|
11
|
-
* List all pauses for a subscription
|
|
12
|
-
*
|
|
13
|
-
* @remarks
|
|
14
|
-
* Use when showing pause history for a subscription (e.g. support or audit). Returns all past and future pauses.
|
|
15
|
-
*/
|
|
16
|
-
export declare function subscriptionsListSubscriptionPauses(client: FlexpriceCore, id: string, options?: RequestOptions): APIPromise<Result<Array<models.ListSubscriptionPausesResponse>, models.ErrorsErrorResponse | FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
17
|
-
//# sourceMappingURL=subscriptions-list-subscription-pauses.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"subscriptions-list-subscription-pauses.d.ts","sourceRoot":"","sources":["../../src/funcs/subscriptions-list-subscription-pauses.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAM3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,mCAAmC,CACjD,MAAM,EAAE,aAAa,EACrB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,KAAK,CAAC,MAAM,CAAC,8BAA8B,CAAC,EAC1C,MAAM,CAAC,mBAAmB,GAC1B,cAAc,GACd,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|