@flexprice/sdk 2.1.5 → 2.1.9

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.
Files changed (237) hide show
  1. package/FUNCTIONS.md +2 -2
  2. package/docs/sdk/models/create-price-request.md +1 -1
  3. package/docs/sdk/models/create-subscription-request.md +1 -2
  4. package/docs/sdk/models/customer-filter.md +1 -0
  5. package/docs/sdk/models/execute-subscription-modify-request.md +7 -6
  6. package/docs/sdk/models/export-metadata-entity-type.md +17 -0
  7. package/docs/sdk/models/export-metadata-field.md +20 -0
  8. package/docs/sdk/models/grouped-invoicing-action.md +15 -0
  9. package/docs/sdk/models/invoice-billing-reason.md +1 -1
  10. package/docs/sdk/models/list-subscription-line-items-response.md +50 -0
  11. package/docs/sdk/models/plan-filter.md +1 -0
  12. package/docs/sdk/models/price-price.md +42 -42
  13. package/docs/sdk/models/price-response.md +47 -47
  14. package/docs/sdk/models/s3-job-config.md +10 -9
  15. package/docs/sdk/models/scheduled-task-entity-type.md +1 -1
  16. package/docs/sdk/models/sub-modify-grouped-invoicing-params.md +19 -0
  17. package/docs/sdk/models/subscription-filter.md +1 -0
  18. package/docs/sdk/models/subscription-inheritance-config.md +6 -5
  19. package/docs/sdk/models/subscription-line-item-filter-order.md +15 -0
  20. package/docs/sdk/models/subscription-line-item-filter.md +34 -0
  21. package/docs/sdk/models/subscription-line-item-response.md +0 -1
  22. package/docs/sdk/models/subscription-modify-type.md +2 -2
  23. package/docs/sdk/models/subscription-price-create-request.md +1 -1
  24. package/docs/sdk/models/subscription-subscription-line-item.md +0 -1
  25. package/docs/sdk/models/subscription-type.md +1 -1
  26. package/docs/sdks/scheduledtasks/README.md +2 -2
  27. package/docs/sdks/subscriptions/README.md +74 -228
  28. package/esm/funcs/subscriptions-query-subscription-line-items.d.ts +17 -0
  29. package/esm/funcs/subscriptions-query-subscription-line-items.d.ts.map +1 -0
  30. package/esm/funcs/{subscriptions-list-subscription-pauses.js → subscriptions-query-subscription-line-items.js} +14 -22
  31. package/esm/funcs/subscriptions-query-subscription-line-items.js.map +1 -0
  32. package/esm/lib/config.d.ts +3 -3
  33. package/esm/lib/config.js +3 -3
  34. package/esm/sdk/models/create-price-request.d.ts +2 -2
  35. package/esm/sdk/models/create-price-request.d.ts.map +1 -1
  36. package/esm/sdk/models/create-price-request.js +2 -2
  37. package/esm/sdk/models/create-price-request.js.map +1 -1
  38. package/esm/sdk/models/create-subscription-request.d.ts +8 -4
  39. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  40. package/esm/sdk/models/create-subscription-request.js +2 -4
  41. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  42. package/esm/sdk/models/customer-filter.d.ts +6 -0
  43. package/esm/sdk/models/customer-filter.d.ts.map +1 -1
  44. package/esm/sdk/models/customer-filter.js +1 -0
  45. package/esm/sdk/models/customer-filter.js.map +1 -1
  46. package/esm/sdk/models/execute-subscription-modify-request.d.ts +3 -0
  47. package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -1
  48. package/esm/sdk/models/execute-subscription-modify-request.js +3 -0
  49. package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -1
  50. package/esm/sdk/models/export-metadata-entity-type.d.ts +12 -0
  51. package/esm/sdk/models/export-metadata-entity-type.d.ts.map +1 -0
  52. package/esm/sdk/models/export-metadata-entity-type.js +13 -0
  53. package/esm/sdk/models/export-metadata-entity-type.js.map +1 -0
  54. package/esm/sdk/models/export-metadata-field.d.ts +28 -0
  55. package/esm/sdk/models/export-metadata-field.d.ts.map +1 -0
  56. package/esm/sdk/models/export-metadata-field.js +39 -0
  57. package/esm/sdk/models/export-metadata-field.js.map +1 -0
  58. package/esm/sdk/models/grouped-invoicing-action.d.ts +10 -0
  59. package/esm/sdk/models/grouped-invoicing-action.d.ts.map +1 -0
  60. package/esm/sdk/models/grouped-invoicing-action.js +11 -0
  61. package/esm/sdk/models/grouped-invoicing-action.js.map +1 -0
  62. package/esm/sdk/models/index.d.ts +6 -7
  63. package/esm/sdk/models/index.d.ts.map +1 -1
  64. package/esm/sdk/models/index.js +6 -7
  65. package/esm/sdk/models/index.js.map +1 -1
  66. package/esm/sdk/models/invoice-billing-reason.d.ts +2 -0
  67. package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
  68. package/esm/sdk/models/invoice-billing-reason.js +2 -0
  69. package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
  70. package/esm/sdk/models/list-subscription-line-items-response.d.ts +13 -0
  71. package/esm/sdk/models/list-subscription-line-items-response.d.ts.map +1 -0
  72. package/esm/sdk/models/list-subscription-line-items-response.js +17 -0
  73. package/esm/sdk/models/list-subscription-line-items-response.js.map +1 -0
  74. package/esm/sdk/models/pause-mode.d.ts +0 -2
  75. package/esm/sdk/models/pause-mode.d.ts.map +1 -1
  76. package/esm/sdk/models/pause-mode.js +0 -2
  77. package/esm/sdk/models/pause-mode.js.map +1 -1
  78. package/esm/sdk/models/plan-filter.d.ts +6 -0
  79. package/esm/sdk/models/plan-filter.d.ts.map +1 -1
  80. package/esm/sdk/models/plan-filter.js +1 -0
  81. package/esm/sdk/models/plan-filter.js.map +1 -1
  82. package/esm/sdk/models/price-price.d.ts +2 -2
  83. package/esm/sdk/models/price-price.d.ts.map +1 -1
  84. package/esm/sdk/models/price-price.js +2 -2
  85. package/esm/sdk/models/price-price.js.map +1 -1
  86. package/esm/sdk/models/price-response.d.ts +2 -2
  87. package/esm/sdk/models/price-response.d.ts.map +1 -1
  88. package/esm/sdk/models/price-response.js +2 -2
  89. package/esm/sdk/models/price-response.js.map +1 -1
  90. package/esm/sdk/models/resume-mode.d.ts +0 -2
  91. package/esm/sdk/models/resume-mode.d.ts.map +1 -1
  92. package/esm/sdk/models/resume-mode.js +0 -2
  93. package/esm/sdk/models/resume-mode.js.map +1 -1
  94. package/esm/sdk/models/s3-job-config.d.ts +7 -1
  95. package/esm/sdk/models/s3-job-config.d.ts.map +1 -1
  96. package/esm/sdk/models/s3-job-config.js +5 -0
  97. package/esm/sdk/models/s3-job-config.js.map +1 -1
  98. package/esm/sdk/models/scheduled-task-entity-type.d.ts +1 -0
  99. package/esm/sdk/models/scheduled-task-entity-type.d.ts.map +1 -1
  100. package/esm/sdk/models/scheduled-task-entity-type.js +1 -0
  101. package/esm/sdk/models/scheduled-task-entity-type.js.map +1 -1
  102. package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts +20 -0
  103. package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts.map +1 -0
  104. package/esm/sdk/models/sub-modify-grouped-invoicing-params.js +21 -0
  105. package/esm/sdk/models/sub-modify-grouped-invoicing-params.js.map +1 -0
  106. package/esm/sdk/models/subscription-filter.d.ts +8 -0
  107. package/esm/sdk/models/subscription-filter.d.ts.map +1 -1
  108. package/esm/sdk/models/subscription-filter.js +2 -0
  109. package/esm/sdk/models/subscription-filter.js.map +1 -1
  110. package/esm/sdk/models/subscription-inheritance-config.d.ts +26 -0
  111. package/esm/sdk/models/subscription-inheritance-config.d.ts.map +1 -1
  112. package/esm/sdk/models/subscription-inheritance-config.js +2 -0
  113. package/esm/sdk/models/subscription-inheritance-config.js.map +1 -1
  114. package/esm/sdk/models/subscription-line-item-entity-type.d.ts +2 -0
  115. package/esm/sdk/models/subscription-line-item-entity-type.d.ts.map +1 -1
  116. package/esm/sdk/models/subscription-line-item-entity-type.js +2 -0
  117. package/esm/sdk/models/subscription-line-item-entity-type.js.map +1 -1
  118. package/esm/sdk/models/subscription-line-item-filter.d.ts +65 -0
  119. package/esm/sdk/models/subscription-line-item-filter.d.ts.map +1 -0
  120. package/esm/sdk/models/subscription-line-item-filter.js +57 -0
  121. package/esm/sdk/models/subscription-line-item-filter.js.map +1 -0
  122. package/esm/sdk/models/subscription-line-item-response.d.ts +0 -1
  123. package/esm/sdk/models/subscription-line-item-response.d.ts.map +1 -1
  124. package/esm/sdk/models/subscription-line-item-response.js +0 -2
  125. package/esm/sdk/models/subscription-line-item-response.js.map +1 -1
  126. package/esm/sdk/models/subscription-modify-type.d.ts +1 -0
  127. package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -1
  128. package/esm/sdk/models/subscription-modify-type.js +1 -0
  129. package/esm/sdk/models/subscription-modify-type.js.map +1 -1
  130. package/esm/sdk/models/subscription-price-create-request.d.ts +2 -2
  131. package/esm/sdk/models/subscription-price-create-request.d.ts.map +1 -1
  132. package/esm/sdk/models/subscription-price-create-request.js +2 -2
  133. package/esm/sdk/models/subscription-price-create-request.js.map +1 -1
  134. package/esm/sdk/models/subscription-subscription-line-item.d.ts +0 -1
  135. package/esm/sdk/models/subscription-subscription-line-item.d.ts.map +1 -1
  136. package/esm/sdk/models/subscription-subscription-line-item.js +0 -2
  137. package/esm/sdk/models/subscription-subscription-line-item.js.map +1 -1
  138. package/esm/sdk/models/subscription-type.d.ts +2 -0
  139. package/esm/sdk/models/subscription-type.d.ts.map +1 -1
  140. package/esm/sdk/models/subscription-type.js +2 -0
  141. package/esm/sdk/models/subscription-type.js.map +1 -1
  142. package/esm/sdk/subscriptions.d.ts +7 -21
  143. package/esm/sdk/subscriptions.d.ts.map +1 -1
  144. package/esm/sdk/subscriptions.js +10 -30
  145. package/esm/sdk/subscriptions.js.map +1 -1
  146. package/esm/types/primitives.d.ts +1 -1
  147. package/esm/types/primitives.d.ts.map +1 -1
  148. package/esm/types/primitives.js +2 -3
  149. package/esm/types/primitives.js.map +1 -1
  150. package/jsr.json +1 -1
  151. package/package.json +1 -1
  152. package/src/funcs/{subscriptions-list-subscription-pauses.ts → subscriptions-query-subscription-line-items.ts} +19 -29
  153. package/src/lib/config.ts +3 -3
  154. package/src/sdk/models/create-price-request.ts +4 -4
  155. package/src/sdk/models/create-subscription-request.ts +10 -8
  156. package/src/sdk/models/customer-filter.ts +3 -0
  157. package/src/sdk/models/execute-subscription-modify-request.ts +13 -0
  158. package/src/sdk/models/export-metadata-entity-type.ts +26 -0
  159. package/src/sdk/models/export-metadata-field.ts +88 -0
  160. package/src/sdk/models/grouped-invoicing-action.ts +17 -0
  161. package/src/sdk/models/index.ts +6 -7
  162. package/src/sdk/models/invoice-billing-reason.ts +2 -0
  163. package/src/sdk/models/list-subscription-line-items-response.ts +41 -0
  164. package/src/sdk/models/pause-mode.ts +0 -3
  165. package/src/sdk/models/plan-filter.ts +3 -0
  166. package/src/sdk/models/price-price.ts +4 -4
  167. package/src/sdk/models/price-response.ts +4 -4
  168. package/src/sdk/models/resume-mode.ts +0 -3
  169. package/src/sdk/models/s3-job-config.ts +20 -1
  170. package/src/sdk/models/scheduled-task-entity-type.ts +1 -0
  171. package/src/sdk/models/sub-modify-grouped-invoicing-params.ts +54 -0
  172. package/src/sdk/models/subscription-filter.ts +12 -0
  173. package/src/sdk/models/subscription-inheritance-config.ts +29 -0
  174. package/src/sdk/models/subscription-line-item-entity-type.ts +5 -0
  175. package/src/sdk/models/subscription-line-item-filter.ts +140 -0
  176. package/src/sdk/models/subscription-line-item-response.ts +0 -3
  177. package/src/sdk/models/subscription-modify-type.ts +1 -0
  178. package/src/sdk/models/subscription-price-create-request.ts +4 -4
  179. package/src/sdk/models/subscription-subscription-line-item.ts +0 -3
  180. package/src/sdk/models/subscription-type.ts +2 -0
  181. package/src/sdk/subscriptions.ts +18 -58
  182. package/src/types/primitives.ts +2 -4
  183. package/docs/sdk/models/list-subscription-pauses-request.md +0 -17
  184. package/docs/sdk/models/list-subscription-pauses-response.md +0 -18
  185. package/docs/sdk/models/pause-subscription-request-request.md +0 -21
  186. package/docs/sdk/models/pause-subscription-request.md +0 -25
  187. package/docs/sdk/models/resume-subscription-request-request.md +0 -21
  188. package/docs/sdk/models/resume-subscription-request.md +0 -21
  189. package/docs/sdk/models/subscription-pause-response.md +0 -35
  190. package/esm/funcs/subscriptions-list-subscription-pauses.d.ts +0 -17
  191. package/esm/funcs/subscriptions-list-subscription-pauses.d.ts.map +0 -1
  192. package/esm/funcs/subscriptions-list-subscription-pauses.js.map +0 -1
  193. package/esm/funcs/subscriptions-pause-subscription.d.ts +0 -17
  194. package/esm/funcs/subscriptions-pause-subscription.d.ts.map +0 -1
  195. package/esm/funcs/subscriptions-pause-subscription.js +0 -93
  196. package/esm/funcs/subscriptions-pause-subscription.js.map +0 -1
  197. package/esm/funcs/subscriptions-resume-subscription.d.ts +0 -17
  198. package/esm/funcs/subscriptions-resume-subscription.d.ts.map +0 -1
  199. package/esm/funcs/subscriptions-resume-subscription.js +0 -93
  200. package/esm/funcs/subscriptions-resume-subscription.js.map +0 -1
  201. package/esm/sdk/models/list-subscription-pauses-op.d.ts +0 -15
  202. package/esm/sdk/models/list-subscription-pauses-op.d.ts.map +0 -1
  203. package/esm/sdk/models/list-subscription-pauses-op.js +0 -12
  204. package/esm/sdk/models/list-subscription-pauses-op.js.map +0 -1
  205. package/esm/sdk/models/list-subscription-pauses-response.d.ts +0 -27
  206. package/esm/sdk/models/list-subscription-pauses-response.d.ts.map +0 -1
  207. package/esm/sdk/models/list-subscription-pauses-response.js +0 -16
  208. package/esm/sdk/models/list-subscription-pauses-response.js.map +0 -1
  209. package/esm/sdk/models/pause-subscription-op.d.ts +0 -21
  210. package/esm/sdk/models/pause-subscription-op.d.ts.map +0 -1
  211. package/esm/sdk/models/pause-subscription-op.js +0 -14
  212. package/esm/sdk/models/pause-subscription-op.js.map +0 -1
  213. package/esm/sdk/models/pause-subscription-request.d.ts +0 -74
  214. package/esm/sdk/models/pause-subscription-request.d.ts.map +0 -1
  215. package/esm/sdk/models/pause-subscription-request.js +0 -28
  216. package/esm/sdk/models/pause-subscription-request.js.map +0 -1
  217. package/esm/sdk/models/resume-subscription-op.d.ts +0 -21
  218. package/esm/sdk/models/resume-subscription-op.d.ts.map +0 -1
  219. package/esm/sdk/models/resume-subscription-op.js +0 -14
  220. package/esm/sdk/models/resume-subscription-op.js.map +0 -1
  221. package/esm/sdk/models/resume-subscription-request.d.ts +0 -38
  222. package/esm/sdk/models/resume-subscription-request.d.ts.map +0 -1
  223. package/esm/sdk/models/resume-subscription-request.js +0 -21
  224. package/esm/sdk/models/resume-subscription-request.js.map +0 -1
  225. package/esm/sdk/models/subscription-pause-response.d.ts +0 -64
  226. package/esm/sdk/models/subscription-pause-response.d.ts.map +0 -1
  227. package/esm/sdk/models/subscription-pause-response.js +0 -55
  228. package/esm/sdk/models/subscription-pause-response.js.map +0 -1
  229. package/src/funcs/subscriptions-pause-subscription.ts +0 -187
  230. package/src/funcs/subscriptions-resume-subscription.ts +0 -187
  231. package/src/sdk/models/list-subscription-pauses-op.ts +0 -35
  232. package/src/sdk/models/list-subscription-pauses-response.ts +0 -52
  233. package/src/sdk/models/pause-subscription-op.ts +0 -46
  234. package/src/sdk/models/pause-subscription-request.ts +0 -106
  235. package/src/sdk/models/resume-subscription-op.ts +0 -46
  236. package/src/sdk/models/resume-subscription-request.ts +0 -63
  237. package/src/sdk/models/subscription-pause-response.ts +0 -123
