@stigg/typescript 0.1.0-alpha.1 → 0.1.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. package/CHANGELOG.md +148 -0
  2. package/README.md +40 -0
  3. package/client.d.mts +6 -8
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +6 -8
  6. package/client.d.ts.map +1 -1
  7. package/client.js +23 -21
  8. package/client.js.map +1 -1
  9. package/client.mjs +24 -22
  10. package/client.mjs.map +1 -1
  11. package/core/pagination.d.mts +11 -5
  12. package/core/pagination.d.mts.map +1 -1
  13. package/core/pagination.d.ts +11 -5
  14. package/core/pagination.d.ts.map +1 -1
  15. package/core/pagination.js +9 -9
  16. package/core/pagination.js.map +1 -1
  17. package/core/pagination.mjs +9 -9
  18. package/core/pagination.mjs.map +1 -1
  19. package/internal/parse.d.mts.map +1 -1
  20. package/internal/parse.d.ts.map +1 -1
  21. package/internal/parse.js +5 -0
  22. package/internal/parse.js.map +1 -1
  23. package/internal/parse.mjs +5 -0
  24. package/internal/parse.mjs.map +1 -1
  25. package/internal/qs/formats.d.mts +7 -0
  26. package/internal/qs/formats.d.mts.map +1 -0
  27. package/internal/qs/formats.d.ts +7 -0
  28. package/internal/qs/formats.d.ts.map +1 -0
  29. package/internal/qs/formats.js +13 -0
  30. package/internal/qs/formats.js.map +1 -0
  31. package/internal/qs/formats.mjs +9 -0
  32. package/internal/qs/formats.mjs.map +1 -0
  33. package/internal/qs/index.d.mts +10 -0
  34. package/internal/qs/index.d.mts.map +1 -0
  35. package/internal/qs/index.d.ts +10 -0
  36. package/internal/qs/index.d.ts.map +1 -0
  37. package/internal/qs/index.js +14 -0
  38. package/internal/qs/index.js.map +1 -0
  39. package/internal/qs/index.mjs +10 -0
  40. package/internal/qs/index.mjs.map +1 -0
  41. package/internal/qs/stringify.d.mts +3 -0
  42. package/internal/qs/stringify.d.mts.map +1 -0
  43. package/internal/qs/stringify.d.ts +3 -0
  44. package/internal/qs/stringify.d.ts.map +1 -0
  45. package/internal/qs/stringify.js +277 -0
  46. package/internal/qs/stringify.js.map +1 -0
  47. package/internal/qs/stringify.mjs +274 -0
  48. package/internal/qs/stringify.mjs.map +1 -0
  49. package/internal/qs/types.d.mts +57 -0
  50. package/internal/qs/types.d.mts.map +1 -0
  51. package/internal/qs/types.d.ts +57 -0
  52. package/internal/qs/types.d.ts.map +1 -0
  53. package/internal/qs/types.js +3 -0
  54. package/internal/qs/types.js.map +1 -0
  55. package/internal/qs/types.mjs +2 -0
  56. package/internal/qs/types.mjs.map +1 -0
  57. package/internal/qs/utils.d.mts +15 -0
  58. package/internal/qs/utils.d.mts.map +1 -0
  59. package/internal/qs/utils.d.ts +15 -0
  60. package/internal/qs/utils.d.ts.map +1 -0
  61. package/internal/qs/utils.js +230 -0
  62. package/internal/qs/utils.js.map +1 -0
  63. package/internal/qs/utils.mjs +217 -0
  64. package/internal/qs/utils.mjs.map +1 -0
  65. package/package.json +1 -1
  66. package/resources/index.d.mts +1 -1
  67. package/resources/index.d.mts.map +1 -1
  68. package/resources/index.d.ts +1 -1
  69. package/resources/index.d.ts.map +1 -1
  70. package/resources/index.js.map +1 -1
  71. package/resources/index.mjs +1 -1
  72. package/resources/index.mjs.map +1 -1
  73. package/resources/v1/coupons.d.mts +154 -157
  74. package/resources/v1/coupons.d.mts.map +1 -1
  75. package/resources/v1/coupons.d.ts +154 -157
  76. package/resources/v1/coupons.d.ts.map +1 -1
  77. package/resources/v1/coupons.js +21 -4
  78. package/resources/v1/coupons.js.map +1 -1
  79. package/resources/v1/coupons.mjs +21 -4
  80. package/resources/v1/coupons.mjs.map +1 -1
  81. package/resources/v1/customers/customers.d.mts +247 -118
  82. package/resources/v1/customers/customers.d.mts.map +1 -1
  83. package/resources/v1/customers/customers.d.ts +247 -118
  84. package/resources/v1/customers/customers.d.ts.map +1 -1
  85. package/resources/v1/customers/customers.js +37 -16
  86. package/resources/v1/customers/customers.js.map +1 -1
  87. package/resources/v1/customers/customers.mjs +37 -16
  88. package/resources/v1/customers/customers.mjs.map +1 -1
  89. package/resources/v1/customers/index.d.mts +2 -2
  90. package/resources/v1/customers/index.d.mts.map +1 -1
  91. package/resources/v1/customers/index.d.ts +2 -2
  92. package/resources/v1/customers/index.d.ts.map +1 -1
  93. package/resources/v1/customers/index.js +3 -3
  94. package/resources/v1/customers/index.js.map +1 -1
  95. package/resources/v1/customers/index.mjs +1 -1
  96. package/resources/v1/customers/index.mjs.map +1 -1
  97. package/resources/v1/customers/payment-method.d.mts +7 -2
  98. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  99. package/resources/v1/customers/payment-method.d.ts +7 -2
  100. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  101. package/resources/v1/customers/payment-method.js +4 -2
  102. package/resources/v1/customers/payment-method.js.map +1 -1
  103. package/resources/v1/customers/payment-method.mjs +4 -2
  104. package/resources/v1/customers/payment-method.mjs.map +1 -1
  105. package/resources/v1/customers/promotional-entitlements.d.mts +498 -0
  106. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -0
  107. package/resources/v1/customers/promotional-entitlements.d.ts +498 -0
  108. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -0
  109. package/resources/v1/customers/promotional-entitlements.js +32 -0
  110. package/resources/v1/customers/promotional-entitlements.js.map +1 -0
  111. package/resources/v1/customers/promotional-entitlements.mjs +28 -0
  112. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -0
  113. package/resources/v1/events/addons/addons.d.mts +605 -0
  114. package/resources/v1/events/addons/addons.d.mts.map +1 -0
  115. package/resources/v1/events/addons/addons.d.ts +605 -0
  116. package/resources/v1/events/addons/addons.d.ts.map +1 -0
  117. package/resources/v1/events/addons/addons.js +60 -0
  118. package/resources/v1/events/addons/addons.js.map +1 -0
  119. package/resources/v1/events/addons/addons.mjs +55 -0
  120. package/resources/v1/events/addons/addons.mjs.map +1 -0
  121. package/resources/v1/events/addons/draft.d.mts +121 -0
  122. package/resources/v1/events/addons/draft.d.mts.map +1 -0
  123. package/resources/v1/events/addons/draft.d.ts +121 -0
  124. package/resources/v1/events/addons/draft.d.ts.map +1 -0
  125. package/resources/v1/events/addons/draft.js +22 -0
  126. package/resources/v1/events/addons/draft.js.map +1 -0
  127. package/resources/v1/events/addons/draft.mjs +18 -0
  128. package/resources/v1/events/addons/draft.mjs.map +1 -0
  129. package/resources/v1/events/addons/index.d.mts +3 -0
  130. package/resources/v1/events/addons/index.d.mts.map +1 -0
  131. package/resources/v1/events/addons/index.d.ts +3 -0
  132. package/resources/v1/events/addons/index.d.ts.map +1 -0
  133. package/resources/v1/events/addons/index.js +9 -0
  134. package/resources/v1/events/addons/index.js.map +1 -0
  135. package/resources/v1/events/addons/index.mjs +4 -0
  136. package/resources/v1/events/addons/index.mjs.map +1 -0
  137. package/resources/v1/events/addons.d.mts +2 -0
  138. package/resources/v1/events/addons.d.mts.map +1 -0
  139. package/resources/v1/events/addons.d.ts +2 -0
  140. package/resources/v1/events/addons.d.ts.map +1 -0
  141. package/resources/v1/events/addons.js +6 -0
  142. package/resources/v1/events/addons.js.map +1 -0
  143. package/resources/v1/events/addons.mjs +3 -0
  144. package/resources/v1/events/addons.mjs.map +1 -0
  145. package/resources/v1/events/events.d.mts +75 -0
  146. package/resources/v1/events/events.d.mts.map +1 -0
  147. package/resources/v1/events/events.d.ts +75 -0
  148. package/resources/v1/events/events.d.ts.map +1 -0
  149. package/resources/v1/events/events.js +32 -0
  150. package/resources/v1/events/events.js.map +1 -0
  151. package/resources/v1/events/events.mjs +27 -0
  152. package/resources/v1/events/events.mjs.map +1 -0
  153. package/resources/v1/events/features.d.mts +856 -0
  154. package/resources/v1/events/features.d.mts.map +1 -0
  155. package/resources/v1/events/features.d.ts +856 -0
  156. package/resources/v1/events/features.d.ts.map +1 -0
  157. package/resources/v1/events/features.js +51 -0
  158. package/resources/v1/events/features.js.map +1 -0
  159. package/resources/v1/events/features.mjs +47 -0
  160. package/resources/v1/events/features.mjs.map +1 -0
  161. package/resources/v1/events/index.d.mts +5 -0
  162. package/resources/v1/events/index.d.mts.map +1 -0
  163. package/resources/v1/events/index.d.ts +5 -0
  164. package/resources/v1/events/index.d.ts.map +1 -0
  165. package/resources/v1/events/index.js +13 -0
  166. package/resources/v1/events/index.js.map +1 -0
  167. package/resources/v1/events/index.mjs +6 -0
  168. package/resources/v1/events/index.mjs.map +1 -0
  169. package/resources/v1/events/plans.d.mts +348 -0
  170. package/resources/v1/events/plans.d.mts.map +1 -0
  171. package/resources/v1/events/plans.d.ts +348 -0
  172. package/resources/v1/events/plans.d.ts.map +1 -0
  173. package/resources/v1/events/plans.js +30 -0
  174. package/resources/v1/events/plans.js.map +1 -0
  175. package/resources/v1/events/plans.mjs +26 -0
  176. package/resources/v1/events/plans.mjs.map +1 -0
  177. package/resources/v1/events.d.mts +2 -0
  178. package/resources/v1/events.d.mts.map +1 -0
  179. package/resources/v1/events.d.ts +2 -0
  180. package/resources/v1/events.d.ts.map +1 -0
  181. package/resources/v1/events.js +6 -0
  182. package/resources/v1/events.js.map +1 -0
  183. package/resources/v1/events.mjs +3 -0
  184. package/resources/v1/events.mjs.map +1 -0
  185. package/resources/v1/index.d.mts +7 -4
  186. package/resources/v1/index.d.mts.map +1 -1
  187. package/resources/v1/index.d.ts +7 -4
  188. package/resources/v1/index.d.ts.map +1 -1
  189. package/resources/v1/index.js +9 -3
  190. package/resources/v1/index.js.map +1 -1
  191. package/resources/v1/index.mjs +4 -1
  192. package/resources/v1/index.mjs.map +1 -1
  193. package/resources/v1/products.d.mts +676 -0
  194. package/resources/v1/products.d.mts.map +1 -0
  195. package/resources/v1/products.d.ts +676 -0
  196. package/resources/v1/products.d.ts.map +1 -0
  197. package/resources/v1/products.js +52 -0
  198. package/resources/v1/products.js.map +1 -0
  199. package/resources/v1/products.mjs +48 -0
  200. package/resources/v1/products.mjs.map +1 -0
  201. package/resources/v1/subscriptions/future-update.d.mts +12 -19
  202. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  203. package/resources/v1/subscriptions/future-update.d.ts +12 -19
  204. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  205. package/resources/v1/subscriptions/future-update.js +3 -2
  206. package/resources/v1/subscriptions/future-update.js.map +1 -1
  207. package/resources/v1/subscriptions/future-update.mjs +3 -2
  208. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  209. package/resources/v1/subscriptions/index.d.mts +4 -2
  210. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  211. package/resources/v1/subscriptions/index.d.ts +4 -2
  212. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  213. package/resources/v1/subscriptions/index.js +5 -1
  214. package/resources/v1/subscriptions/index.js.map +1 -1
  215. package/resources/v1/subscriptions/index.mjs +3 -1
  216. package/resources/v1/subscriptions/index.mjs.map +1 -1
  217. package/resources/v1/subscriptions/invoice.d.mts +34 -0
  218. package/resources/v1/subscriptions/invoice.d.mts.map +1 -0
  219. package/resources/v1/subscriptions/invoice.d.ts +34 -0
  220. package/resources/v1/subscriptions/invoice.d.ts.map +1 -0
  221. package/resources/v1/subscriptions/invoice.js +17 -0
  222. package/resources/v1/subscriptions/invoice.js.map +1 -0
  223. package/resources/v1/subscriptions/invoice.mjs +13 -0
  224. package/resources/v1/subscriptions/invoice.mjs.map +1 -0
  225. package/resources/v1/subscriptions/subscriptions.d.mts +1545 -518
  226. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  227. package/resources/v1/subscriptions/subscriptions.d.ts +1545 -518
  228. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  229. package/resources/v1/subscriptions/subscriptions.js +52 -12
  230. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  231. package/resources/v1/subscriptions/subscriptions.mjs +53 -13
  232. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  233. package/resources/v1/subscriptions/usage.d.mts +98 -0
  234. package/resources/v1/subscriptions/usage.d.mts.map +1 -0
  235. package/resources/v1/subscriptions/usage.d.ts +98 -0
  236. package/resources/v1/subscriptions/usage.d.ts.map +1 -0
  237. package/resources/v1/subscriptions/usage.js +24 -0
  238. package/resources/v1/subscriptions/usage.js.map +1 -0
  239. package/resources/v1/subscriptions/usage.mjs +20 -0
  240. package/resources/v1/subscriptions/usage.mjs.map +1 -0
  241. package/resources/v1/usage.d.mts +230 -0
  242. package/resources/v1/usage.d.mts.map +1 -0
  243. package/resources/v1/usage.d.ts +230 -0
  244. package/resources/v1/usage.d.ts.map +1 -0
  245. package/resources/v1/usage.js +24 -0
  246. package/resources/v1/usage.js.map +1 -0
  247. package/resources/v1/usage.mjs +20 -0
  248. package/resources/v1/usage.mjs.map +1 -0
  249. package/resources/v1/v1.d.mts +18 -149
  250. package/resources/v1/v1.d.mts.map +1 -1
  251. package/resources/v1/v1.d.ts +18 -149
  252. package/resources/v1/v1.d.ts.map +1 -1
  253. package/resources/v1/v1.js +12 -12
  254. package/resources/v1/v1.js.map +1 -1
  255. package/resources/v1/v1.mjs +12 -12
  256. package/resources/v1/v1.mjs.map +1 -1
  257. package/src/client.ts +33 -40
  258. package/src/core/pagination.ts +24 -18
  259. package/src/internal/parse.ts +6 -0
  260. package/src/internal/qs/LICENSE.md +13 -0
  261. package/src/internal/qs/README.md +3 -0
  262. package/src/internal/qs/formats.ts +10 -0
  263. package/src/internal/qs/index.ts +13 -0
  264. package/src/internal/qs/stringify.ts +385 -0
  265. package/src/internal/qs/types.ts +71 -0
  266. package/src/internal/qs/utils.ts +265 -0
  267. package/src/resources/index.ts +1 -7
  268. package/src/resources/v1/coupons.ts +311 -436
  269. package/src/resources/v1/customers/customers.ts +334 -153
  270. package/src/resources/v1/customers/index.ts +17 -2
  271. package/src/resources/v1/customers/payment-method.ts +7 -2
  272. package/src/resources/v1/customers/promotional-entitlements.ts +669 -0
  273. package/src/resources/v1/events/addons/addons.ts +761 -0
  274. package/src/resources/v1/events/addons/draft.ts +151 -0
  275. package/src/resources/v1/events/addons/index.ts +17 -0
  276. package/src/resources/v1/events/addons.ts +3 -0
  277. package/src/resources/v1/events/events.ts +160 -0
  278. package/src/resources/v1/events/features.ts +1066 -0
  279. package/src/resources/v1/events/index.ts +39 -0
  280. package/src/resources/v1/events/plans.ts +429 -0
  281. package/src/resources/v1/events.ts +3 -0
  282. package/src/resources/v1/index.ts +40 -15
  283. package/src/resources/v1/products.ts +834 -0
  284. package/src/resources/v1/subscriptions/future-update.ts +12 -27
  285. package/src/resources/v1/subscriptions/index.ts +16 -11
  286. package/src/resources/v1/subscriptions/invoice.ts +42 -0
  287. package/src/resources/v1/subscriptions/subscriptions.ts +3316 -832
  288. package/src/resources/v1/subscriptions/usage.ts +126 -0
  289. package/src/resources/v1/usage.ts +284 -0
  290. package/src/resources/v1/v1.ts +96 -197
  291. package/src/version.ts +1 -1
  292. package/version.d.mts +1 -1
  293. package/version.d.mts.map +1 -1
  294. package/version.d.ts +1 -1
  295. package/version.d.ts.map +1 -1
  296. package/version.js +1 -1
  297. package/version.js.map +1 -1
  298. package/version.mjs +1 -1
  299. package/version.mjs.map +1 -1
  300. package/resources/v1/customers/usage.d.mts +0 -98
  301. package/resources/v1/customers/usage.d.mts.map +0 -1
  302. package/resources/v1/customers/usage.d.ts +0 -98
  303. package/resources/v1/customers/usage.d.ts.map +0 -1
  304. package/resources/v1/customers/usage.js +0 -20
  305. package/resources/v1/customers/usage.js.map +0 -1
  306. package/resources/v1/customers/usage.mjs +0 -16
  307. package/resources/v1/customers/usage.mjs.map +0 -1
  308. package/src/resources/v1/customers/usage.ts +0 -132
@@ -1,157 +1,82 @@
1
1
  import { APIResource } from "../../../core/resource.mjs";
2
2
  import * as FutureUpdateAPI from "./future-update.mjs";
3
- import { FutureUpdate, FutureUpdateCancelPendingPaymentResponse, FutureUpdateCancelScheduleResponse } from "./future-update.mjs";
3
+ import { CancelSubscription, FutureUpdate } from "./future-update.mjs";
4
+ import * as InvoiceAPI from "./invoice.mjs";
5
+ import { Invoice, InvoiceMarkAsPaidResponse } from "./invoice.mjs";
6
+ import * as UsageAPI from "./usage.mjs";
7
+ import { Usage, UsageChargeUsageParams, UsageChargeUsageResponse, UsageSyncResponse } from "./usage.mjs";
4
8
  import { APIPromise } from "../../../core/api-promise.mjs";
9
+ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
5
10
  import { RequestOptions } from "../../../internal/request-options.mjs";
6
11
  export declare class Subscriptions extends APIResource {
7
12
  futureUpdate: FutureUpdateAPI.FutureUpdate;
13
+ usage: UsageAPI.Usage;
14
+ invoice: InvoiceAPI.Invoice;
8
15
  /**
9
- * Create a new Subscription
16
+ * Retrieves a subscription by its unique identifier, including plan details,
17
+ * billing period, status, and add-ons.
10
18
  */
11
- create(body: SubscriptionCreateParams, options?: RequestOptions): APIPromise<SubscriptionCreateResponse>;
19
+ retrieve(id: string, options?: RequestOptions): APIPromise<Subscription>;
12
20
  /**
13
- * Get a single Subscription by id
21
+ * Updates an active subscription's properties including billing period, add-ons,
22
+ * unit quantities, and discounts.
14
23
  */
15
- retrieve(id: string, options?: RequestOptions): APIPromise<SubscriptionRetrieveResponse>;
24
+ update(id: string, body: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
16
25
  /**
17
- * Get a list of Subscriptions
26
+ * Retrieves a paginated list of subscriptions, with optional filters for customer,
27
+ * status, and plan.
18
28
  */
19
- list(query?: SubscriptionListParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionListResponse>;
29
+ list(query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
20
30
  /**
21
- * Perform delegate on a Subscription
31
+ * Cancels an active subscription, either immediately or at a specified time such
32
+ * as end of billing period.
22
33
  */
23
- delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<SubscriptionDelegateResponse>;
34
+ cancel(id: string, body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
24
35
  /**
25
- * Perform migrate to latest plan version on a Subscription
36
+ * Delegates the payment responsibility of a subscription to a different customer.
37
+ * The delegated customer will be billed for this subscription.
26
38
  */
27
- migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<SubscriptionMigrateResponse>;
39
+ delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
28
40
  /**
29
- * Create a new Subscription Preview
41
+ * Imports multiple subscriptions in bulk. Used for migrating subscription data
42
+ * from external systems.
43
+ */
44
+ import(body: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
45
+ /**
46
+ * Migrates a subscription to the latest published version of its plan or add-ons.
47
+ * Handles prorated charges or credits automatically.
48
+ */
49
+ migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
50
+ /**
51
+ * Previews the pricing impact of creating or updating a subscription without
52
+ * making changes. Returns estimated costs, taxes, and proration details.
30
53
  */
31
54
  preview(body: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
32
55
  /**
33
- * Perform transfer to resource on a Subscription
56
+ * Creates a new subscription for an existing customer. When payment is required
57
+ * and no payment method exists, returns a checkout URL.
34
58
  */
35
- transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<SubscriptionTransferResponse>;
36
- }
37
- export interface SubscriptionCreateResponse {
38
- data: SubscriptionCreateResponse.Data;
39
- }
40
- export declare namespace SubscriptionCreateResponse {
41
- interface Data {
42
- /**
43
- * Unique identifier for the provisioned subscription
44
- */
45
- id: string;
46
- /**
47
- * Provision status: SUCCESS or PAYMENT_REQUIRED
48
- */
49
- status: 'SUCCESS' | 'PAYMENT_REQUIRED';
50
- /**
51
- * Checkout billing ID when payment is required
52
- */
53
- checkoutBillingId?: string | null;
54
- /**
55
- * URL to complete payment when PAYMENT_REQUIRED
56
- */
57
- checkoutUrl?: string | null;
58
- /**
59
- * Whether the subscription is scheduled for future activation
60
- */
61
- isScheduled?: boolean;
62
- subscription?: Data.Subscription;
63
- }
64
- namespace Data {
65
- interface Subscription {
66
- /**
67
- * Subscription ID
68
- */
69
- id: string;
70
- /**
71
- * Billing ID
72
- */
73
- billingId: string | null;
74
- /**
75
- * Created at
76
- */
77
- createdAt: string;
78
- /**
79
- * Customer ID
80
- */
81
- customerId: string;
82
- /**
83
- * Payment collection
84
- */
85
- paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
86
- /**
87
- * Plan ID
88
- */
89
- planId: string;
90
- /**
91
- * Pricing type
92
- */
93
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
94
- /**
95
- * Subscription start date
96
- */
97
- startDate: string;
98
- /**
99
- * Subscription status
100
- */
101
- status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
102
- /**
103
- * Subscription cancellation date
104
- */
105
- cancellationDate?: string | null;
106
- /**
107
- * Subscription cancel reason
108
- */
109
- cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
110
- /**
111
- * End of the current billing period
112
- */
113
- currentBillingPeriodEnd?: string | null;
114
- /**
115
- * Start of the current billing period
116
- */
117
- currentBillingPeriodStart?: string | null;
118
- /**
119
- * Subscription effective end date
120
- */
121
- effectiveEndDate?: string | null;
122
- /**
123
- * Subscription end date
124
- */
125
- endDate?: string | null;
126
- /**
127
- * Additional metadata for the subscription
128
- */
129
- metadata?: {
130
- [key: string]: string;
131
- };
132
- /**
133
- * Paying customer ID for delegated billing
134
- */
135
- payingCustomerId?: string | null;
136
- /**
137
- * The method used to collect payments for a subscription
138
- */
139
- paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
140
- /**
141
- * Resource ID
142
- */
143
- resourceId?: string | null;
144
- /**
145
- * Subscription trial end date
146
- */
147
- trialEndDate?: string | null;
148
- }
149
- }
59
+ provision(body: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
60
+ /**
61
+ * Transfers a subscription to a different resource ID. Used for multi-resource
62
+ * products where subscriptions apply to specific entities like websites or apps.
63
+ */
64
+ transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
150
65
  }
151
- export interface SubscriptionRetrieveResponse {
152
- data: SubscriptionRetrieveResponse.Data;
66
+ export type SubscriptionListResponsesMyCursorIDPage = MyCursorIDPage<SubscriptionListResponse>;
67
+ /**
68
+ * Response object
69
+ */
70
+ export interface Subscription {
71
+ /**
72
+ * Customer subscription to a plan
73
+ */
74
+ data: Subscription.Data;
153
75
  }
154
- export declare namespace SubscriptionRetrieveResponse {
76
+ export declare namespace Subscription {
77
+ /**
78
+ * Customer subscription to a plan
79
+ */
155
80
  interface Data {
156
81
  /**
157
82
  * Subscription ID
@@ -227,6 +152,7 @@ export declare namespace SubscriptionRetrieveResponse {
227
152
  * The method used to collect payments for a subscription
228
153
  */
229
154
  paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
155
+ prices?: Array<Data.Price>;
230
156
  /**
231
157
  * Resource ID
232
158
  */
@@ -236,303 +162,228 @@ export declare namespace SubscriptionRetrieveResponse {
236
162
  */
237
163
  trialEndDate?: string | null;
238
164
  }
165
+ namespace Data {
166
+ interface Price {
167
+ /**
168
+ * Price ID
169
+ */
170
+ id: string;
171
+ /**
172
+ * Creation timestamp
173
+ */
174
+ createdAt: string;
175
+ /**
176
+ * Last update timestamp
177
+ */
178
+ updatedAt: string;
179
+ [k: string]: unknown;
180
+ }
181
+ }
239
182
  }
183
+ /**
184
+ * Customer subscription to a plan
185
+ */
240
186
  export interface SubscriptionListResponse {
241
- data: Array<SubscriptionListResponse.Data>;
187
+ /**
188
+ * Subscription ID
189
+ */
190
+ id: string;
191
+ /**
192
+ * Billing ID
193
+ */
194
+ billingId: string | null;
195
+ /**
196
+ * Created at
197
+ */
198
+ createdAt: string;
199
+ /**
200
+ * Customer ID
201
+ */
202
+ customerId: string;
203
+ /**
204
+ * Payment collection
205
+ */
206
+ paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
207
+ /**
208
+ * Plan ID
209
+ */
210
+ planId: string;
211
+ /**
212
+ * Pricing type
213
+ */
214
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
215
+ /**
216
+ * Subscription start date
217
+ */
218
+ startDate: string;
219
+ /**
220
+ * Subscription status
221
+ */
222
+ status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
223
+ /**
224
+ * Subscription cancellation date
225
+ */
226
+ cancellationDate?: string | null;
227
+ /**
228
+ * Subscription cancel reason
229
+ */
230
+ cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
231
+ /**
232
+ * End of the current billing period
233
+ */
234
+ currentBillingPeriodEnd?: string | null;
235
+ /**
236
+ * Start of the current billing period
237
+ */
238
+ currentBillingPeriodStart?: string | null;
239
+ /**
240
+ * Subscription effective end date
241
+ */
242
+ effectiveEndDate?: string | null;
243
+ /**
244
+ * Subscription end date
245
+ */
246
+ endDate?: string | null;
247
+ /**
248
+ * Additional metadata for the subscription
249
+ */
250
+ metadata?: {
251
+ [key: string]: string;
252
+ };
253
+ /**
254
+ * Paying customer ID for delegated billing
255
+ */
256
+ payingCustomerId?: string | null;
257
+ /**
258
+ * The method used to collect payments for a subscription
259
+ */
260
+ paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
261
+ prices?: Array<SubscriptionListResponse.Price>;
262
+ /**
263
+ * Resource ID
264
+ */
265
+ resourceId?: string | null;
266
+ /**
267
+ * Subscription trial end date
268
+ */
269
+ trialEndDate?: string | null;
242
270
  }
243
271
  export declare namespace SubscriptionListResponse {
244
- interface Data {
272
+ interface Price {
245
273
  /**
246
- * Subscription ID
274
+ * Price ID
247
275
  */
248
276
  id: string;
249
277
  /**
250
- * Billing ID
251
- */
252
- billingId: string | null;
253
- /**
254
- * Created at
278
+ * Creation timestamp
255
279
  */
256
280
  createdAt: string;
257
281
  /**
258
- * Cursor ID for query pagination
259
- */
260
- cursorId: string;
261
- /**
262
- * Customer ID
263
- */
264
- customerId: string;
265
- /**
266
- * Payment collection
267
- */
268
- paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
269
- /**
270
- * Plan ID
271
- */
272
- planId: string;
273
- /**
274
- * Pricing type
275
- */
276
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
277
- /**
278
- * Subscription start date
279
- */
280
- startDate: string;
281
- /**
282
- * Subscription status
283
- */
284
- status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
285
- /**
286
- * Subscription cancellation date
282
+ * Last update timestamp
287
283
  */
288
- cancellationDate?: string | null;
284
+ updatedAt: string;
285
+ [k: string]: unknown;
286
+ }
287
+ }
288
+ /**
289
+ * Response object
290
+ */
291
+ export interface SubscriptionImportResponse {
292
+ data: SubscriptionImportResponse.Data;
293
+ }
294
+ export declare namespace SubscriptionImportResponse {
295
+ interface Data {
289
296
  /**
290
- * Subscription cancel reason
297
+ * Unique identifier for the import task
291
298
  */
292
- cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
299
+ taskId: string;
300
+ }
301
+ }
302
+ /**
303
+ * Response object
304
+ */
305
+ export interface SubscriptionPreviewResponse {
306
+ /**
307
+ * Pricing preview with invoices
308
+ */
309
+ data: SubscriptionPreviewResponse.Data;
310
+ }
311
+ export declare namespace SubscriptionPreviewResponse {
312
+ /**
313
+ * Pricing preview with invoices
314
+ */
315
+ interface Data {
293
316
  /**
294
- * End of the current billing period
317
+ * Invoice due immediately
295
318
  */
296
- currentBillingPeriodEnd?: string | null;
319
+ immediateInvoice: Data.ImmediateInvoice;
297
320
  /**
298
- * Start of the current billing period
321
+ * Billing period range
299
322
  */
300
- currentBillingPeriodStart?: string | null;
323
+ billingPeriodRange?: Data.BillingPeriodRange;
301
324
  /**
302
- * Subscription effective end date
325
+ * Free items included
303
326
  */
304
- effectiveEndDate?: string | null;
327
+ freeItems?: Array<Data.FreeItem>;
305
328
  /**
306
- * Subscription end date
329
+ * Whether updates are scheduled
307
330
  */
308
- endDate?: string | null;
331
+ hasScheduledUpdates?: boolean;
309
332
  /**
310
- * Additional metadata for the subscription
333
+ * Whether this is a downgrade
311
334
  */
312
- metadata?: {
313
- [key: string]: string;
314
- };
335
+ isPlanDowngrade?: boolean;
315
336
  /**
316
- * Paying customer ID for delegated billing
337
+ * Recurring invoice preview
317
338
  */
318
- payingCustomerId?: string | null;
339
+ recurringInvoice?: Data.RecurringInvoice;
340
+ }
341
+ namespace Data {
319
342
  /**
320
- * The method used to collect payments for a subscription
343
+ * Invoice due immediately
321
344
  */
322
- paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
323
- /**
324
- * Resource ID
325
- */
326
- resourceId?: string | null;
327
- /**
328
- * Subscription trial end date
329
- */
330
- trialEndDate?: string | null;
331
- }
332
- }
333
- export interface SubscriptionDelegateResponse {
334
- data: SubscriptionDelegateResponse.Data;
335
- }
336
- export declare namespace SubscriptionDelegateResponse {
337
- interface Data {
338
- /**
339
- * Subscription ID
340
- */
341
- id: string;
342
- /**
343
- * Billing ID
344
- */
345
- billingId: string | null;
346
- /**
347
- * Created at
348
- */
349
- createdAt: string;
350
- /**
351
- * Customer ID
352
- */
353
- customerId: string;
354
- /**
355
- * Payment collection
356
- */
357
- paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
358
- /**
359
- * Plan ID
360
- */
361
- planId: string;
362
- /**
363
- * Pricing type
364
- */
365
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
366
- /**
367
- * Subscription start date
368
- */
369
- startDate: string;
370
- /**
371
- * Subscription status
372
- */
373
- status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
374
- /**
375
- * Subscription cancellation date
376
- */
377
- cancellationDate?: string | null;
378
- /**
379
- * Subscription cancel reason
380
- */
381
- cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
382
- /**
383
- * End of the current billing period
384
- */
385
- currentBillingPeriodEnd?: string | null;
386
- /**
387
- * Start of the current billing period
388
- */
389
- currentBillingPeriodStart?: string | null;
390
- /**
391
- * Subscription effective end date
392
- */
393
- effectiveEndDate?: string | null;
394
- /**
395
- * Subscription end date
396
- */
397
- endDate?: string | null;
398
- /**
399
- * Additional metadata for the subscription
400
- */
401
- metadata?: {
402
- [key: string]: string;
403
- };
404
- /**
405
- * Paying customer ID for delegated billing
406
- */
407
- payingCustomerId?: string | null;
408
- /**
409
- * The method used to collect payments for a subscription
410
- */
411
- paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
412
- /**
413
- * Resource ID
414
- */
415
- resourceId?: string | null;
416
- /**
417
- * Subscription trial end date
418
- */
419
- trialEndDate?: string | null;
420
- }
421
- }
422
- export interface SubscriptionMigrateResponse {
423
- data: SubscriptionMigrateResponse.Data;
424
- }
425
- export declare namespace SubscriptionMigrateResponse {
426
- interface Data {
427
- /**
428
- * Subscription ID
429
- */
430
- id: string;
431
- /**
432
- * Billing ID
433
- */
434
- billingId: string | null;
435
- /**
436
- * Created at
437
- */
438
- createdAt: string;
439
- /**
440
- * Customer ID
441
- */
442
- customerId: string;
443
- /**
444
- * Payment collection
445
- */
446
- paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
447
- /**
448
- * Plan ID
449
- */
450
- planId: string;
451
- /**
452
- * Pricing type
453
- */
454
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
455
- /**
456
- * Subscription start date
457
- */
458
- startDate: string;
459
- /**
460
- * Subscription status
461
- */
462
- status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
463
- /**
464
- * Subscription cancellation date
465
- */
466
- cancellationDate?: string | null;
467
- /**
468
- * Subscription cancel reason
469
- */
470
- cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
471
- /**
472
- * End of the current billing period
473
- */
474
- currentBillingPeriodEnd?: string | null;
475
- /**
476
- * Start of the current billing period
477
- */
478
- currentBillingPeriodStart?: string | null;
479
- /**
480
- * Subscription effective end date
481
- */
482
- effectiveEndDate?: string | null;
483
- /**
484
- * Subscription end date
485
- */
486
- endDate?: string | null;
487
- /**
488
- * Additional metadata for the subscription
489
- */
490
- metadata?: {
491
- [key: string]: string;
492
- };
493
- /**
494
- * Paying customer ID for delegated billing
495
- */
496
- payingCustomerId?: string | null;
497
- /**
498
- * The method used to collect payments for a subscription
499
- */
500
- paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
501
- /**
502
- * Resource ID
503
- */
504
- resourceId?: string | null;
505
- /**
506
- * Subscription trial end date
507
- */
508
- trialEndDate?: string | null;
509
- }
510
- }
511
- export interface SubscriptionPreviewResponse {
512
- data: SubscriptionPreviewResponse.Data;
513
- }
514
- export declare namespace SubscriptionPreviewResponse {
515
- interface Data {
516
- immediateInvoice: Data.ImmediateInvoice;
517
- billingPeriodRange?: Data.BillingPeriodRange;
518
- freeItems?: Array<Data.FreeItem>;
519
- hasScheduledUpdates?: boolean;
520
- isPlanDowngrade?: boolean;
521
- recurringInvoice?: Data.RecurringInvoice;
522
- }
523
- namespace Data {
524
345
  interface ImmediateInvoice {
346
+ /**
347
+ * Subtotal before discounts
348
+ */
525
349
  subTotal: number;
350
+ /**
351
+ * Invoice total
352
+ */
526
353
  total: number;
354
+ /**
355
+ * Billing period covered
356
+ */
527
357
  billingPeriodRange?: ImmediateInvoice.BillingPeriodRange;
358
+ /**
359
+ * Currency code
360
+ */
528
361
  currency?: string | null;
362
+ /**
363
+ * Total discount amount
364
+ */
529
365
  discount?: number;
366
+ /**
367
+ * Discount breakdown
368
+ */
530
369
  discountDetails?: ImmediateInvoice.DiscountDetails;
370
+ /**
371
+ * Applied discounts
372
+ */
531
373
  discounts?: Array<ImmediateInvoice.Discount>;
374
+ /**
375
+ * Line items
376
+ */
532
377
  lines?: Array<ImmediateInvoice.Line>;
378
+ /**
379
+ * Tax amount
380
+ */
533
381
  tax?: number;
534
382
  }
535
383
  namespace ImmediateInvoice {
384
+ /**
385
+ * Billing period covered
386
+ */
536
387
  interface BillingPeriodRange {
537
388
  /**
538
389
  * Billing period end date
@@ -543,24 +394,69 @@ export declare namespace SubscriptionPreviewResponse {
543
394
  */
544
395
  start: string;
545
396
  }
397
+ /**
398
+ * Discount breakdown
399
+ */
546
400
  interface DiscountDetails {
401
+ /**
402
+ * Promo code used
403
+ */
547
404
  code?: string;
405
+ /**
406
+ * Fixed discount amount
407
+ */
548
408
  fixedAmount?: number;
409
+ /**
410
+ * Percentage discount
411
+ */
549
412
  percentage?: number;
550
413
  }
414
+ /**
415
+ * Applied discount amount
416
+ */
551
417
  interface Discount {
418
+ /**
419
+ * Discount amount
420
+ */
552
421
  amount: number;
422
+ /**
423
+ * Currency code
424
+ */
553
425
  currency: string;
426
+ /**
427
+ * Discount description
428
+ */
554
429
  description: string;
555
430
  }
431
+ /**
432
+ * Invoice line item
433
+ */
556
434
  interface Line {
435
+ /**
436
+ * Currency code
437
+ */
557
438
  currency: string;
439
+ /**
440
+ * Line item description
441
+ */
558
442
  description: string;
443
+ /**
444
+ * Line subtotal
445
+ */
559
446
  subTotal: number;
447
+ /**
448
+ * Price per unit
449
+ */
560
450
  unitPrice: number;
451
+ /**
452
+ * Quantity
453
+ */
561
454
  quantity?: number;
562
455
  }
563
456
  }
457
+ /**
458
+ * Billing period range
459
+ */
564
460
  interface BillingPeriodRange {
565
461
  /**
566
462
  * Billing period end date
@@ -571,22 +467,64 @@ export declare namespace SubscriptionPreviewResponse {
571
467
  */
572
468
  start?: string;
573
469
  }
470
+ /**
471
+ * Free item in subscription
472
+ */
574
473
  interface FreeItem {
474
+ /**
475
+ * Addon ID
476
+ */
575
477
  addonId: string;
478
+ /**
479
+ * Quantity
480
+ */
576
481
  quantity: number;
577
482
  }
483
+ /**
484
+ * Recurring invoice preview
485
+ */
578
486
  interface RecurringInvoice {
487
+ /**
488
+ * Subtotal before discounts
489
+ */
579
490
  subTotal: number;
580
- total: number;
491
+ /**
492
+ * Invoice total
493
+ */
494
+ total: number;
495
+ /**
496
+ * Billing period covered
497
+ */
581
498
  billingPeriodRange?: RecurringInvoice.BillingPeriodRange;
499
+ /**
500
+ * Currency code
501
+ */
582
502
  currency?: string | null;
503
+ /**
504
+ * Total discount amount
505
+ */
583
506
  discount?: number;
507
+ /**
508
+ * Discount breakdown
509
+ */
584
510
  discountDetails?: RecurringInvoice.DiscountDetails;
511
+ /**
512
+ * Applied discounts
513
+ */
585
514
  discounts?: Array<RecurringInvoice.Discount>;
515
+ /**
516
+ * Line items
517
+ */
586
518
  lines?: Array<RecurringInvoice.Line>;
519
+ /**
520
+ * Tax amount
521
+ */
587
522
  tax?: number;
588
523
  }
589
524
  namespace RecurringInvoice {
525
+ /**
526
+ * Billing period covered
527
+ */
590
528
  interface BillingPeriodRange {
591
529
  /**
592
530
  * Billing period end date
@@ -597,87 +535,677 @@ export declare namespace SubscriptionPreviewResponse {
597
535
  */
598
536
  start: string;
599
537
  }
538
+ /**
539
+ * Discount breakdown
540
+ */
600
541
  interface DiscountDetails {
542
+ /**
543
+ * Promo code used
544
+ */
601
545
  code?: string;
546
+ /**
547
+ * Fixed discount amount
548
+ */
602
549
  fixedAmount?: number;
550
+ /**
551
+ * Percentage discount
552
+ */
603
553
  percentage?: number;
604
554
  }
555
+ /**
556
+ * Applied discount amount
557
+ */
605
558
  interface Discount {
559
+ /**
560
+ * Discount amount
561
+ */
606
562
  amount: number;
563
+ /**
564
+ * Currency code
565
+ */
607
566
  currency: string;
567
+ /**
568
+ * Discount description
569
+ */
608
570
  description: string;
609
571
  }
572
+ /**
573
+ * Invoice line item
574
+ */
610
575
  interface Line {
576
+ /**
577
+ * Currency code
578
+ */
611
579
  currency: string;
580
+ /**
581
+ * Line item description
582
+ */
612
583
  description: string;
584
+ /**
585
+ * Line subtotal
586
+ */
613
587
  subTotal: number;
588
+ /**
589
+ * Price per unit
590
+ */
614
591
  unitPrice: number;
592
+ /**
593
+ * Quantity
594
+ */
615
595
  quantity?: number;
616
596
  }
617
597
  }
618
598
  }
619
599
  }
620
- export interface SubscriptionTransferResponse {
621
- data: SubscriptionTransferResponse.Data;
600
+ /**
601
+ * Response object
602
+ */
603
+ export interface SubscriptionProvisionResponse {
604
+ /**
605
+ * Provisioning result with status and subscription or checkout URL.
606
+ */
607
+ data: SubscriptionProvisionResponse.Data;
622
608
  }
623
- export declare namespace SubscriptionTransferResponse {
609
+ export declare namespace SubscriptionProvisionResponse {
610
+ /**
611
+ * Provisioning result with status and subscription or checkout URL.
612
+ */
624
613
  interface Data {
625
614
  /**
626
- * Subscription ID
615
+ * Unique identifier for the provisioned subscription
627
616
  */
628
617
  id: string;
618
+ entitlements: Array<Data.UnionObjectVariant0 | Data.UnionObjectVariant1> | null;
629
619
  /**
630
- * Billing ID
620
+ * Provision status: SUCCESS or PAYMENT_REQUIRED
631
621
  */
632
- billingId: string | null;
622
+ status: 'SUCCESS' | 'PAYMENT_REQUIRED';
633
623
  /**
634
- * Created at
624
+ * Created subscription (when status is SUCCESS)
635
625
  */
636
- createdAt: string;
626
+ subscription: Data.Subscription | null;
637
627
  /**
638
- * Customer ID
628
+ * Checkout billing ID when payment is required
639
629
  */
640
- customerId: string;
630
+ checkoutBillingId?: string;
641
631
  /**
642
- * Payment collection
632
+ * URL to complete payment when PAYMENT_REQUIRED
643
633
  */
644
- paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
634
+ checkoutUrl?: string;
645
635
  /**
646
- * Plan ID
636
+ * Whether the subscription is scheduled for future activation
647
637
  */
648
- planId: string;
638
+ isScheduled?: boolean;
639
+ }
640
+ namespace Data {
641
+ interface UnionObjectVariant0 {
642
+ accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
643
+ isGranted: boolean;
644
+ type: 'FEATURE';
645
+ currentUsage?: number;
646
+ /**
647
+ * Timestamp of the last update to the entitlement grant or configuration.
648
+ */
649
+ entitlementUpdatedAt?: string;
650
+ feature?: UnionObjectVariant0.Feature;
651
+ hasUnlimitedUsage?: boolean;
652
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
653
+ usageLimit?: number | null;
654
+ /**
655
+ * The anchor for calculating the usage period for metered entitlements with a
656
+ * reset period configured
657
+ */
658
+ usagePeriodAnchor?: string;
659
+ /**
660
+ * The end date of the usage period for metered entitlements with a reset period
661
+ * configured
662
+ */
663
+ usagePeriodEnd?: string;
664
+ /**
665
+ * The start date of the usage period for metered entitlements with a reset period
666
+ * configured
667
+ */
668
+ usagePeriodStart?: string;
669
+ /**
670
+ * The next time the entitlement should be recalculated
671
+ */
672
+ validUntil?: string;
673
+ }
674
+ namespace UnionObjectVariant0 {
675
+ interface Feature {
676
+ /**
677
+ * The human-readable name of the entitlement, shown in UI elements.
678
+ */
679
+ displayName: string;
680
+ /**
681
+ * The current status of the feature.
682
+ */
683
+ featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
684
+ /**
685
+ * The type of feature associated with the entitlement.
686
+ */
687
+ featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
688
+ /**
689
+ * The unique reference ID of the entitlement.
690
+ */
691
+ refId: string;
692
+ }
693
+ }
694
+ interface UnionObjectVariant1 {
695
+ accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
696
+ /**
697
+ * The currency associated with a credit entitlement.
698
+ */
699
+ currency: UnionObjectVariant1.Currency;
700
+ currentUsage: number;
701
+ isGranted: boolean;
702
+ type: 'CREDIT';
703
+ usageLimit: number;
704
+ /**
705
+ * Timestamp of the last update to the credit usage.
706
+ */
707
+ usageUpdatedAt: string;
708
+ /**
709
+ * Timestamp of the last update to the entitlement grant or configuration.
710
+ */
711
+ entitlementUpdatedAt?: string;
712
+ /**
713
+ * The end date of the current billing period for recurring credit grants.
714
+ */
715
+ usagePeriodEnd?: string;
716
+ /**
717
+ * The next time the entitlement should be recalculated
718
+ */
719
+ validUntil?: string;
720
+ }
721
+ namespace UnionObjectVariant1 {
722
+ /**
723
+ * The currency associated with a credit entitlement.
724
+ */
725
+ interface Currency {
726
+ /**
727
+ * The unique identifier of the custom currency.
728
+ */
729
+ currencyId: string;
730
+ }
731
+ }
649
732
  /**
650
- * Pricing type
733
+ * Created subscription (when status is SUCCESS)
651
734
  */
652
- pricingType: 'FREE' | 'PAID' | 'CUSTOM';
735
+ interface Subscription {
736
+ /**
737
+ * Subscription ID
738
+ */
739
+ id: string;
740
+ /**
741
+ * Billing ID
742
+ */
743
+ billingId: string | null;
744
+ /**
745
+ * Created at
746
+ */
747
+ createdAt: string;
748
+ /**
749
+ * Customer ID
750
+ */
751
+ customerId: string;
752
+ /**
753
+ * Payment collection
754
+ */
755
+ paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED';
756
+ /**
757
+ * Plan ID
758
+ */
759
+ planId: string;
760
+ /**
761
+ * Pricing type
762
+ */
763
+ pricingType: 'FREE' | 'PAID' | 'CUSTOM';
764
+ /**
765
+ * Subscription start date
766
+ */
767
+ startDate: string;
768
+ /**
769
+ * Subscription status
770
+ */
771
+ status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
772
+ /**
773
+ * Subscription cancellation date
774
+ */
775
+ cancellationDate?: string | null;
776
+ /**
777
+ * Subscription cancel reason
778
+ */
779
+ cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
780
+ /**
781
+ * End of the current billing period
782
+ */
783
+ currentBillingPeriodEnd?: string | null;
784
+ /**
785
+ * Start of the current billing period
786
+ */
787
+ currentBillingPeriodStart?: string | null;
788
+ /**
789
+ * Subscription effective end date
790
+ */
791
+ effectiveEndDate?: string | null;
792
+ /**
793
+ * Subscription end date
794
+ */
795
+ endDate?: string | null;
796
+ /**
797
+ * Additional metadata for the subscription
798
+ */
799
+ metadata?: {
800
+ [key: string]: string;
801
+ };
802
+ /**
803
+ * Paying customer ID for delegated billing
804
+ */
805
+ payingCustomerId?: string | null;
806
+ /**
807
+ * The method used to collect payments for a subscription
808
+ */
809
+ paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
810
+ prices?: Array<Subscription.Price>;
811
+ /**
812
+ * Resource ID
813
+ */
814
+ resourceId?: string | null;
815
+ /**
816
+ * Subscription trial end date
817
+ */
818
+ trialEndDate?: string | null;
819
+ }
820
+ namespace Subscription {
821
+ interface Price {
822
+ /**
823
+ * Addon identifier for the price override
824
+ */
825
+ addonId?: string | null;
826
+ /**
827
+ * Whether this is a base charge override
828
+ */
829
+ baseCharge?: boolean;
830
+ /**
831
+ * Block size for pricing
832
+ */
833
+ blockSize?: number;
834
+ /**
835
+ * Feature identifier for the price override
836
+ */
837
+ featureId?: string | null;
838
+ /**
839
+ * Override price amount
840
+ */
841
+ price?: Price.Price;
842
+ /**
843
+ * Pricing tiers configuration
844
+ */
845
+ tiers?: Array<Price.Tier>;
846
+ }
847
+ namespace Price {
848
+ /**
849
+ * Override price amount
850
+ */
851
+ interface Price {
852
+ /**
853
+ * The price amount
854
+ */
855
+ amount?: number;
856
+ /**
857
+ * The billing country code of the price
858
+ */
859
+ billingCountryCode?: string | null;
860
+ /**
861
+ * The price currency
862
+ */
863
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
864
+ }
865
+ interface Tier {
866
+ /**
867
+ * The flat fee price of the price tier
868
+ */
869
+ flatPrice?: Tier.FlatPrice;
870
+ /**
871
+ * The unit price of the price tier
872
+ */
873
+ unitPrice?: Tier.UnitPrice;
874
+ /**
875
+ * The up to quantity of the price tier
876
+ */
877
+ upTo?: number;
878
+ }
879
+ namespace Tier {
880
+ /**
881
+ * The flat fee price of the price tier
882
+ */
883
+ interface FlatPrice {
884
+ /**
885
+ * The price amount
886
+ */
887
+ amount?: number;
888
+ /**
889
+ * The billing country code of the price
890
+ */
891
+ billingCountryCode?: string | null;
892
+ /**
893
+ * The price currency
894
+ */
895
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
896
+ }
897
+ /**
898
+ * The unit price of the price tier
899
+ */
900
+ interface UnitPrice {
901
+ /**
902
+ * The price amount
903
+ */
904
+ amount?: number;
905
+ /**
906
+ * The billing country code of the price
907
+ */
908
+ billingCountryCode?: string | null;
909
+ /**
910
+ * The price currency
911
+ */
912
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
913
+ }
914
+ }
915
+ }
916
+ }
917
+ }
918
+ }
919
+ export interface SubscriptionUpdateParams {
920
+ addons?: Array<SubscriptionUpdateParams.Addon>;
921
+ appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
922
+ awaitPaymentConfirmation?: boolean;
923
+ billingInformation?: SubscriptionUpdateParams.BillingInformation;
924
+ billingPeriod?: 'MONTHLY' | 'ANNUALLY';
925
+ budget?: SubscriptionUpdateParams.Budget | null;
926
+ charges?: Array<SubscriptionUpdateParams.Charge>;
927
+ /**
928
+ * Additional metadata for the subscription
929
+ */
930
+ metadata?: {
931
+ [key: string]: string;
932
+ };
933
+ minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
934
+ priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
935
+ promotionCode?: string;
936
+ scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
937
+ subscriptionEntitlements?: Array<SubscriptionUpdateParams.SubscriptionEntitlement>;
938
+ /**
939
+ * Subscription trial end date
940
+ */
941
+ trialEndDate?: string;
942
+ }
943
+ export declare namespace SubscriptionUpdateParams {
944
+ interface Addon {
653
945
  /**
654
- * Subscription start date
946
+ * Addon ID
655
947
  */
656
- startDate: string;
948
+ addonId: string;
949
+ quantity: number;
950
+ }
951
+ interface AppliedCoupon {
952
+ billingCouponId?: string;
953
+ configuration?: AppliedCoupon.Configuration;
954
+ couponId?: string;
955
+ discount?: AppliedCoupon.Discount;
956
+ promotionCode?: string | null;
957
+ }
958
+ namespace AppliedCoupon {
959
+ interface Configuration {
960
+ /**
961
+ * Coupon start date
962
+ */
963
+ startDate?: string;
964
+ }
965
+ interface Discount {
966
+ amountsOff?: Array<Discount.AmountsOff> | null;
967
+ description?: string;
968
+ durationInMonths?: number;
969
+ name?: string;
970
+ percentOff?: number;
971
+ }
972
+ namespace Discount {
973
+ interface AmountsOff {
974
+ amount: number;
975
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
976
+ }
977
+ }
978
+ }
979
+ interface BillingInformation {
657
980
  /**
658
- * Subscription status
981
+ * Physical address
659
982
  */
660
- status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
983
+ billingAddress?: BillingInformation.BillingAddress;
984
+ chargeOnBehalfOfAccount?: string;
985
+ couponId?: string;
986
+ integrationId?: string;
987
+ invoiceDaysUntilDue?: number;
988
+ isBackdated?: boolean;
989
+ isInvoicePaid?: boolean;
661
990
  /**
662
- * Subscription cancellation date
991
+ * Additional metadata for the subscription
663
992
  */
664
- cancellationDate?: string | null;
993
+ metadata?: {
994
+ [key: string]: unknown;
995
+ };
996
+ prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
997
+ taxIds?: Array<BillingInformation.TaxID>;
998
+ taxPercentage?: number;
999
+ taxRateIds?: Array<string>;
1000
+ }
1001
+ namespace BillingInformation {
1002
+ /**
1003
+ * Physical address
1004
+ */
1005
+ interface BillingAddress {
1006
+ /**
1007
+ * City name
1008
+ */
1009
+ city?: string;
1010
+ /**
1011
+ * Country code or name
1012
+ */
1013
+ country?: string;
1014
+ /**
1015
+ * Street address line 1
1016
+ */
1017
+ line1?: string;
1018
+ /**
1019
+ * Street address line 2
1020
+ */
1021
+ line2?: string;
1022
+ /**
1023
+ * Postal or ZIP code
1024
+ */
1025
+ postalCode?: string;
1026
+ /**
1027
+ * State or province
1028
+ */
1029
+ state?: string;
1030
+ }
1031
+ interface TaxID {
1032
+ type: string;
1033
+ value: string;
1034
+ }
1035
+ }
1036
+ interface Budget {
1037
+ hasSoftLimit: boolean;
1038
+ limit: number;
1039
+ }
1040
+ interface Charge {
1041
+ /**
1042
+ * Charge ID
1043
+ */
1044
+ id: string;
1045
+ quantity: number;
1046
+ type: 'FEATURE' | 'CREDIT';
1047
+ }
1048
+ interface MinimumSpend {
1049
+ minimum?: MinimumSpend.Minimum | null;
1050
+ }
1051
+ namespace MinimumSpend {
1052
+ interface Minimum {
1053
+ amount: number;
1054
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1055
+ }
1056
+ }
1057
+ interface PriceOverride {
1058
+ /**
1059
+ * Addon ID
1060
+ */
1061
+ addonId?: string;
1062
+ /**
1063
+ * Whether this is a base charge override
1064
+ */
1065
+ baseCharge?: boolean;
1066
+ /**
1067
+ * The corresponding custom currency id of the recurring credits price
1068
+ */
1069
+ currencyId?: string;
1070
+ /**
1071
+ * Feature ID
1072
+ */
1073
+ featureId?: string;
1074
+ price?: PriceOverride.Price;
1075
+ }
1076
+ namespace PriceOverride {
1077
+ interface Price {
1078
+ amount: number;
1079
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1080
+ }
1081
+ }
1082
+ interface SubscriptionEntitlement {
1083
+ id?: string;
1084
+ featureId?: string;
1085
+ hasSoftLimit?: boolean;
1086
+ hasUnlimitedUsage?: boolean;
1087
+ monthlyResetPeriodConfiguration?: SubscriptionEntitlement.MonthlyResetPeriodConfiguration;
1088
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
1089
+ usageLimit?: number;
1090
+ weeklyResetPeriodConfiguration?: SubscriptionEntitlement.WeeklyResetPeriodConfiguration;
1091
+ yearlyResetPeriodConfiguration?: SubscriptionEntitlement.YearlyResetPeriodConfiguration;
1092
+ }
1093
+ namespace SubscriptionEntitlement {
1094
+ interface MonthlyResetPeriodConfiguration {
1095
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
1096
+ }
1097
+ interface WeeklyResetPeriodConfiguration {
1098
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
1099
+ }
1100
+ interface YearlyResetPeriodConfiguration {
1101
+ accordingTo: 'SubscriptionStart';
1102
+ }
1103
+ }
1104
+ }
1105
+ export interface SubscriptionListParams extends MyCursorIDPageParams {
1106
+ /**
1107
+ * Filter by creation date using range operators: gt, gte, lt, lte
1108
+ */
1109
+ createdAt?: SubscriptionListParams.CreatedAt;
1110
+ /**
1111
+ * Filter by customer ID
1112
+ */
1113
+ customerId?: string;
1114
+ /**
1115
+ * Filter by plan ID
1116
+ */
1117
+ planId?: string;
1118
+ /**
1119
+ * Filter by pricing type. Supports comma-separated values for multiple types
1120
+ */
1121
+ pricingType?: string;
1122
+ /**
1123
+ * Filter by resource ID
1124
+ */
1125
+ resourceId?: string;
1126
+ /**
1127
+ * Filter by subscription status. Supports comma-separated values for multiple
1128
+ * statuses
1129
+ */
1130
+ status?: string;
1131
+ }
1132
+ export declare namespace SubscriptionListParams {
1133
+ /**
1134
+ * Filter by creation date using range operators: gt, gte, lt, lte
1135
+ */
1136
+ interface CreatedAt {
1137
+ /**
1138
+ * Greater than the specified createdAt value
1139
+ */
1140
+ gt?: string;
1141
+ /**
1142
+ * Greater than or equal to the specified createdAt value
1143
+ */
1144
+ gte?: string;
1145
+ /**
1146
+ * Less than the specified createdAt value
1147
+ */
1148
+ lt?: string;
1149
+ /**
1150
+ * Less than or equal to the specified createdAt value
1151
+ */
1152
+ lte?: string;
1153
+ }
1154
+ }
1155
+ export interface SubscriptionCancelParams {
1156
+ /**
1157
+ * Action on cancellation (downgrade or revoke)
1158
+ */
1159
+ cancellationAction?: 'DEFAULT' | 'REVOKE_ENTITLEMENTS';
1160
+ /**
1161
+ * When to cancel (immediate, period end, or date)
1162
+ */
1163
+ cancellationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
1164
+ /**
1165
+ * Subscription end date
1166
+ */
1167
+ endDate?: string;
1168
+ /**
1169
+ * If set, enables or disables prorating of credits on subscription cancellation.
1170
+ */
1171
+ prorate?: boolean;
1172
+ }
1173
+ export interface SubscriptionDelegateParams {
1174
+ /**
1175
+ * The unique identifier of the customer who will assume payment responsibility for
1176
+ * this subscription. This customer must already exist in your Stigg account and
1177
+ * have a valid payment method if the subscription requires payment.
1178
+ */
1179
+ targetCustomerId: string;
1180
+ }
1181
+ export interface SubscriptionImportParams {
1182
+ /**
1183
+ * List of subscription objects to import
1184
+ */
1185
+ subscriptions: Array<SubscriptionImportParams.Subscription>;
1186
+ /**
1187
+ * Integration ID to use for importing subscriptions
1188
+ */
1189
+ integrationId?: string | null;
1190
+ }
1191
+ export declare namespace SubscriptionImportParams {
1192
+ interface Subscription {
665
1193
  /**
666
- * Subscription cancel reason
1194
+ * Subscription ID
667
1195
  */
668
- cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
1196
+ id: string;
669
1197
  /**
670
- * End of the current billing period
1198
+ * Customer ID
671
1199
  */
672
- currentBillingPeriodEnd?: string | null;
1200
+ customerId: string;
673
1201
  /**
674
- * Start of the current billing period
1202
+ * Plan ID
675
1203
  */
676
- currentBillingPeriodStart?: string | null;
1204
+ planId: string;
677
1205
  /**
678
- * Subscription effective end date
1206
+ * Billing ID
679
1207
  */
680
- effectiveEndDate?: string | null;
1208
+ billingId?: string | null;
681
1209
  /**
682
1210
  * Subscription end date
683
1211
  */
@@ -688,223 +1216,510 @@ export declare namespace SubscriptionTransferResponse {
688
1216
  metadata?: {
689
1217
  [key: string]: string;
690
1218
  };
691
- /**
692
- * Paying customer ID for delegated billing
693
- */
694
- payingCustomerId?: string | null;
695
- /**
696
- * The method used to collect payments for a subscription
697
- */
698
- paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE' | null;
699
1219
  /**
700
1220
  * Resource ID
701
1221
  */
702
1222
  resourceId?: string | null;
703
1223
  /**
704
- * Subscription trial end date
1224
+ * Subscription start date
705
1225
  */
706
- trialEndDate?: string | null;
1226
+ startDate?: string;
707
1227
  }
708
1228
  }
709
- export interface SubscriptionCreateParams {
1229
+ export interface SubscriptionMigrateParams {
710
1230
  /**
711
- * Customer ID to provision the subscription for
1231
+ * When to migrate (immediate or period end)
1232
+ */
1233
+ subscriptionMigrationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE';
1234
+ }
1235
+ export interface SubscriptionPreviewParams {
1236
+ /**
1237
+ * Customer ID
712
1238
  */
713
1239
  customerId: string;
714
1240
  /**
715
- * Plan ID to provision
1241
+ * Plan ID
716
1242
  */
717
1243
  planId: string;
718
1244
  /**
719
- * Unique identifier for the subscription
1245
+ * Addons to include
1246
+ */
1247
+ addons?: Array<SubscriptionPreviewParams.Addon>;
1248
+ /**
1249
+ * Coupon or discount to apply
720
1250
  */
721
- id?: string | null;
1251
+ appliedCoupon?: SubscriptionPreviewParams.AppliedCoupon;
722
1252
  /**
723
- * Whether to wait for payment confirmation before returning the subscription
1253
+ * Billable features with quantities
1254
+ */
1255
+ billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
1256
+ /**
1257
+ * ISO 3166-1 country code for localization
1258
+ */
1259
+ billingCountryCode?: string;
1260
+ /**
1261
+ * Billing and tax configuration
1262
+ */
1263
+ billingInformation?: SubscriptionPreviewParams.BillingInformation;
1264
+ /**
1265
+ * Billing period (MONTHLY or ANNUALLY)
724
1266
  */
725
- awaitPaymentConfirmation?: boolean;
726
1267
  billingPeriod?: 'MONTHLY' | 'ANNUALLY';
727
- checkoutOptions?: SubscriptionCreateParams.CheckoutOptions;
728
1268
  /**
729
- * Additional metadata for the subscription
1269
+ * One-time or recurring charges
730
1270
  */
731
- metadata?: {
732
- [key: string]: string;
733
- };
1271
+ charges?: Array<SubscriptionPreviewParams.Charge>;
734
1272
  /**
735
- * Optional paying customer ID for split billing scenarios
1273
+ * Paying customer ID for delegated billing
736
1274
  */
737
- payingCustomerId?: string | null;
1275
+ payingCustomerId?: string;
738
1276
  /**
739
- * Optional resource ID for multi-instance subscriptions
1277
+ * Resource ID for multi-instance subscriptions
740
1278
  */
741
- resourceId?: string | null;
742
- trialOverrideConfiguration?: SubscriptionCreateParams.TrialOverrideConfiguration;
1279
+ resourceId?: string;
1280
+ /**
1281
+ * When to apply subscription changes
1282
+ */
1283
+ scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
1284
+ /**
1285
+ * Subscription start date
1286
+ */
1287
+ startDate?: string;
1288
+ /**
1289
+ * Trial period override settings
1290
+ */
1291
+ trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
1292
+ /**
1293
+ * Unit quantity for per-unit pricing
1294
+ */
1295
+ unitQuantity?: number;
743
1296
  }
744
- export declare namespace SubscriptionCreateParams {
745
- interface CheckoutOptions {
1297
+ export declare namespace SubscriptionPreviewParams {
1298
+ /**
1299
+ * Addon configuration
1300
+ */
1301
+ interface Addon {
746
1302
  /**
747
- * URL to redirect to if checkout is canceled
1303
+ * Addon ID
748
1304
  */
749
- cancelUrl: string;
1305
+ addonId: string;
750
1306
  /**
751
- * URL to redirect to after successful checkout
1307
+ * Number of addon instances
752
1308
  */
753
- successUrl: string;
1309
+ quantity?: number;
1310
+ }
1311
+ /**
1312
+ * Coupon or discount to apply
1313
+ */
1314
+ interface AppliedCoupon {
754
1315
  /**
755
- * Allow promotional codes during checkout
1316
+ * Billing provider coupon ID
756
1317
  */
757
- allowPromoCodes?: boolean;
1318
+ billingCouponId?: string;
758
1319
  /**
759
- * Allow tax ID collection during checkout
1320
+ * Coupon timing configuration
760
1321
  */
761
- allowTaxIdCollection?: boolean;
1322
+ configuration?: AppliedCoupon.Configuration;
762
1323
  /**
763
- * Collect billing address during checkout
1324
+ * Stigg coupon ID
764
1325
  */
765
- collectBillingAddress?: boolean;
1326
+ couponId?: string;
766
1327
  /**
767
- * Collect phone number during checkout
1328
+ * Ad-hoc discount configuration
768
1329
  */
769
- collectPhoneNumber?: boolean;
1330
+ discount?: AppliedCoupon.Discount;
770
1331
  /**
771
- * Optional reference ID for the checkout session
1332
+ * Promotion code to apply
772
1333
  */
773
- referenceId?: string | null;
1334
+ promotionCode?: string;
1335
+ }
1336
+ namespace AppliedCoupon {
1337
+ /**
1338
+ * Coupon timing configuration
1339
+ */
1340
+ interface Configuration {
1341
+ /**
1342
+ * Coupon start date
1343
+ */
1344
+ startDate?: string;
1345
+ }
1346
+ /**
1347
+ * Ad-hoc discount configuration
1348
+ */
1349
+ interface Discount {
1350
+ /**
1351
+ * Fixed amounts off by currency
1352
+ */
1353
+ amountsOff?: Array<Discount.AmountsOff> | null;
1354
+ /**
1355
+ * Ad-hoc discount
1356
+ */
1357
+ description?: string;
1358
+ /**
1359
+ * Duration in months
1360
+ */
1361
+ durationInMonths?: number;
1362
+ /**
1363
+ * Discount name
1364
+ */
1365
+ name?: string;
1366
+ /**
1367
+ * Percentage discount
1368
+ */
1369
+ percentOff?: number;
1370
+ }
1371
+ namespace Discount {
1372
+ interface AmountsOff {
1373
+ /**
1374
+ * The price amount
1375
+ */
1376
+ amount: number;
1377
+ /**
1378
+ * The price currency
1379
+ */
1380
+ currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1381
+ }
1382
+ }
1383
+ }
1384
+ /**
1385
+ * Feature with quantity
1386
+ */
1387
+ interface BillableFeature {
1388
+ /**
1389
+ * Feature ID
1390
+ */
1391
+ featureId: string;
1392
+ /**
1393
+ * Quantity of feature units
1394
+ */
1395
+ quantity: number;
1396
+ }
1397
+ /**
1398
+ * Billing and tax configuration
1399
+ */
1400
+ interface BillingInformation {
1401
+ /**
1402
+ * Billing address
1403
+ */
1404
+ billingAddress?: BillingInformation.BillingAddress;
1405
+ /**
1406
+ * Connected account ID for platform billing
1407
+ */
1408
+ chargeOnBehalfOfAccount?: string;
1409
+ /**
1410
+ * Billing integration ID
1411
+ */
1412
+ integrationId?: string;
1413
+ /**
1414
+ * Days until invoice is due
1415
+ */
1416
+ invoiceDaysUntilDue?: number;
1417
+ /**
1418
+ * Whether subscription is backdated
1419
+ */
1420
+ isBackdated?: boolean;
1421
+ /**
1422
+ * Whether invoice is already paid
1423
+ */
1424
+ isInvoicePaid?: boolean;
1425
+ /**
1426
+ * Additional billing metadata
1427
+ */
1428
+ metadata?: unknown;
1429
+ /**
1430
+ * Proration behavior
1431
+ */
1432
+ prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
1433
+ /**
1434
+ * Customer tax IDs
1435
+ */
1436
+ taxIds?: Array<BillingInformation.TaxID>;
1437
+ /**
1438
+ * Tax percentage to apply
1439
+ */
1440
+ taxPercentage?: number;
1441
+ /**
1442
+ * Tax rate IDs from billing provider
1443
+ */
1444
+ taxRateIds?: Array<string>;
1445
+ }
1446
+ namespace BillingInformation {
1447
+ /**
1448
+ * Billing address
1449
+ */
1450
+ interface BillingAddress {
1451
+ city?: string;
1452
+ country?: string;
1453
+ line1?: string;
1454
+ line2?: string;
1455
+ postalCode?: string;
1456
+ state?: string;
1457
+ }
1458
+ /**
1459
+ * Tax exemption identifier
1460
+ */
1461
+ interface TaxID {
1462
+ /**
1463
+ * Tax exemption type (e.g., vat, gst)
1464
+ */
1465
+ type: string;
1466
+ /**
1467
+ * Tax exemption identifier value
1468
+ */
1469
+ value: string;
1470
+ }
1471
+ }
1472
+ /**
1473
+ * Charge item
1474
+ */
1475
+ interface Charge {
1476
+ /**
1477
+ * Charge ID
1478
+ */
1479
+ id: string;
1480
+ /**
1481
+ * Charge quantity
1482
+ */
1483
+ quantity: number;
1484
+ /**
1485
+ * Charge type
1486
+ */
1487
+ type: 'FEATURE' | 'CREDIT';
774
1488
  }
1489
+ /**
1490
+ * Trial period override settings
1491
+ */
775
1492
  interface TrialOverrideConfiguration {
776
1493
  /**
777
- * Whether the subscription should start with a trial period
1494
+ * Whether to start as trial
778
1495
  */
779
1496
  isTrial: boolean;
780
1497
  /**
781
- * Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION
1498
+ * Behavior when trial ends
782
1499
  */
783
1500
  trialEndBehavior?: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
784
1501
  /**
785
- * Custom trial end date
1502
+ * Trial end date
786
1503
  */
787
1504
  trialEndDate?: string;
788
1505
  }
789
1506
  }
790
- export interface SubscriptionListParams {
1507
+ export interface SubscriptionProvisionParams {
1508
+ /**
1509
+ * Customer ID to provision the subscription for
1510
+ */
1511
+ customerId: string;
791
1512
  /**
792
- * Filter by customer ID
1513
+ * Plan ID to provision
793
1514
  */
794
- customerId?: string;
1515
+ planId: string;
795
1516
  /**
796
- * Ending before this UUID for pagination
1517
+ * Unique identifier for the subscription
797
1518
  */
798
- endingBefore?: string;
1519
+ id?: string;
1520
+ addons?: Array<SubscriptionProvisionParams.Addon>;
799
1521
  /**
800
- * Items per page
1522
+ * Coupon configuration
801
1523
  */
802
- limit?: number;
1524
+ appliedCoupon?: SubscriptionProvisionParams.AppliedCoupon;
803
1525
  /**
804
- * Starting after this UUID for pagination
1526
+ * Whether to wait for payment confirmation before returning the subscription
805
1527
  */
806
- startingAfter?: string;
1528
+ awaitPaymentConfirmation?: boolean;
807
1529
  /**
808
- * Filter by subscription status (comma-separated for multiple statuses, e.g.,
809
- * ACTIVE,IN_TRIAL)
1530
+ * The ISO 3166-1 alpha-2 country code for billing
810
1531
  */
811
- status?: string;
812
- }
813
- export interface SubscriptionDelegateParams {
1532
+ billingCountryCode?: string | null;
814
1533
  /**
815
- * The customer ID to delegate the subscription to
1534
+ * External billing system identifier
816
1535
  */
817
- targetCustomerId: string;
818
- }
819
- export interface SubscriptionMigrateParams {
1536
+ billingId?: string | null;
1537
+ billingInformation?: SubscriptionProvisionParams.BillingInformation;
820
1538
  /**
821
- * When to migrate the subscription: IMMEDIATE or END_OF_BILLING_PERIOD
1539
+ * Billing period (MONTHLY or ANNUALLY)
822
1540
  */
823
- subscriptionMigrationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE';
824
- }
825
- export interface SubscriptionPreviewParams {
1541
+ billingPeriod?: 'MONTHLY' | 'ANNUALLY';
1542
+ budget?: SubscriptionProvisionParams.Budget | null;
1543
+ charges?: Array<SubscriptionProvisionParams.Charge>;
826
1544
  /**
827
- * Customer ID
1545
+ * Checkout page configuration for payment collection
828
1546
  */
829
- customerId: string;
1547
+ checkoutOptions?: SubscriptionProvisionParams.CheckoutOptions;
830
1548
  /**
831
- * Plan ID
1549
+ * Additional metadata for the subscription
1550
+ */
1551
+ metadata?: {
1552
+ [key: string]: string;
1553
+ };
1554
+ minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
1555
+ /**
1556
+ * Optional paying customer ID for split billing scenarios
1557
+ */
1558
+ payingCustomerId?: string | null;
1559
+ /**
1560
+ * How payments should be collected for this subscription
1561
+ */
1562
+ paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
1563
+ priceOverrides?: Array<SubscriptionProvisionParams.PriceOverride>;
1564
+ /**
1565
+ * Optional resource ID for multi-instance subscriptions
1566
+ */
1567
+ resourceId?: string | null;
1568
+ /**
1569
+ * Salesforce ID
1570
+ */
1571
+ salesforceId?: string | null;
1572
+ /**
1573
+ * Strategy for scheduling subscription changes
832
1574
  */
833
- planId: string;
834
- addons?: Array<SubscriptionPreviewParams.Addon>;
835
- appliedCoupon?: SubscriptionPreviewParams.AppliedCoupon;
836
- billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
837
- billingCountryCode?: string;
838
- billingInformation?: SubscriptionPreviewParams.BillingInformation;
839
- billingPeriod?: 'MONTHLY' | 'ANNUALLY';
840
- charges?: Array<SubscriptionPreviewParams.Charge>;
841
- payingCustomerId?: string;
842
- resourceId?: string;
843
1575
  scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
844
1576
  /**
845
1577
  * Subscription start date
846
1578
  */
847
1579
  startDate?: string;
848
- trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
1580
+ subscriptionEntitlements?: Array<SubscriptionProvisionParams.SubscriptionEntitlement>;
1581
+ /**
1582
+ * Trial period override settings
1583
+ */
1584
+ trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
849
1585
  unitQuantity?: number;
850
1586
  }
851
- export declare namespace SubscriptionPreviewParams {
1587
+ export declare namespace SubscriptionProvisionParams {
852
1588
  interface Addon {
853
1589
  /**
854
- * Addon ID
1590
+ * Addon identifier
855
1591
  */
856
1592
  addonId: string;
1593
+ /**
1594
+ * Number of addon units
1595
+ */
857
1596
  quantity?: number;
858
1597
  }
1598
+ /**
1599
+ * Coupon configuration
1600
+ */
859
1601
  interface AppliedCoupon {
1602
+ /**
1603
+ * Billing provider coupon ID
1604
+ */
860
1605
  billingCouponId?: string;
1606
+ /**
1607
+ * Coupon timing configuration
1608
+ */
861
1609
  configuration?: AppliedCoupon.Configuration;
1610
+ /**
1611
+ * Stigg coupon ID
1612
+ */
862
1613
  couponId?: string;
1614
+ /**
1615
+ * Ad-hoc discount configuration
1616
+ */
863
1617
  discount?: AppliedCoupon.Discount;
1618
+ /**
1619
+ * Promotion code to apply
1620
+ */
864
1621
  promotionCode?: string;
865
1622
  }
866
1623
  namespace AppliedCoupon {
1624
+ /**
1625
+ * Coupon timing configuration
1626
+ */
867
1627
  interface Configuration {
868
1628
  /**
869
1629
  * Coupon start date
870
1630
  */
871
1631
  startDate?: string;
872
1632
  }
1633
+ /**
1634
+ * Ad-hoc discount configuration
1635
+ */
873
1636
  interface Discount {
1637
+ /**
1638
+ * Fixed amounts off by currency
1639
+ */
874
1640
  amountsOff?: Array<Discount.AmountsOff> | null;
1641
+ /**
1642
+ * Ad-hoc discount
1643
+ */
875
1644
  description?: string;
1645
+ /**
1646
+ * Duration in months
1647
+ */
876
1648
  durationInMonths?: number;
1649
+ /**
1650
+ * Discount name
1651
+ */
877
1652
  name?: string;
1653
+ /**
1654
+ * Percentage discount
1655
+ */
878
1656
  percentOff?: number;
879
1657
  }
880
1658
  namespace Discount {
881
1659
  interface AmountsOff {
1660
+ /**
1661
+ * The price amount
1662
+ */
882
1663
  amount: number;
883
- currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1664
+ /**
1665
+ * The price currency
1666
+ */
1667
+ currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
884
1668
  }
885
1669
  }
886
1670
  }
887
- interface BillableFeature {
1671
+ interface BillingInformation {
888
1672
  /**
889
- * Feature ID
1673
+ * Billing address for the subscription
890
1674
  */
891
- featureId: string;
892
- quantity: number;
893
- }
894
- interface BillingInformation {
895
1675
  billingAddress?: BillingInformation.BillingAddress;
896
- chargeOnBehalfOfAccount?: string;
897
- integrationId?: string;
1676
+ /**
1677
+ * Stripe Connect account to charge on behalf of
1678
+ */
1679
+ chargeOnBehalfOfAccount?: string | null;
1680
+ /**
1681
+ * Billing integration identifier
1682
+ */
1683
+ integrationId?: string | null;
1684
+ /**
1685
+ * Number of days until invoice is due
1686
+ */
898
1687
  invoiceDaysUntilDue?: number;
1688
+ /**
1689
+ * Whether the subscription is backdated
1690
+ */
899
1691
  isBackdated?: boolean;
1692
+ /**
1693
+ * Whether the invoice is marked as paid
1694
+ */
900
1695
  isInvoicePaid?: boolean;
901
- metadata?: unknown;
1696
+ /**
1697
+ * Additional metadata for the subscription
1698
+ */
1699
+ metadata?: {
1700
+ [key: string]: string;
1701
+ };
1702
+ /**
1703
+ * How to handle proration for billing changes
1704
+ */
902
1705
  prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
1706
+ /**
1707
+ * Customer tax identification numbers
1708
+ */
903
1709
  taxIds?: Array<BillingInformation.TaxID>;
1710
+ /**
1711
+ * Tax percentage (0-100)
1712
+ */
904
1713
  taxPercentage?: number;
1714
+ /**
1715
+ * Tax rate identifiers to apply
1716
+ */
905
1717
  taxRateIds?: Array<string>;
906
1718
  }
907
1719
  namespace BillingInformation {
1720
+ /**
1721
+ * Billing address for the subscription
1722
+ */
908
1723
  interface BillingAddress {
909
1724
  city?: string;
910
1725
  country?: string;
@@ -914,36 +1729,248 @@ export declare namespace SubscriptionPreviewParams {
914
1729
  state?: string;
915
1730
  }
916
1731
  interface TaxID {
1732
+ /**
1733
+ * The type of tax exemption identifier, such as VAT.
1734
+ */
917
1735
  type: string;
1736
+ /**
1737
+ * The actual tax identifier value
1738
+ */
918
1739
  value: string;
919
1740
  }
920
1741
  }
1742
+ interface Budget {
1743
+ /**
1744
+ * Whether the budget is a soft limit
1745
+ */
1746
+ hasSoftLimit: boolean;
1747
+ /**
1748
+ * Maximum spending limit
1749
+ */
1750
+ limit: number;
1751
+ }
1752
+ /**
1753
+ * Charge item
1754
+ */
921
1755
  interface Charge {
922
1756
  /**
923
1757
  * Charge ID
924
1758
  */
925
1759
  id: string;
1760
+ /**
1761
+ * Charge quantity
1762
+ */
926
1763
  quantity: number;
1764
+ /**
1765
+ * Charge type
1766
+ */
927
1767
  type: 'FEATURE' | 'CREDIT';
928
1768
  }
1769
+ /**
1770
+ * Checkout page configuration for payment collection
1771
+ */
1772
+ interface CheckoutOptions {
1773
+ /**
1774
+ * URL to redirect to if checkout is canceled
1775
+ */
1776
+ cancelUrl: string;
1777
+ /**
1778
+ * URL to redirect to after successful checkout
1779
+ */
1780
+ successUrl: string;
1781
+ /**
1782
+ * Allow promotional codes during checkout
1783
+ */
1784
+ allowPromoCodes?: boolean;
1785
+ /**
1786
+ * Allow tax ID collection during checkout
1787
+ */
1788
+ allowTaxIdCollection?: boolean;
1789
+ /**
1790
+ * Collect billing address during checkout
1791
+ */
1792
+ collectBillingAddress?: boolean;
1793
+ /**
1794
+ * Collect phone number during checkout
1795
+ */
1796
+ collectPhoneNumber?: boolean;
1797
+ /**
1798
+ * Optional reference ID for the checkout session
1799
+ */
1800
+ referenceId?: string | null;
1801
+ }
1802
+ interface MinimumSpend {
1803
+ /**
1804
+ * Minimum spend amount
1805
+ */
1806
+ minimum?: MinimumSpend.Minimum | null;
1807
+ }
1808
+ namespace MinimumSpend {
1809
+ /**
1810
+ * Minimum spend amount
1811
+ */
1812
+ interface Minimum {
1813
+ /**
1814
+ * The price amount
1815
+ */
1816
+ amount?: number;
1817
+ /**
1818
+ * The billing country code of the price
1819
+ */
1820
+ billingCountryCode?: string | null;
1821
+ /**
1822
+ * The price currency
1823
+ */
1824
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1825
+ }
1826
+ }
1827
+ interface PriceOverride {
1828
+ /**
1829
+ * Addon identifier for the price override
1830
+ */
1831
+ addonId?: string | null;
1832
+ /**
1833
+ * Whether this is a base charge override
1834
+ */
1835
+ baseCharge?: boolean;
1836
+ /**
1837
+ * Block size for pricing
1838
+ */
1839
+ blockSize?: number;
1840
+ creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
1841
+ creditRate?: PriceOverride.CreditRate;
1842
+ /**
1843
+ * Feature identifier for the price override
1844
+ */
1845
+ featureId?: string | null;
1846
+ /**
1847
+ * Override price amount
1848
+ */
1849
+ price?: PriceOverride.Price;
1850
+ /**
1851
+ * Pricing tiers configuration
1852
+ */
1853
+ tiers?: Array<PriceOverride.Tier>;
1854
+ }
1855
+ namespace PriceOverride {
1856
+ interface CreditRate {
1857
+ /**
1858
+ * The credit rate amount
1859
+ */
1860
+ amount: number;
1861
+ /**
1862
+ * The custom currency refId for the credit rate
1863
+ */
1864
+ currencyId: string;
1865
+ /**
1866
+ * A custom formula for calculating cost based on single event dimensions
1867
+ */
1868
+ costFormula?: string | null;
1869
+ }
1870
+ /**
1871
+ * Override price amount
1872
+ */
1873
+ interface Price {
1874
+ /**
1875
+ * The price amount
1876
+ */
1877
+ amount?: number;
1878
+ /**
1879
+ * The billing country code of the price
1880
+ */
1881
+ billingCountryCode?: string | null;
1882
+ /**
1883
+ * The price currency
1884
+ */
1885
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1886
+ }
1887
+ interface Tier {
1888
+ /**
1889
+ * The flat fee price of the price tier
1890
+ */
1891
+ flatPrice?: Tier.FlatPrice;
1892
+ /**
1893
+ * The unit price of the price tier
1894
+ */
1895
+ unitPrice?: Tier.UnitPrice;
1896
+ /**
1897
+ * The up to quantity of the price tier
1898
+ */
1899
+ upTo?: number;
1900
+ }
1901
+ namespace Tier {
1902
+ /**
1903
+ * The flat fee price of the price tier
1904
+ */
1905
+ interface FlatPrice {
1906
+ /**
1907
+ * The price amount
1908
+ */
1909
+ amount?: number;
1910
+ /**
1911
+ * The billing country code of the price
1912
+ */
1913
+ billingCountryCode?: string | null;
1914
+ /**
1915
+ * The price currency
1916
+ */
1917
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1918
+ }
1919
+ /**
1920
+ * The unit price of the price tier
1921
+ */
1922
+ interface UnitPrice {
1923
+ /**
1924
+ * The price amount
1925
+ */
1926
+ amount?: number;
1927
+ /**
1928
+ * The billing country code of the price
1929
+ */
1930
+ billingCountryCode?: string | null;
1931
+ /**
1932
+ * The price currency
1933
+ */
1934
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1935
+ }
1936
+ }
1937
+ }
1938
+ interface SubscriptionEntitlement {
1939
+ /**
1940
+ * Feature ID
1941
+ */
1942
+ featureId: string;
1943
+ usageLimit: number;
1944
+ isGranted?: boolean;
1945
+ }
1946
+ /**
1947
+ * Trial period override settings
1948
+ */
929
1949
  interface TrialOverrideConfiguration {
1950
+ /**
1951
+ * Whether the subscription should start with a trial period
1952
+ */
930
1953
  isTrial: boolean;
1954
+ /**
1955
+ * Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION
1956
+ */
931
1957
  trialEndBehavior?: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
932
1958
  /**
933
- * Trial end date
1959
+ * Custom trial end date
934
1960
  */
935
1961
  trialEndDate?: string;
936
1962
  }
937
1963
  }
938
1964
  export interface SubscriptionTransferParams {
939
1965
  /**
940
- * The resource ID to transfer the subscription to. The destination resource must
941
- * belong to the same customer.
1966
+ * Resource ID to transfer the subscription to
942
1967
  */
943
1968
  destinationResourceId: string;
944
1969
  }
945
1970
  export declare namespace Subscriptions {
946
- export { type SubscriptionCreateResponse as SubscriptionCreateResponse, type SubscriptionRetrieveResponse as SubscriptionRetrieveResponse, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionDelegateResponse as SubscriptionDelegateResponse, type SubscriptionMigrateResponse as SubscriptionMigrateResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionTransferResponse as SubscriptionTransferResponse, type SubscriptionCreateParams as SubscriptionCreateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
947
- export { FutureUpdate as FutureUpdate, type FutureUpdateCancelPendingPaymentResponse as FutureUpdateCancelPendingPaymentResponse, type FutureUpdateCancelScheduleResponse as FutureUpdateCancelScheduleResponse, };
1971
+ export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
1972
+ export { FutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription };
1973
+ export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, };
1974
+ export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
948
1975
  }
949
1976
  //# sourceMappingURL=subscriptions.d.mts.map