@@ -32,6 +32,7 @@ export type PlanFilter = {
32
32
  filters?: Array<FilterCondition> | undefined;
33
33
  limit?: number | undefined;
34
34
  lookupKey?: string | undefined;
35
+ metadata?: { [k: string]: string } | undefined;
35
36
  offset?: number | undefined;
36
37
  order?: PlanFilterOrder | undefined;
37
38
  planIds?: Array<string> | undefined;
@@ -52,6 +53,7 @@ export type PlanFilter$Outbound = {
52
53
  filters?: Array<FilterCondition$Outbound> | undefined;
53
54
  limit?: number | undefined;
54
55
  lookup_key?: string | undefined;
56
+ metadata?: { [k: string]: string } | undefined;
55
57
  offset?: number | undefined;
56
58
  order?: string | undefined;
57
59
  plan_ids?: Array<string> | undefined;
@@ -71,6 +73,7 @@ export const PlanFilter$outboundSchema: z.ZodMiniType<
71
73
  filters: z.optional(z.array(FilterCondition$outboundSchema)),
72
74
  limit: z.optional(z.int()),
73
75
  lookupKey: z.optional(z.string()),
76
+ metadata: z.optional(z.record(z.string(), z.string())),
74
77
  offset: z.optional(z.int()),
75
78
  order: z.optional(PlanFilterOrder$outboundSchema),
76
79
  planIds: z.optional(z.array(z.string())),
@@ -151,12 +151,12 @@ export type PricePrice = {
151
151
  tiers?: Array<PricePriceTier> | undefined;
152
152
  transformQuantity?: PriceJSONBTransformQuantity | undefined;
153
153
  /**
154
- * TrialPeriod is the number of days for the trial period
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
- trialPeriod?: number | undefined;
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
- trial_period: types.optional(types.number()),
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
- "trial_period": "trialPeriod",
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
- * TrialPeriod is the number of days for the trial period
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
- trialPeriod?: number | undefined;
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
- trial_period: types.optional(types.number()),
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
- "trial_period": "trialPeriod",
273
+ "trial_period_days": "trialPeriodDays",
274
274
  "updated_at": "updatedAt",
275
275
  "updated_by": "updatedBy",
276
276
  });
@@ -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);
@@ -7,6 +7,12 @@ import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
8
  import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import * as types from "../../types/primitives.js";
10
+ import {
11
+ ExportMetadataField,
12
+ ExportMetadataField$inboundSchema,
13
+ ExportMetadataField$Outbound,
14
+ ExportMetadataField$outboundSchema,
15
+ } from "./export-metadata-field.js";
10
16
  import {
11
17
  S3CompressionType,
12
18
  S3CompressionType$inboundSchema,
@@ -30,6 +36,10 @@ export type S3JobConfig = {
30
36
  * Custom S3 endpoint URL (e.g., "http://minio:9000" for MinIO)
31
37
  */
32
38
  endpointUrl?: string | undefined;
39
+ /**
40
+ * Optional user-selected metadata columns
41
+ */
42
+ exportMetadataFields?: Array<ExportMetadataField> | undefined;
33
43
  /**
34
44
  * Optional prefix for S3 keys (e.g., "flexprice-exports/")
35
45
  */
@@ -39,7 +49,7 @@ export type S3JobConfig = {
39
49
  */
40
50
  region?: string | undefined;
41
51
  /**
42
- * Use path-style addressing instead of virtual-hosted-style (required for MinIO)
52
+ * Use path-style addressing (required for MinIO)
43
53
  */
44
54
  usePathStyle?: boolean | undefined;
45
55
  };
@@ -52,6 +62,9 @@ export const S3JobConfig$inboundSchema: z.ZodMiniType<S3JobConfig, unknown> = z
52
62
  compression: types.optional(S3CompressionType$inboundSchema),
53
63
  encryption: types.optional(S3EncryptionType$inboundSchema),
54
64
  endpoint_url: types.optional(types.string()),
65
+ export_metadata_fields: types.optional(
66
+ z.array(ExportMetadataField$inboundSchema),
67
+ ),
55
68
  key_prefix: types.optional(types.string()),
56
69
  region: types.optional(types.string()),
57
70
  use_path_style: types.optional(types.boolean()),
@@ -59,6 +72,7 @@ export const S3JobConfig$inboundSchema: z.ZodMiniType<S3JobConfig, unknown> = z
59
72
  z.transform((v) => {
60
73
  return remap$(v, {
61
74
  "endpoint_url": "endpointUrl",
75
+ "export_metadata_fields": "exportMetadataFields",
62
76
  "key_prefix": "keyPrefix",
63
77
  "use_path_style": "usePathStyle",
64
78
  });
@@ -70,6 +84,7 @@ export type S3JobConfig$Outbound = {
70
84
  compression?: string | undefined;
71
85
  encryption?: string | undefined;
72
86
  endpoint_url?: string | undefined;
87
+ export_metadata_fields?: Array<ExportMetadataField$Outbound> | undefined;
73
88
  key_prefix?: string | undefined;
74
89
  region?: string | undefined;
75
90
  use_path_style?: boolean | undefined;
@@ -85,6 +100,9 @@ export const S3JobConfig$outboundSchema: z.ZodMiniType<
85
100
  compression: z.optional(S3CompressionType$outboundSchema),
86
101
  encryption: z.optional(S3EncryptionType$outboundSchema),
87
102
  endpointUrl: z.optional(z.string()),
103
+ exportMetadataFields: z.optional(
104
+ z.array(ExportMetadataField$outboundSchema),
105
+ ),
88
106
  keyPrefix: z.optional(z.string()),
89
107
  region: z.optional(z.string()),
90
108
  usePathStyle: z.optional(z.boolean()),
@@ -92,6 +110,7 @@ export const S3JobConfig$outboundSchema: z.ZodMiniType<
92
110
  z.transform((v) => {
93
111
  return remap$(v, {
94
112
  endpointUrl: "endpoint_url",
113
+ exportMetadataFields: "export_metadata_fields",
95
114
  keyPrefix: "key_prefix",
96
115
  usePathStyle: "use_path_style",
97
116
  });
@@ -11,6 +11,7 @@ export const ScheduledTaskEntityType = {
11
11
  Invoice: "invoice",
12
12
  CreditTopups: "credit_topups",
13
13
  CreditUsage: "credit_usage",
14
+ UsageAnalytics: "usage_analytics",
14
15
  } as const;
15
16
  export type ScheduledTaskEntityType = OpenEnum<typeof ScheduledTaskEntityType>;
16
17
 
@@ -0,0 +1,54 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import {
8
+ GroupedInvoicingAction,
9
+ GroupedInvoicingAction$outboundSchema,
10
+ } from "./grouped-invoicing-action.js";
11
+
12
+ export type SubModifyGroupedInvoicingParams = {
13
+ action: GroupedInvoicingAction;
14
+ childSubscriptionIds?: Array<string> | undefined;
15
+ /**
16
+ * ParentSubscriptionID is required for action 'add'.
17
+ */
18
+ parentSubscriptionId?: string | undefined;
19
+ };
20
+
21
+ /** @internal */
22
+ export type SubModifyGroupedInvoicingParams$Outbound = {
23
+ action: string;
24
+ child_subscription_ids?: Array<string> | undefined;
25
+ parent_subscription_id?: string | undefined;
26
+ };
27
+
28
+ /** @internal */
29
+ export const SubModifyGroupedInvoicingParams$outboundSchema: z.ZodMiniType<
30
+ SubModifyGroupedInvoicingParams$Outbound,
31
+ SubModifyGroupedInvoicingParams
32
+ > = z.pipe(
33
+ z.object({
34
+ action: GroupedInvoicingAction$outboundSchema,
35
+ childSubscriptionIds: z.optional(z.array(z.string())),
36
+ parentSubscriptionId: z.optional(z.string()),
37
+ }),
38
+ z.transform((v) => {
39
+ return remap$(v, {
40
+ childSubscriptionIds: "child_subscription_ids",
41
+ parentSubscriptionId: "parent_subscription_id",
42
+ });
43
+ }),
44
+ );
45
+
46
+ export function subModifyGroupedInvoicingParamsToJSON(
47
+ subModifyGroupedInvoicingParams: SubModifyGroupedInvoicingParams,
48
+ ): string {
49
+ return JSON.stringify(
50
+ SubModifyGroupedInvoicingParams$outboundSchema.parse(
51
+ subModifyGroupedInvoicingParams,
52
+ ),
53
+ );
54
+ }
@@ -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
  }),
@@ -6,9 +6,34 @@ import * as z from "zod/v4-mini";
6
6
  import { remap as remap$ } from "../../lib/primitives.js";
7
7
 
8
8
  export type SubscriptionInheritanceConfig = {
9
+ /**
10
+ * ExternalCustomerIDsToInheritSubscription: child customer external IDs for which
11
+ *
12
+ * @remarks
13
+ * inherited skeleton subscriptions will be created. Only valid for parent behavior.
14
+ */
9
15
  externalCustomerIdsToInheritSubscription?: Array<string> | undefined;
16
+ /**
17
+ * InvoicingCustomerExternalID sets a different billing recipient (external ID).
18
+ *
19
+ * @remarks
20
+ * Required for delegated; rejected for inherited; optional for others.
21
+ */
10
22
  invoicingCustomerExternalId?: string | undefined;
23
+ /**
24
+ * ParentSubscriptionID links this subscription to an existing parent.
25
+ *
26
+ * @remarks
27
+ * Required for inherited and grouped_invoicing; rejected for standalone, delegated, parent.
28
+ */
11
29
  parentSubscriptionId?: string | undefined;
30
+ /**
31
+ * SubscriptionsIDsForGroupedInvoicing: existing standalone subscription IDs to convert to
32
+ *
33
+ * @remarks
34
+ * grouped_invoicing under this parent at creation time. Only valid for parent behavior.
35
+ */
36
+ subscriptionsIdsForGroupedInvoicing?: Array<string> | undefined;
12
37
  };
13
38
 
14
39
  /** @internal */
@@ -16,6 +41,7 @@ export type SubscriptionInheritanceConfig$Outbound = {
16
41
  external_customer_ids_to_inherit_subscription?: Array<string> | undefined;
17
42
  invoicing_customer_external_id?: string | undefined;
18
43
  parent_subscription_id?: string | undefined;
44
+ subscriptions_ids_for_grouped_invoicing?: Array<string> | undefined;
19
45
  };
20
46
 
21
47
  /** @internal */
@@ -27,6 +53,7 @@ export const SubscriptionInheritanceConfig$outboundSchema: z.ZodMiniType<
27
53
  externalCustomerIdsToInheritSubscription: z.optional(z.array(z.string())),
28
54
  invoicingCustomerExternalId: z.optional(z.string()),
29
55
  parentSubscriptionId: z.optional(z.string()),
56
+ subscriptionsIdsForGroupedInvoicing: z.optional(z.array(z.string())),
30
57
  }),
31
58
  z.transform((v) => {
32
59
  return remap$(v, {
@@ -34,6 +61,8 @@ export const SubscriptionInheritanceConfig$outboundSchema: z.ZodMiniType<
34
61
  "external_customer_ids_to_inherit_subscription",
35
62
  invoicingCustomerExternalId: "invoicing_customer_external_id",
36
63
  parentSubscriptionId: "parent_subscription_id",
64
+ subscriptionsIdsForGroupedInvoicing:
65
+ "subscriptions_ids_for_grouped_invoicing",
37
66
  });
38
67
  }),
39
68
  );
@@ -20,3 +20,8 @@ export const SubscriptionLineItemEntityType$inboundSchema: z.ZodMiniType<
20
20
  SubscriptionLineItemEntityType,
21
21
  unknown
22
22
  > = openEnums.inboundSchema(SubscriptionLineItemEntityType);
23
+ /** @internal */
24
+ export const SubscriptionLineItemEntityType$outboundSchema: z.ZodMiniType<
25
+ string,
26
+ SubscriptionLineItemEntityType
27
+ > = openEnums.outboundSchema(SubscriptionLineItemEntityType);
@@ -0,0 +1,140 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v4-mini";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { ClosedEnum } from "../../types/enums.js";
8
+ import {
9
+ FilterCondition,
10
+ FilterCondition$Outbound,
11
+ FilterCondition$outboundSchema,
12
+ } from "./filter-condition.js";
13
+ import {
14
+ SortCondition,
15
+ SortCondition$Outbound,
16
+ SortCondition$outboundSchema,
17
+ } from "./sort-condition.js";
18
+ import { Status, Status$outboundSchema } from "./status.js";
19
+ import {
20
+ SubscriptionLineItemEntityType,
21
+ SubscriptionLineItemEntityType$outboundSchema,
22
+ } from "./subscription-line-item-entity-type.js";
23
+
24
+ export const SubscriptionLineItemFilterOrder = {
25
+ Asc: "asc",
26
+ Desc: "desc",
27
+ } as const;
28
+ export type SubscriptionLineItemFilterOrder = ClosedEnum<
29
+ typeof SubscriptionLineItemFilterOrder
30
+ >;
31
+
32
+ export type SubscriptionLineItemFilter = {
33
+ activeFilter?: boolean | undefined;
34
+ addonAssociationIds?: Array<string> | undefined;
35
+ billingPeriods?: Array<string> | undefined;
36
+ currencies?: Array<string> | undefined;
37
+ currentPeriodStart?: Date | undefined;
38
+ customerIds?: Array<string> | undefined;
39
+ endTime?: Date | undefined;
40
+ entityIds?: Array<string> | undefined;
41
+ entityType?: SubscriptionLineItemEntityType | undefined;
42
+ expand?: string | undefined;
43
+ filters?: Array<FilterCondition> | undefined;
44
+ limit?: number | undefined;
45
+ meterIds?: Array<string> | undefined;
46
+ offset?: number | undefined;
47
+ order?: SubscriptionLineItemFilterOrder | undefined;
48
+ priceIds?: Array<string> | undefined;
49
+ sort?: Array<SortCondition> | undefined;
50
+ startTime?: Date | undefined;
51
+ status?: Status | undefined;
52
+ /**
53
+ * Specific filters
54
+ */
55
+ subscriptionIds?: Array<string> | undefined;
56
+ };
57
+
58
+ /** @internal */
59
+ export const SubscriptionLineItemFilterOrder$outboundSchema: z.ZodMiniEnum<
60
+ typeof SubscriptionLineItemFilterOrder
61
+ > = z.enum(SubscriptionLineItemFilterOrder);
62
+
63
+ /** @internal */
64
+ export type SubscriptionLineItemFilter$Outbound = {
65
+ active_filter: boolean;
66
+ addon_association_ids?: Array<string> | undefined;
67
+ billing_periods?: Array<string> | undefined;
68
+ currencies?: Array<string> | undefined;
69
+ current_period_start?: string | undefined;
70
+ customer_ids?: Array<string> | undefined;
71
+ end_time?: string | undefined;
72
+ entity_ids?: Array<string> | undefined;
73
+ entity_type?: string | undefined;
74
+ expand?: string | undefined;
75
+ filters?: Array<FilterCondition$Outbound> | undefined;
76
+ limit?: number | undefined;
77
+ meter_ids?: Array<string> | undefined;
78
+ offset?: number | undefined;
79
+ order?: string | undefined;
80
+ price_ids?: Array<string> | undefined;
81
+ sort?: Array<SortCondition$Outbound> | undefined;
82
+ start_time?: string | undefined;
83
+ status?: string | undefined;
84
+ subscription_ids?: Array<string> | undefined;
85
+ };
86
+
87
+ /** @internal */
88
+ export const SubscriptionLineItemFilter$outboundSchema: z.ZodMiniType<
89
+ SubscriptionLineItemFilter$Outbound,
90
+ SubscriptionLineItemFilter
91
+ > = z.pipe(
92
+ z.object({
93
+ activeFilter: z._default(z.boolean(), true),
94
+ addonAssociationIds: z.optional(z.array(z.string())),
95
+ billingPeriods: z.optional(z.array(z.string())),
96
+ currencies: z.optional(z.array(z.string())),
97
+ currentPeriodStart: z.optional(
98
+ z.pipe(z.date(), z.transform(v => v.toISOString())),
99
+ ),
100
+ customerIds: z.optional(z.array(z.string())),
101
+ endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
102
+ entityIds: z.optional(z.array(z.string())),
103
+ entityType: z.optional(SubscriptionLineItemEntityType$outboundSchema),
104
+ expand: z.optional(z.string()),
105
+ filters: z.optional(z.array(FilterCondition$outboundSchema)),
106
+ limit: z.optional(z.int()),
107
+ meterIds: z.optional(z.array(z.string())),
108
+ offset: z.optional(z.int()),
109
+ order: z.optional(SubscriptionLineItemFilterOrder$outboundSchema),
110
+ priceIds: z.optional(z.array(z.string())),
111
+ sort: z.optional(z.array(SortCondition$outboundSchema)),
112
+ startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
113
+ status: z.optional(Status$outboundSchema),
114
+ subscriptionIds: z.optional(z.array(z.string())),
115
+ }),
116
+ z.transform((v) => {
117
+ return remap$(v, {
118
+ activeFilter: "active_filter",
119
+ addonAssociationIds: "addon_association_ids",
120
+ billingPeriods: "billing_periods",
121
+ currentPeriodStart: "current_period_start",
122
+ customerIds: "customer_ids",
123
+ endTime: "end_time",
124
+ entityIds: "entity_ids",
125
+ entityType: "entity_type",
126
+ meterIds: "meter_ids",
127
+ priceIds: "price_ids",
128
+ startTime: "start_time",
129
+ subscriptionIds: "subscription_ids",
130
+ });
131
+ }),
132
+ );
133
+
134
+ export function subscriptionLineItemFilterToJSON(
135
+ subscriptionLineItemFilter: SubscriptionLineItemFilter,
136
+ ): string {
137
+ return JSON.stringify(
138
+ SubscriptionLineItemFilter$outboundSchema.parse(subscriptionLineItemFilter),
139
+ );
140
+ }
@@ -74,7 +74,6 @@ export type SubscriptionLineItemResponse = {
74
74
  subscriptionId?: string | undefined;
75
75
  subscriptionPhaseId?: string | undefined;
76
76
  tenantId?: string | undefined;
77
- trialPeriod?: number | undefined;
78
77
  updatedAt?: Date | undefined;
79
78
  updatedBy?: string | undefined;
80
79
  };
@@ -121,7 +120,6 @@ export const SubscriptionLineItemResponse$inboundSchema: z.ZodMiniType<
121
120
  subscription_id: types.optional(types.string()),
122
121
  subscription_phase_id: types.optional(types.string()),
123
122
  tenant_id: types.optional(types.string()),
124
- trial_period: types.optional(types.number()),
125
123
  updated_at: types.optional(types.date()),
126
124
  updated_by: types.optional(types.string()),
127
125
  }),
@@ -157,7 +155,6 @@ export const SubscriptionLineItemResponse$inboundSchema: z.ZodMiniType<
157
155
  "subscription_id": "subscriptionId",
158
156
  "subscription_phase_id": "subscriptionPhaseId",
159
157
  "tenant_id": "tenantId",
160
- "trial_period": "trialPeriod",
161
158
  "updated_at": "updatedAt",
162
159
  "updated_by": "updatedBy",
163
160
  });
@@ -8,6 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
8
8
  export const SubscriptionModifyType = {
9
9
  Inheritance: "inheritance",
10
10
  QuantityChange: "quantity_change",
11
+ GroupedInvoicing: "grouped_invoicing",
11
12
  } as const;
12
13
  export type SubscriptionModifyType = ClosedEnum<typeof SubscriptionModifyType>;
13
14
 
@@ -55,7 +55,7 @@ export type SubscriptionPriceCreateRequest = {
55
55
  tierMode?: BillingTier | undefined;
56
56
  tiers?: Array<CreatePriceTier> | undefined;
57
57
  transformQuantity?: PriceTransformQuantity | undefined;
58
- trialPeriod?: number | undefined;
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
- trial_period?: number | undefined;
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
- trialPeriod: z.optional(z.int()),
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
- trialPeriod: "trial_period",
132
+ trialPeriodDays: "trial_period_days",
133
133
  });
134
134
  }),
135
135
  );
@@ -71,7 +71,6 @@ export type SubscriptionSubscriptionLineItem = {
71
71
  subscriptionId?: string | undefined;
72
72
  subscriptionPhaseId?: string | undefined;
73
73
  tenantId?: string | undefined;
74
- trialPeriod?: number | undefined;
75
74
  updatedAt?: Date | undefined;
76
75
  updatedBy?: string | undefined;
77
76
  };
@@ -118,7 +117,6 @@ export const SubscriptionSubscriptionLineItem$inboundSchema: z.ZodMiniType<
118
117
  subscription_id: types.optional(types.string()),
119
118
  subscription_phase_id: types.optional(types.string()),
120
119
  tenant_id: types.optional(types.string()),
121
- trial_period: types.optional(types.number()),
122
120
  updated_at: types.optional(types.date()),
123
121
  updated_by: types.optional(types.string()),
124
122
  }),
@@ -154,7 +152,6 @@ export const SubscriptionSubscriptionLineItem$inboundSchema: z.ZodMiniType<
154
152
  "subscription_id": "subscriptionId",
155
153
  "subscription_phase_id": "subscriptionPhaseId",
156
154
  "tenant_id": "tenantId",
157
- "trial_period": "trialPeriod",
158
155
  "updated_at": "updatedAt",
159
156
  "updated_by": "updatedBy",
160
157
  });
@@ -8,8 +8,10 @@ import { OpenEnum } from "../../types/enums.js";
8
8
 
9
9
  export const SubscriptionType = {
10
10
  Standalone: "standalone",
11
+ DelegatedInvoicing: "delegated_invoicing",
11
12
  Parent: "parent",
12
13
  Inherited: "inherited",
14
+ GroupedInvoicing: "grouped_invoicing",
13
15
  } as const;
14
16
  export type SubscriptionType = OpenEnum<typeof SubscriptionType>;
15
17