@peable.to/contracts 0.3.0 → 1.0.0

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 (316) hide show
  1. package/dist/cjs/common/address.js +81 -0
  2. package/dist/cjs/common/envelopes.js +101 -0
  3. package/dist/cjs/common/objects.js +85 -0
  4. package/dist/cjs/common/params.js +211 -0
  5. package/dist/cjs/common/primitives.js +39 -0
  6. package/dist/cjs/contributions.js +22 -0
  7. package/dist/cjs/index.js +40 -97
  8. package/dist/cjs/openapi/document.js +297 -0
  9. package/dist/cjs/openapi/index.js +7 -0
  10. package/dist/cjs/openapi/webhooks.js +17 -0
  11. package/dist/cjs/resources/billingEngine/billingPortal.js +237 -0
  12. package/dist/cjs/resources/billingEngine/creditNotes.js +189 -0
  13. package/dist/cjs/resources/billingEngine/customerBalanceTransactions.js +90 -0
  14. package/dist/cjs/resources/billingEngine/index.js +43 -0
  15. package/dist/cjs/resources/billingEngine/invoiceItems.js +155 -0
  16. package/dist/cjs/resources/billingEngine/invoices.js +509 -0
  17. package/dist/cjs/resources/billingEngine/params.js +43 -0
  18. package/dist/cjs/resources/billingEngine/public.js +326 -0
  19. package/dist/cjs/resources/billingEngine/subscriptions.js +476 -0
  20. package/dist/cjs/resources/catalog/billing.js +755 -0
  21. package/dist/cjs/resources/catalog/billingSettings.js +131 -0
  22. package/dist/cjs/resources/catalog/coupons.js +222 -0
  23. package/dist/cjs/resources/catalog/entitlements.js +257 -0
  24. package/dist/cjs/resources/catalog/index.js +58 -0
  25. package/dist/cjs/resources/catalog/meters.js +279 -0
  26. package/dist/cjs/resources/catalog/prices.js +423 -0
  27. package/dist/cjs/resources/catalog/products.js +228 -0
  28. package/dist/cjs/resources/catalog/promotionCodes.js +174 -0
  29. package/dist/cjs/resources/catalog/shared.js +75 -0
  30. package/dist/cjs/resources/catalog/testClocks.js +127 -0
  31. package/dist/cjs/resources/checkout/checkoutSessions.js +582 -0
  32. package/dist/cjs/resources/checkout/contributions.js +172 -0
  33. package/dist/cjs/resources/checkout/files.js +133 -0
  34. package/dist/cjs/resources/checkout/index.js +57 -0
  35. package/dist/cjs/resources/checkout/merchants.js +290 -0
  36. package/dist/cjs/resources/checkout/paymentLinks.js +330 -0
  37. package/dist/cjs/resources/checkout/paymentMethodConfigurations.js +262 -0
  38. package/dist/cjs/resources/checkout/shared.js +368 -0
  39. package/dist/cjs/resources/connect/account.js +332 -0
  40. package/dist/cjs/resources/connect/applicationFees.js +113 -0
  41. package/dist/cjs/resources/connect/balance.js +212 -0
  42. package/dist/cjs/resources/connect/connectedAccounts.js +260 -0
  43. package/dist/cjs/resources/connect/index.js +51 -0
  44. package/dist/cjs/resources/connect/onboarding.js +82 -0
  45. package/dist/cjs/resources/connect/payouts.js +196 -0
  46. package/dist/cjs/resources/connect/reporting.js +235 -0
  47. package/dist/cjs/resources/connect/requestLogs.js +110 -0
  48. package/dist/cjs/resources/connect/transfers.js +227 -0
  49. package/dist/cjs/resources/core/customers.js +194 -0
  50. package/dist/cjs/resources/core/index.js +23 -0
  51. package/dist/cjs/resources/core/paymentMethods.js +134 -0
  52. package/dist/cjs/resources/events/events.js +357 -0
  53. package/dist/cjs/resources/events/index.js +29 -0
  54. package/dist/cjs/resources/events/webhookDeliveries.js +93 -0
  55. package/dist/cjs/resources/events/webhookEndpoints.js +215 -0
  56. package/dist/cjs/resources/payments/charges.js +157 -0
  57. package/dist/cjs/resources/payments/disputes.js +204 -0
  58. package/dist/cjs/resources/payments/index.js +41 -0
  59. package/dist/cjs/resources/payments/paymentIntents.js +529 -0
  60. package/dist/cjs/resources/payments/refunds.js +245 -0
  61. package/dist/cjs/resources/payments/setupIntents.js +158 -0
  62. package/dist/cjs/resources/payments/social.js +182 -0
  63. package/dist/cjs/resources/payments/testHelpers.js +39 -0
  64. package/dist/cjs/resources/tax/assessments.js +217 -0
  65. package/dist/cjs/resources/tax/businessProfile.js +99 -0
  66. package/dist/cjs/resources/tax/calculations.js +176 -0
  67. package/dist/cjs/resources/tax/capabilities.js +42 -0
  68. package/dist/cjs/resources/tax/codes.js +37 -0
  69. package/dist/cjs/resources/tax/complianceActions.js +56 -0
  70. package/dist/cjs/resources/tax/deadlines.js +59 -0
  71. package/dist/cjs/resources/tax/documents.js +128 -0
  72. package/dist/cjs/resources/tax/index.js +80 -0
  73. package/dist/cjs/resources/tax/locationEvidence.js +131 -0
  74. package/dist/cjs/resources/tax/operatingLocations.js +98 -0
  75. package/dist/cjs/resources/tax/products.js +67 -0
  76. package/dist/cjs/resources/tax/registrationDeclarations.js +124 -0
  77. package/dist/cjs/resources/tax/registrations.js +82 -0
  78. package/dist/cjs/resources/tax/reports.js +92 -0
  79. package/dist/cjs/resources/tax/reviewItems.js +116 -0
  80. package/dist/cjs/resources/tax/ruleSet.js +68 -0
  81. package/dist/cjs/resources/tax/salesDestinations.js +94 -0
  82. package/dist/cjs/resources/tax/settings.js +104 -0
  83. package/dist/cjs/resources/tax/shared.js +62 -0
  84. package/dist/cjs/resources/tax/transactions.js +102 -0
  85. package/dist/cjs/route.js +22 -0
  86. package/dist/cjs/routes.js +31 -0
  87. package/dist/cjs/vocabulary/billingPortal.js +15 -0
  88. package/dist/cjs/vocabulary/catalog.js +110 -0
  89. package/dist/cjs/vocabulary/checkout.js +53 -0
  90. package/dist/cjs/vocabulary/connect.js +95 -0
  91. package/dist/cjs/vocabulary/errors.js +174 -0
  92. package/dist/cjs/vocabulary/events.js +176 -0
  93. package/dist/cjs/vocabulary/files.js +44 -0
  94. package/dist/cjs/vocabulary/index.js +37 -0
  95. package/dist/cjs/vocabulary/invoices.js +52 -0
  96. package/dist/cjs/vocabulary/lists.js +22 -0
  97. package/dist/cjs/vocabulary/merchants.js +23 -0
  98. package/dist/cjs/vocabulary/money.js +104 -0
  99. package/dist/cjs/vocabulary/paymentMethodConfigurations.js +36 -0
  100. package/dist/cjs/vocabulary/payments.js +195 -0
  101. package/dist/cjs/vocabulary/reporting.js +27 -0
  102. package/dist/cjs/vocabulary/subscriptions.js +60 -0
  103. package/dist/cjs/vocabulary/tax.js +237 -0
  104. package/dist/cjs/vocabulary/version.js +12 -0
  105. package/dist/esm/common/address.js +76 -0
  106. package/dist/esm/common/envelopes.js +95 -0
  107. package/dist/esm/common/objects.js +74 -0
  108. package/dist/esm/common/params.js +203 -0
  109. package/dist/esm/common/primitives.js +35 -0
  110. package/dist/esm/contributions.js +5 -0
  111. package/dist/esm/index.js +26 -94
  112. package/dist/esm/openapi/document.js +294 -0
  113. package/dist/esm/openapi/index.js +2 -0
  114. package/dist/esm/openapi/webhooks.js +14 -0
  115. package/dist/esm/resources/billingEngine/billingPortal.js +234 -0
  116. package/dist/esm/resources/billingEngine/creditNotes.js +186 -0
  117. package/dist/esm/resources/billingEngine/customerBalanceTransactions.js +87 -0
  118. package/dist/esm/resources/billingEngine/index.js +26 -0
  119. package/dist/esm/resources/billingEngine/invoiceItems.js +152 -0
  120. package/dist/esm/resources/billingEngine/invoices.js +506 -0
  121. package/dist/esm/resources/billingEngine/params.js +39 -0
  122. package/dist/esm/resources/billingEngine/public.js +323 -0
  123. package/dist/esm/resources/billingEngine/subscriptions.js +473 -0
  124. package/dist/esm/resources/catalog/billing.js +752 -0
  125. package/dist/esm/resources/catalog/billingSettings.js +128 -0
  126. package/dist/esm/resources/catalog/coupons.js +219 -0
  127. package/dist/esm/resources/catalog/entitlements.js +254 -0
  128. package/dist/esm/resources/catalog/index.js +38 -0
  129. package/dist/esm/resources/catalog/meters.js +276 -0
  130. package/dist/esm/resources/catalog/prices.js +419 -0
  131. package/dist/esm/resources/catalog/products.js +225 -0
  132. package/dist/esm/resources/catalog/promotionCodes.js +171 -0
  133. package/dist/esm/resources/catalog/shared.js +67 -0
  134. package/dist/esm/resources/catalog/testClocks.js +124 -0
  135. package/dist/esm/resources/checkout/checkoutSessions.js +579 -0
  136. package/dist/esm/resources/checkout/contributions.js +167 -0
  137. package/dist/esm/resources/checkout/files.js +130 -0
  138. package/dist/esm/resources/checkout/index.js +25 -0
  139. package/dist/esm/resources/checkout/merchants.js +287 -0
  140. package/dist/esm/resources/checkout/paymentLinks.js +327 -0
  141. package/dist/esm/resources/checkout/paymentMethodConfigurations.js +259 -0
  142. package/dist/esm/resources/checkout/shared.js +363 -0
  143. package/dist/esm/resources/connect/account.js +329 -0
  144. package/dist/esm/resources/connect/applicationFees.js +110 -0
  145. package/dist/esm/resources/connect/balance.js +209 -0
  146. package/dist/esm/resources/connect/connectedAccounts.js +257 -0
  147. package/dist/esm/resources/connect/index.js +34 -0
  148. package/dist/esm/resources/connect/onboarding.js +79 -0
  149. package/dist/esm/resources/connect/payouts.js +193 -0
  150. package/dist/esm/resources/connect/reporting.js +232 -0
  151. package/dist/esm/resources/connect/requestLogs.js +107 -0
  152. package/dist/esm/resources/connect/transfers.js +224 -0
  153. package/dist/esm/resources/core/customers.js +191 -0
  154. package/dist/esm/resources/core/index.js +6 -0
  155. package/dist/esm/resources/core/paymentMethods.js +131 -0
  156. package/dist/esm/resources/events/events.js +353 -0
  157. package/dist/esm/resources/events/index.js +12 -0
  158. package/dist/esm/resources/events/webhookDeliveries.js +90 -0
  159. package/dist/esm/resources/events/webhookEndpoints.js +212 -0
  160. package/dist/esm/resources/payments/charges.js +154 -0
  161. package/dist/esm/resources/payments/disputes.js +201 -0
  162. package/dist/esm/resources/payments/index.js +24 -0
  163. package/dist/esm/resources/payments/paymentIntents.js +526 -0
  164. package/dist/esm/resources/payments/refunds.js +242 -0
  165. package/dist/esm/resources/payments/setupIntents.js +155 -0
  166. package/dist/esm/resources/payments/social.js +179 -0
  167. package/dist/esm/resources/payments/testHelpers.js +36 -0
  168. package/dist/esm/resources/tax/assessments.js +214 -0
  169. package/dist/esm/resources/tax/businessProfile.js +96 -0
  170. package/dist/esm/resources/tax/calculations.js +173 -0
  171. package/dist/esm/resources/tax/capabilities.js +39 -0
  172. package/dist/esm/resources/tax/codes.js +34 -0
  173. package/dist/esm/resources/tax/complianceActions.js +53 -0
  174. package/dist/esm/resources/tax/deadlines.js +56 -0
  175. package/dist/esm/resources/tax/documents.js +125 -0
  176. package/dist/esm/resources/tax/index.js +63 -0
  177. package/dist/esm/resources/tax/locationEvidence.js +128 -0
  178. package/dist/esm/resources/tax/operatingLocations.js +95 -0
  179. package/dist/esm/resources/tax/products.js +64 -0
  180. package/dist/esm/resources/tax/registrationDeclarations.js +121 -0
  181. package/dist/esm/resources/tax/registrations.js +79 -0
  182. package/dist/esm/resources/tax/reports.js +89 -0
  183. package/dist/esm/resources/tax/reviewItems.js +113 -0
  184. package/dist/esm/resources/tax/ruleSet.js +65 -0
  185. package/dist/esm/resources/tax/salesDestinations.js +91 -0
  186. package/dist/esm/resources/tax/settings.js +101 -0
  187. package/dist/esm/resources/tax/shared.js +58 -0
  188. package/dist/esm/resources/tax/transactions.js +99 -0
  189. package/dist/esm/route.js +16 -0
  190. package/dist/esm/routes.js +27 -0
  191. package/dist/esm/vocabulary/billingPortal.js +12 -0
  192. package/dist/esm/vocabulary/catalog.js +106 -0
  193. package/dist/esm/vocabulary/checkout.js +50 -0
  194. package/dist/esm/vocabulary/connect.js +92 -0
  195. package/dist/esm/vocabulary/errors.js +169 -0
  196. package/dist/esm/vocabulary/events.js +173 -0
  197. package/dist/esm/vocabulary/files.js +41 -0
  198. package/dist/esm/vocabulary/index.js +21 -0
  199. package/dist/esm/vocabulary/invoices.js +49 -0
  200. package/dist/esm/vocabulary/lists.js +19 -0
  201. package/dist/esm/vocabulary/merchants.js +20 -0
  202. package/dist/esm/vocabulary/money.js +98 -0
  203. package/dist/esm/vocabulary/paymentMethodConfigurations.js +33 -0
  204. package/dist/esm/vocabulary/payments.js +192 -0
  205. package/dist/esm/vocabulary/reporting.js +24 -0
  206. package/dist/esm/vocabulary/subscriptions.js +57 -0
  207. package/dist/esm/vocabulary/tax.js +233 -0
  208. package/dist/esm/vocabulary/version.js +9 -0
  209. package/dist/types/common/address.d.ts +62 -0
  210. package/dist/types/common/envelopes.d.ts +88 -0
  211. package/dist/types/common/objects.d.ts +107 -0
  212. package/dist/types/common/params.d.ts +156 -0
  213. package/dist/types/common/primitives.d.ts +56 -0
  214. package/dist/types/contributions.d.ts +1 -0
  215. package/dist/types/index.d.ts +16 -134
  216. package/dist/types/openapi/document.d.ts +16 -0
  217. package/dist/types/openapi/index.d.ts +2 -0
  218. package/dist/types/openapi/webhooks.d.ts +15 -0
  219. package/dist/types/resources/billingEngine/billingPortal.d.ts +742 -0
  220. package/dist/types/resources/billingEngine/creditNotes.d.ts +655 -0
  221. package/dist/types/resources/billingEngine/customerBalanceTransactions.d.ts +282 -0
  222. package/dist/types/resources/billingEngine/index.d.ts +6071 -0
  223. package/dist/types/resources/billingEngine/invoiceItems.d.ts +502 -0
  224. package/dist/types/resources/billingEngine/invoices.d.ts +2547 -0
  225. package/dist/types/resources/billingEngine/params.d.ts +51 -0
  226. package/dist/types/resources/billingEngine/public.d.ts +1860 -0
  227. package/dist/types/resources/billingEngine/subscriptions.d.ts +1519 -0
  228. package/dist/types/resources/catalog/billing.d.ts +1723 -0
  229. package/dist/types/resources/catalog/billingSettings.d.ts +160 -0
  230. package/dist/types/resources/catalog/coupons.d.ts +403 -0
  231. package/dist/types/resources/catalog/entitlements.d.ts +422 -0
  232. package/dist/types/resources/catalog/index.d.ts +3155 -0
  233. package/dist/types/resources/catalog/meters.d.ts +474 -0
  234. package/dist/types/resources/catalog/prices.d.ts +1091 -0
  235. package/dist/types/resources/catalog/products.d.ts +430 -0
  236. package/dist/types/resources/catalog/promotionCodes.d.ts +369 -0
  237. package/dist/types/resources/catalog/shared.d.ts +34 -0
  238. package/dist/types/resources/catalog/testClocks.d.ts +220 -0
  239. package/dist/types/resources/checkout/checkoutSessions.d.ts +3207 -0
  240. package/dist/types/resources/checkout/contributions.d.ts +375 -0
  241. package/dist/types/resources/checkout/files.d.ts +280 -0
  242. package/dist/types/resources/checkout/index.d.ts +5678 -0
  243. package/dist/types/resources/checkout/merchants.d.ts +395 -0
  244. package/dist/types/resources/checkout/paymentLinks.d.ts +1728 -0
  245. package/dist/types/resources/checkout/paymentMethodConfigurations.d.ts +2104 -0
  246. package/dist/types/resources/checkout/shared.d.ts +419 -0
  247. package/dist/types/resources/connect/account.d.ts +483 -0
  248. package/dist/types/resources/connect/applicationFees.d.ts +198 -0
  249. package/dist/types/resources/connect/balance.d.ts +399 -0
  250. package/dist/types/resources/connect/connectedAccounts.d.ts +494 -0
  251. package/dist/types/resources/connect/index.d.ts +2094 -0
  252. package/dist/types/resources/connect/onboarding.d.ts +95 -0
  253. package/dist/types/resources/connect/payouts.d.ts +527 -0
  254. package/dist/types/resources/connect/reporting.d.ts +506 -0
  255. package/dist/types/resources/connect/requestLogs.d.ts +236 -0
  256. package/dist/types/resources/connect/transfers.d.ts +436 -0
  257. package/dist/types/resources/core/customers.d.ts +619 -0
  258. package/dist/types/resources/core/index.d.ts +679 -0
  259. package/dist/types/resources/core/paymentMethods.d.ts +336 -0
  260. package/dist/types/resources/events/events.d.ts +731 -0
  261. package/dist/types/resources/events/index.d.ts +1727 -0
  262. package/dist/types/resources/events/webhookDeliveries.d.ts +436 -0
  263. package/dist/types/resources/events/webhookEndpoints.d.ts +1502 -0
  264. package/dist/types/resources/payments/charges.d.ts +390 -0
  265. package/dist/types/resources/payments/disputes.d.ts +822 -0
  266. package/dist/types/resources/payments/index.d.ts +3517 -0
  267. package/dist/types/resources/payments/paymentIntents.d.ts +2080 -0
  268. package/dist/types/resources/payments/refunds.d.ts +684 -0
  269. package/dist/types/resources/payments/setupIntents.d.ts +391 -0
  270. package/dist/types/resources/payments/social.d.ts +266 -0
  271. package/dist/types/resources/payments/testHelpers.d.ts +178 -0
  272. package/dist/types/resources/tax/assessments.d.ts +787 -0
  273. package/dist/types/resources/tax/businessProfile.d.ts +134 -0
  274. package/dist/types/resources/tax/calculations.d.ts +261 -0
  275. package/dist/types/resources/tax/capabilities.d.ts +81 -0
  276. package/dist/types/resources/tax/codes.d.ts +29 -0
  277. package/dist/types/resources/tax/complianceActions.d.ts +97 -0
  278. package/dist/types/resources/tax/deadlines.d.ts +133 -0
  279. package/dist/types/resources/tax/documents.d.ts +257 -0
  280. package/dist/types/resources/tax/index.d.ts +1946 -0
  281. package/dist/types/resources/tax/locationEvidence.d.ts +246 -0
  282. package/dist/types/resources/tax/operatingLocations.d.ts +170 -0
  283. package/dist/types/resources/tax/products.d.ts +68 -0
  284. package/dist/types/resources/tax/registrationDeclarations.d.ts +270 -0
  285. package/dist/types/resources/tax/registrations.d.ts +103 -0
  286. package/dist/types/resources/tax/reports.d.ts +129 -0
  287. package/dist/types/resources/tax/reviewItems.d.ts +226 -0
  288. package/dist/types/resources/tax/ruleSet.d.ts +219 -0
  289. package/dist/types/resources/tax/salesDestinations.d.ts +158 -0
  290. package/dist/types/resources/tax/settings.d.ts +122 -0
  291. package/dist/types/resources/tax/shared.d.ts +43 -0
  292. package/dist/types/resources/tax/transactions.d.ts +404 -0
  293. package/dist/types/route.d.ts +86 -0
  294. package/dist/types/routes.d.ts +23 -0
  295. package/dist/types/vocabulary/billingPortal.d.ts +15 -0
  296. package/dist/types/vocabulary/catalog.d.ts +97 -0
  297. package/dist/types/vocabulary/checkout.d.ts +49 -0
  298. package/dist/types/vocabulary/connect.d.ts +62 -0
  299. package/dist/types/vocabulary/errors.d.ts +145 -0
  300. package/dist/types/vocabulary/events.d.ts +171 -0
  301. package/dist/types/vocabulary/files.d.ts +30 -0
  302. package/dist/types/vocabulary/index.d.ts +17 -0
  303. package/dist/types/vocabulary/invoices.d.ts +39 -0
  304. package/dist/types/vocabulary/lists.d.ts +9 -0
  305. package/dist/types/vocabulary/merchants.d.ts +9 -0
  306. package/dist/types/vocabulary/money.d.ts +59 -0
  307. package/dist/types/vocabulary/paymentMethodConfigurations.d.ts +22 -0
  308. package/dist/types/vocabulary/payments.d.ts +117 -0
  309. package/dist/types/vocabulary/reporting.d.ts +18 -0
  310. package/dist/types/vocabulary/subscriptions.d.ts +45 -0
  311. package/dist/types/vocabulary/tax.d.ts +163 -0
  312. package/dist/types/vocabulary/version.d.ts +10 -0
  313. package/package.json +51 -11
  314. package/dist/cjs/openapi.js +0 -138
  315. package/dist/esm/openapi.js +0 -134
  316. package/dist/types/openapi.d.ts +0 -145
@@ -0,0 +1,1519 @@
1
+ import { z } from 'zod';
2
+ import { type Expand } from '../../common/objects';
3
+ export type { DiscountParams } from './params';
4
+ /**
5
+ * Subscriptions (`sub_…`) and their items (`si_…`) — Orbit's native billing
6
+ * engine (ADR 0018 §1). Stripe's object model on Peable's wire (ADR 0014 D1):
7
+ * snake_case, Unix seconds, `livemode`, every amount a base-unit string.
8
+ */
9
+ /** A discount applied to a subscription or an invoice. */
10
+ export declare const discountSchema: z.ZodObject<{
11
+ object: z.ZodLiteral<"discount">;
12
+ coupon: z.ZodString;
13
+ promotion_code: z.ZodNullable<z.ZodString>;
14
+ start: z.ZodNumber;
15
+ end: z.ZodNullable<z.ZodNumber>;
16
+ }, z.core.$strict>;
17
+ export type Discount = z.output<typeof discountSchema>;
18
+ /** One line of a subscription: a price and a quantity. */
19
+ export declare const subscriptionItemSchema: z.ZodObject<{
20
+ id: z.ZodString;
21
+ object: z.ZodLiteral<"subscription_item">;
22
+ livemode: z.ZodBoolean;
23
+ subscription: z.ZodString;
24
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
25
+ quantity: z.ZodNumber;
26
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
27
+ created: z.ZodNumber;
28
+ }, z.core.$strict>;
29
+ export type SubscriptionItem = Expand<z.output<typeof subscriptionItemSchema>>;
30
+ /** What `DELETE /v1/subscription_items/:id` answers. */
31
+ export declare const deletedSubscriptionItemSchema: z.ZodObject<{
32
+ id: z.ZodString;
33
+ object: z.ZodLiteral<"subscription_item">;
34
+ deleted: z.ZodLiteral<true>;
35
+ }, z.core.$strict>;
36
+ export type DeletedSubscriptionItem = z.output<typeof deletedSubscriptionItemSchema>;
37
+ export declare const subscriptionSchema: z.ZodObject<{
38
+ id: z.ZodString;
39
+ object: z.ZodLiteral<"subscription">;
40
+ livemode: z.ZodBoolean;
41
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
42
+ status: z.ZodEnum<{
43
+ active: "active";
44
+ incomplete: "incomplete";
45
+ incomplete_expired: "incomplete_expired";
46
+ trialing: "trialing";
47
+ past_due: "past_due";
48
+ unpaid: "unpaid";
49
+ canceled: "canceled";
50
+ paused: "paused";
51
+ }>;
52
+ currency: z.ZodEnum<{
53
+ FAIR: "FAIR";
54
+ EUR: "EUR";
55
+ USD: "USD";
56
+ GBP: "GBP";
57
+ CHF: "CHF";
58
+ SEK: "SEK";
59
+ NOK: "NOK";
60
+ DKK: "DKK";
61
+ PLN: "PLN";
62
+ CZK: "CZK";
63
+ CAD: "CAD";
64
+ AUD: "AUD";
65
+ JPY: "JPY";
66
+ }>;
67
+ items: z.ZodObject<{
68
+ object: z.ZodLiteral<"list">;
69
+ data: z.ZodArray<z.ZodObject<{
70
+ id: z.ZodString;
71
+ object: z.ZodLiteral<"subscription_item">;
72
+ livemode: z.ZodBoolean;
73
+ subscription: z.ZodString;
74
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
75
+ quantity: z.ZodNumber;
76
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
77
+ created: z.ZodNumber;
78
+ }, z.core.$strict>>;
79
+ has_more: z.ZodBoolean;
80
+ url: z.ZodString;
81
+ }, z.core.$strict>;
82
+ collection_method: z.ZodEnum<{
83
+ charge_automatically: "charge_automatically";
84
+ send_invoice: "send_invoice";
85
+ }>;
86
+ days_until_due: z.ZodNullable<z.ZodNumber>;
87
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
88
+ description: z.ZodNullable<z.ZodString>;
89
+ billing_cycle_anchor: z.ZodNumber;
90
+ current_period_start: z.ZodNumber;
91
+ current_period_end: z.ZodNumber;
92
+ start_date: z.ZodNumber;
93
+ trial_start: z.ZodNullable<z.ZodNumber>;
94
+ trial_end: z.ZodNullable<z.ZodNumber>;
95
+ trial_settings: z.ZodObject<{
96
+ end_behavior: z.ZodObject<{
97
+ missing_payment_method: z.ZodEnum<{
98
+ cancel: "cancel";
99
+ create_invoice: "create_invoice";
100
+ pause: "pause";
101
+ }>;
102
+ }, z.core.$strict>;
103
+ }, z.core.$strict>;
104
+ cancel_at_period_end: z.ZodBoolean;
105
+ cancel_at: z.ZodNullable<z.ZodNumber>;
106
+ canceled_at: z.ZodNullable<z.ZodNumber>;
107
+ ended_at: z.ZodNullable<z.ZodNumber>;
108
+ cancellation_details: z.ZodObject<{
109
+ reason: z.ZodNullable<z.ZodEnum<{
110
+ cancellation_requested: "cancellation_requested";
111
+ payment_failed: "payment_failed";
112
+ }>>;
113
+ comment: z.ZodNullable<z.ZodString>;
114
+ }, z.core.$strict>;
115
+ pause_collection: z.ZodNullable<z.ZodObject<{
116
+ behavior: z.ZodEnum<{
117
+ void: "void";
118
+ keep_as_draft: "keep_as_draft";
119
+ mark_uncollectible: "mark_uncollectible";
120
+ }>;
121
+ resumes_at: z.ZodNullable<z.ZodNumber>;
122
+ }, z.core.$strict>>;
123
+ automatic_tax: z.ZodObject<{
124
+ enabled: z.ZodBoolean;
125
+ }, z.core.$strict>;
126
+ discount: z.ZodNullable<z.ZodObject<{
127
+ object: z.ZodLiteral<"discount">;
128
+ coupon: z.ZodString;
129
+ promotion_code: z.ZodNullable<z.ZodString>;
130
+ start: z.ZodNumber;
131
+ end: z.ZodNullable<z.ZodNumber>;
132
+ }, z.core.$strict>>;
133
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
134
+ test_clock: z.ZodNullable<z.ZodString>;
135
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
136
+ created: z.ZodNumber;
137
+ }, z.core.$strict>;
138
+ export type Subscription = Expand<z.output<typeof subscriptionSchema>>;
139
+ declare module '../../common/objects' {
140
+ interface ObjectMap {
141
+ subscription: Subscription;
142
+ subscription_item: SubscriptionItem;
143
+ }
144
+ }
145
+ export declare const createSubscriptionParams: z.ZodObject<{
146
+ customer: z.ZodString;
147
+ items: z.ZodArray<z.ZodObject<{
148
+ price: z.ZodString;
149
+ quantity: z.ZodOptional<z.ZodNumber>;
150
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
151
+ }, z.core.$strict>>;
152
+ default_payment_method: z.ZodOptional<z.ZodString>;
153
+ collection_method: z.ZodOptional<z.ZodEnum<{
154
+ charge_automatically: "charge_automatically";
155
+ send_invoice: "send_invoice";
156
+ }>>;
157
+ days_until_due: z.ZodOptional<z.ZodNumber>;
158
+ description: z.ZodOptional<z.ZodString>;
159
+ trial_period_days: z.ZodOptional<z.ZodNumber>;
160
+ trial_end: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"now">]>>;
161
+ trial_settings: z.ZodOptional<z.ZodObject<{
162
+ end_behavior: z.ZodObject<{
163
+ missing_payment_method: z.ZodEnum<{
164
+ cancel: "cancel";
165
+ create_invoice: "create_invoice";
166
+ pause: "pause";
167
+ }>;
168
+ }, z.core.$strict>;
169
+ }, z.core.$strict>>;
170
+ billing_cycle_anchor: z.ZodOptional<z.ZodNumber>;
171
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
172
+ create_prorations: "create_prorations";
173
+ none: "none";
174
+ }>>;
175
+ cancel_at_period_end: z.ZodOptional<z.ZodBoolean>;
176
+ cancel_at: z.ZodOptional<z.ZodNumber>;
177
+ coupon: z.ZodOptional<z.ZodString>;
178
+ promotion_code: z.ZodOptional<z.ZodString>;
179
+ discounts: z.ZodOptional<z.ZodArray<z.ZodObject<{
180
+ coupon: z.ZodOptional<z.ZodString>;
181
+ promotion_code: z.ZodOptional<z.ZodString>;
182
+ }, z.core.$strict>>>;
183
+ payment_behavior: z.ZodOptional<z.ZodEnum<{
184
+ allow_incomplete: "allow_incomplete";
185
+ default_incomplete: "default_incomplete";
186
+ error_if_incomplete: "error_if_incomplete";
187
+ }>>;
188
+ automatic_tax: z.ZodOptional<z.ZodObject<{
189
+ enabled: z.ZodBoolean;
190
+ }, z.core.$strict>>;
191
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
192
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
193
+ }, z.core.$strict>;
194
+ export type CreateSubscriptionParams = z.input<typeof createSubscriptionParams>;
195
+ /** A subscription item as `items[]` of an update names it. */
196
+ declare const updateSubscriptionItemEntry: z.ZodObject<{
197
+ id: z.ZodOptional<z.ZodString>;
198
+ price: z.ZodOptional<z.ZodString>;
199
+ quantity: z.ZodOptional<z.ZodNumber>;
200
+ deleted: z.ZodOptional<z.ZodBoolean>;
201
+ metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
202
+ }, z.core.$strict>;
203
+ export type SubscriptionItemParams = z.input<typeof updateSubscriptionItemEntry>;
204
+ /** A field sent as `""` is cleared; `metadata` is a patch. */
205
+ export declare const updateSubscriptionParams: z.ZodObject<{
206
+ items: z.ZodOptional<z.ZodArray<z.ZodObject<{
207
+ id: z.ZodOptional<z.ZodString>;
208
+ price: z.ZodOptional<z.ZodString>;
209
+ quantity: z.ZodOptional<z.ZodNumber>;
210
+ deleted: z.ZodOptional<z.ZodBoolean>;
211
+ metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
212
+ }, z.core.$strict>>>;
213
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
214
+ create_prorations: "create_prorations";
215
+ none: "none";
216
+ always_invoice: "always_invoice";
217
+ }>>;
218
+ proration_date: z.ZodOptional<z.ZodNumber>;
219
+ default_payment_method: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
220
+ collection_method: z.ZodOptional<z.ZodEnum<{
221
+ charge_automatically: "charge_automatically";
222
+ send_invoice: "send_invoice";
223
+ }>>;
224
+ days_until_due: z.ZodOptional<z.ZodNumber>;
225
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
226
+ cancel_at_period_end: z.ZodOptional<z.ZodBoolean>;
227
+ cancel_at: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"">]>>;
228
+ pause_collection: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
229
+ behavior: z.ZodEnum<{
230
+ void: "void";
231
+ keep_as_draft: "keep_as_draft";
232
+ mark_uncollectible: "mark_uncollectible";
233
+ }>;
234
+ resumes_at: z.ZodOptional<z.ZodNumber>;
235
+ }, z.core.$strict>, z.ZodLiteral<"">]>>;
236
+ trial_end: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"now">]>>;
237
+ coupon: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
238
+ promotion_code: z.ZodOptional<z.ZodString>;
239
+ discounts: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
240
+ coupon: z.ZodOptional<z.ZodString>;
241
+ promotion_code: z.ZodOptional<z.ZodString>;
242
+ }, z.core.$strict>>, z.ZodLiteral<"">]>>;
243
+ payment_behavior: z.ZodOptional<z.ZodEnum<{
244
+ allow_incomplete: "allow_incomplete";
245
+ default_incomplete: "default_incomplete";
246
+ error_if_incomplete: "error_if_incomplete";
247
+ }>>;
248
+ automatic_tax: z.ZodOptional<z.ZodObject<{
249
+ enabled: z.ZodBoolean;
250
+ }, z.core.$strict>>;
251
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
252
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
253
+ }, z.core.$strict>;
254
+ export type UpdateSubscriptionParams = z.input<typeof updateSubscriptionParams>;
255
+ /** `DELETE /v1/subscriptions/:id`: cancel now. */
256
+ export declare const cancelSubscriptionParams: z.ZodObject<{
257
+ invoice_now: z.ZodOptional<z.ZodBoolean>;
258
+ prorate: z.ZodOptional<z.ZodBoolean>;
259
+ cancellation_details: z.ZodOptional<z.ZodObject<{
260
+ comment: z.ZodOptional<z.ZodString>;
261
+ }, z.core.$strict>>;
262
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
263
+ }, z.core.$strict>;
264
+ export type CancelSubscriptionParams = z.input<typeof cancelSubscriptionParams>;
265
+ /** `POST /v1/subscriptions/:id/resume` — a `paused` subscription. */
266
+ export declare const resumeSubscriptionParams: z.ZodObject<{
267
+ billing_cycle_anchor: z.ZodOptional<z.ZodEnum<{
268
+ now: "now";
269
+ unchanged: "unchanged";
270
+ }>>;
271
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
272
+ create_prorations: "create_prorations";
273
+ none: "none";
274
+ always_invoice: "always_invoice";
275
+ }>>;
276
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
277
+ }, z.core.$strict>;
278
+ export type ResumeSubscriptionParams = z.input<typeof resumeSubscriptionParams>;
279
+ export declare const listSubscriptionsQuery: z.ZodObject<{
280
+ limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
281
+ starting_after: z.ZodOptional<z.ZodString>;
282
+ ending_before: z.ZodOptional<z.ZodString>;
283
+ created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
284
+ gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
285
+ gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
286
+ lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
287
+ lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
288
+ }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
289
+ gt?: number | undefined;
290
+ gte?: number | undefined;
291
+ lt?: number | undefined;
292
+ lte?: number | undefined;
293
+ }>>]>>;
294
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
295
+ customer: z.ZodOptional<z.ZodString>;
296
+ price: z.ZodOptional<z.ZodString>;
297
+ status: z.ZodOptional<z.ZodEnum<{
298
+ active: "active";
299
+ incomplete: "incomplete";
300
+ incomplete_expired: "incomplete_expired";
301
+ trialing: "trialing";
302
+ past_due: "past_due";
303
+ unpaid: "unpaid";
304
+ canceled: "canceled";
305
+ paused: "paused";
306
+ all: "all";
307
+ ended: "ended";
308
+ }>>;
309
+ test_clock: z.ZodOptional<z.ZodString>;
310
+ current_period_end: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
311
+ gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
312
+ gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
313
+ lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
314
+ lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
315
+ }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
316
+ gt?: number | undefined;
317
+ gte?: number | undefined;
318
+ lt?: number | undefined;
319
+ lte?: number | undefined;
320
+ }>>]>>;
321
+ }, z.core.$strict>;
322
+ export type SubscriptionListParams = z.input<typeof listSubscriptionsQuery>;
323
+ export declare const createSubscriptionItemParams: z.ZodObject<{
324
+ subscription: z.ZodString;
325
+ price: z.ZodString;
326
+ quantity: z.ZodOptional<z.ZodNumber>;
327
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
328
+ create_prorations: "create_prorations";
329
+ none: "none";
330
+ always_invoice: "always_invoice";
331
+ }>>;
332
+ proration_date: z.ZodOptional<z.ZodNumber>;
333
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
334
+ }, z.core.$strict>;
335
+ export type CreateSubscriptionItemParams = z.input<typeof createSubscriptionItemParams>;
336
+ export declare const updateSubscriptionItemParams: z.ZodObject<{
337
+ price: z.ZodOptional<z.ZodString>;
338
+ quantity: z.ZodOptional<z.ZodNumber>;
339
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
340
+ create_prorations: "create_prorations";
341
+ none: "none";
342
+ always_invoice: "always_invoice";
343
+ }>>;
344
+ proration_date: z.ZodOptional<z.ZodNumber>;
345
+ metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
346
+ }, z.core.$strict>;
347
+ export type UpdateSubscriptionItemParams = z.input<typeof updateSubscriptionItemParams>;
348
+ export declare const deleteSubscriptionItemParams: z.ZodObject<{
349
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
350
+ create_prorations: "create_prorations";
351
+ none: "none";
352
+ always_invoice: "always_invoice";
353
+ }>>;
354
+ proration_date: z.ZodOptional<z.ZodNumber>;
355
+ }, z.core.$strict>;
356
+ export type DeleteSubscriptionItemParams = z.input<typeof deleteSubscriptionItemParams>;
357
+ /** `subscription` is REQUIRED: items are listed per subscription. */
358
+ export declare const listSubscriptionItemsQuery: z.ZodObject<{
359
+ limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
360
+ starting_after: z.ZodOptional<z.ZodString>;
361
+ ending_before: z.ZodOptional<z.ZodString>;
362
+ created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
363
+ gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
364
+ gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
365
+ lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
366
+ lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
367
+ }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
368
+ gt?: number | undefined;
369
+ gte?: number | undefined;
370
+ lt?: number | undefined;
371
+ lte?: number | undefined;
372
+ }>>]>>;
373
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
374
+ subscription: z.ZodString;
375
+ }, z.core.$strict>;
376
+ export type SubscriptionItemListParams = z.input<typeof listSubscriptionItemsQuery>;
377
+ export declare const subscriptionRoutes: readonly [{
378
+ readonly operationId: "createSubscription";
379
+ readonly method: "post";
380
+ readonly path: "/v1/subscriptions";
381
+ readonly tag: "Subscriptions";
382
+ readonly summary: "Create a subscription";
383
+ readonly description: "`payment_behavior` decides what happens when the first invoice cannot be paid at once.";
384
+ readonly auth: "service";
385
+ readonly scope: "payments:write";
386
+ readonly idempotent: true;
387
+ readonly body: z.ZodObject<{
388
+ customer: z.ZodString;
389
+ items: z.ZodArray<z.ZodObject<{
390
+ price: z.ZodString;
391
+ quantity: z.ZodOptional<z.ZodNumber>;
392
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
393
+ }, z.core.$strict>>;
394
+ default_payment_method: z.ZodOptional<z.ZodString>;
395
+ collection_method: z.ZodOptional<z.ZodEnum<{
396
+ charge_automatically: "charge_automatically";
397
+ send_invoice: "send_invoice";
398
+ }>>;
399
+ days_until_due: z.ZodOptional<z.ZodNumber>;
400
+ description: z.ZodOptional<z.ZodString>;
401
+ trial_period_days: z.ZodOptional<z.ZodNumber>;
402
+ trial_end: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"now">]>>;
403
+ trial_settings: z.ZodOptional<z.ZodObject<{
404
+ end_behavior: z.ZodObject<{
405
+ missing_payment_method: z.ZodEnum<{
406
+ cancel: "cancel";
407
+ create_invoice: "create_invoice";
408
+ pause: "pause";
409
+ }>;
410
+ }, z.core.$strict>;
411
+ }, z.core.$strict>>;
412
+ billing_cycle_anchor: z.ZodOptional<z.ZodNumber>;
413
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
414
+ create_prorations: "create_prorations";
415
+ none: "none";
416
+ }>>;
417
+ cancel_at_period_end: z.ZodOptional<z.ZodBoolean>;
418
+ cancel_at: z.ZodOptional<z.ZodNumber>;
419
+ coupon: z.ZodOptional<z.ZodString>;
420
+ promotion_code: z.ZodOptional<z.ZodString>;
421
+ discounts: z.ZodOptional<z.ZodArray<z.ZodObject<{
422
+ coupon: z.ZodOptional<z.ZodString>;
423
+ promotion_code: z.ZodOptional<z.ZodString>;
424
+ }, z.core.$strict>>>;
425
+ payment_behavior: z.ZodOptional<z.ZodEnum<{
426
+ allow_incomplete: "allow_incomplete";
427
+ default_incomplete: "default_incomplete";
428
+ error_if_incomplete: "error_if_incomplete";
429
+ }>>;
430
+ automatic_tax: z.ZodOptional<z.ZodObject<{
431
+ enabled: z.ZodBoolean;
432
+ }, z.core.$strict>>;
433
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
434
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
435
+ }, z.core.$strict>;
436
+ readonly response: z.ZodObject<{
437
+ id: z.ZodString;
438
+ object: z.ZodLiteral<"subscription">;
439
+ livemode: z.ZodBoolean;
440
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
441
+ status: z.ZodEnum<{
442
+ active: "active";
443
+ incomplete: "incomplete";
444
+ incomplete_expired: "incomplete_expired";
445
+ trialing: "trialing";
446
+ past_due: "past_due";
447
+ unpaid: "unpaid";
448
+ canceled: "canceled";
449
+ paused: "paused";
450
+ }>;
451
+ currency: z.ZodEnum<{
452
+ FAIR: "FAIR";
453
+ EUR: "EUR";
454
+ USD: "USD";
455
+ GBP: "GBP";
456
+ CHF: "CHF";
457
+ SEK: "SEK";
458
+ NOK: "NOK";
459
+ DKK: "DKK";
460
+ PLN: "PLN";
461
+ CZK: "CZK";
462
+ CAD: "CAD";
463
+ AUD: "AUD";
464
+ JPY: "JPY";
465
+ }>;
466
+ items: z.ZodObject<{
467
+ object: z.ZodLiteral<"list">;
468
+ data: z.ZodArray<z.ZodObject<{
469
+ id: z.ZodString;
470
+ object: z.ZodLiteral<"subscription_item">;
471
+ livemode: z.ZodBoolean;
472
+ subscription: z.ZodString;
473
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
474
+ quantity: z.ZodNumber;
475
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
476
+ created: z.ZodNumber;
477
+ }, z.core.$strict>>;
478
+ has_more: z.ZodBoolean;
479
+ url: z.ZodString;
480
+ }, z.core.$strict>;
481
+ collection_method: z.ZodEnum<{
482
+ charge_automatically: "charge_automatically";
483
+ send_invoice: "send_invoice";
484
+ }>;
485
+ days_until_due: z.ZodNullable<z.ZodNumber>;
486
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
487
+ description: z.ZodNullable<z.ZodString>;
488
+ billing_cycle_anchor: z.ZodNumber;
489
+ current_period_start: z.ZodNumber;
490
+ current_period_end: z.ZodNumber;
491
+ start_date: z.ZodNumber;
492
+ trial_start: z.ZodNullable<z.ZodNumber>;
493
+ trial_end: z.ZodNullable<z.ZodNumber>;
494
+ trial_settings: z.ZodObject<{
495
+ end_behavior: z.ZodObject<{
496
+ missing_payment_method: z.ZodEnum<{
497
+ cancel: "cancel";
498
+ create_invoice: "create_invoice";
499
+ pause: "pause";
500
+ }>;
501
+ }, z.core.$strict>;
502
+ }, z.core.$strict>;
503
+ cancel_at_period_end: z.ZodBoolean;
504
+ cancel_at: z.ZodNullable<z.ZodNumber>;
505
+ canceled_at: z.ZodNullable<z.ZodNumber>;
506
+ ended_at: z.ZodNullable<z.ZodNumber>;
507
+ cancellation_details: z.ZodObject<{
508
+ reason: z.ZodNullable<z.ZodEnum<{
509
+ cancellation_requested: "cancellation_requested";
510
+ payment_failed: "payment_failed";
511
+ }>>;
512
+ comment: z.ZodNullable<z.ZodString>;
513
+ }, z.core.$strict>;
514
+ pause_collection: z.ZodNullable<z.ZodObject<{
515
+ behavior: z.ZodEnum<{
516
+ void: "void";
517
+ keep_as_draft: "keep_as_draft";
518
+ mark_uncollectible: "mark_uncollectible";
519
+ }>;
520
+ resumes_at: z.ZodNullable<z.ZodNumber>;
521
+ }, z.core.$strict>>;
522
+ automatic_tax: z.ZodObject<{
523
+ enabled: z.ZodBoolean;
524
+ }, z.core.$strict>;
525
+ discount: z.ZodNullable<z.ZodObject<{
526
+ object: z.ZodLiteral<"discount">;
527
+ coupon: z.ZodString;
528
+ promotion_code: z.ZodNullable<z.ZodString>;
529
+ start: z.ZodNumber;
530
+ end: z.ZodNullable<z.ZodNumber>;
531
+ }, z.core.$strict>>;
532
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
533
+ test_clock: z.ZodNullable<z.ZodString>;
534
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
535
+ created: z.ZodNumber;
536
+ }, z.core.$strict>;
537
+ readonly sdk: "subscriptions.create";
538
+ readonly expandable: "subscription";
539
+ }, {
540
+ readonly operationId: "listSubscriptions";
541
+ readonly method: "get";
542
+ readonly path: "/v1/subscriptions";
543
+ readonly tag: "Subscriptions";
544
+ readonly summary: "List subscriptions";
545
+ readonly description: "Newest first. Without `status`, every subscription but the canceled ones.";
546
+ readonly auth: "service";
547
+ readonly scope: "payments:read";
548
+ readonly query: z.ZodObject<{
549
+ limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
550
+ starting_after: z.ZodOptional<z.ZodString>;
551
+ ending_before: z.ZodOptional<z.ZodString>;
552
+ created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
553
+ gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
554
+ gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
555
+ lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
556
+ lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
557
+ }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
558
+ gt?: number | undefined;
559
+ gte?: number | undefined;
560
+ lt?: number | undefined;
561
+ lte?: number | undefined;
562
+ }>>]>>;
563
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
564
+ customer: z.ZodOptional<z.ZodString>;
565
+ price: z.ZodOptional<z.ZodString>;
566
+ status: z.ZodOptional<z.ZodEnum<{
567
+ active: "active";
568
+ incomplete: "incomplete";
569
+ incomplete_expired: "incomplete_expired";
570
+ trialing: "trialing";
571
+ past_due: "past_due";
572
+ unpaid: "unpaid";
573
+ canceled: "canceled";
574
+ paused: "paused";
575
+ all: "all";
576
+ ended: "ended";
577
+ }>>;
578
+ test_clock: z.ZodOptional<z.ZodString>;
579
+ current_period_end: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
580
+ gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
581
+ gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
582
+ lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
583
+ lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
584
+ }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
585
+ gt?: number | undefined;
586
+ gte?: number | undefined;
587
+ lt?: number | undefined;
588
+ lte?: number | undefined;
589
+ }>>]>>;
590
+ }, z.core.$strict>;
591
+ readonly response: z.ZodObject<{
592
+ object: z.ZodLiteral<"list">;
593
+ data: z.ZodArray<z.ZodObject<{
594
+ id: z.ZodString;
595
+ object: z.ZodLiteral<"subscription">;
596
+ livemode: z.ZodBoolean;
597
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
598
+ status: z.ZodEnum<{
599
+ active: "active";
600
+ incomplete: "incomplete";
601
+ incomplete_expired: "incomplete_expired";
602
+ trialing: "trialing";
603
+ past_due: "past_due";
604
+ unpaid: "unpaid";
605
+ canceled: "canceled";
606
+ paused: "paused";
607
+ }>;
608
+ currency: z.ZodEnum<{
609
+ FAIR: "FAIR";
610
+ EUR: "EUR";
611
+ USD: "USD";
612
+ GBP: "GBP";
613
+ CHF: "CHF";
614
+ SEK: "SEK";
615
+ NOK: "NOK";
616
+ DKK: "DKK";
617
+ PLN: "PLN";
618
+ CZK: "CZK";
619
+ CAD: "CAD";
620
+ AUD: "AUD";
621
+ JPY: "JPY";
622
+ }>;
623
+ items: z.ZodObject<{
624
+ object: z.ZodLiteral<"list">;
625
+ data: z.ZodArray<z.ZodObject<{
626
+ id: z.ZodString;
627
+ object: z.ZodLiteral<"subscription_item">;
628
+ livemode: z.ZodBoolean;
629
+ subscription: z.ZodString;
630
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
631
+ quantity: z.ZodNumber;
632
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
633
+ created: z.ZodNumber;
634
+ }, z.core.$strict>>;
635
+ has_more: z.ZodBoolean;
636
+ url: z.ZodString;
637
+ }, z.core.$strict>;
638
+ collection_method: z.ZodEnum<{
639
+ charge_automatically: "charge_automatically";
640
+ send_invoice: "send_invoice";
641
+ }>;
642
+ days_until_due: z.ZodNullable<z.ZodNumber>;
643
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
644
+ description: z.ZodNullable<z.ZodString>;
645
+ billing_cycle_anchor: z.ZodNumber;
646
+ current_period_start: z.ZodNumber;
647
+ current_period_end: z.ZodNumber;
648
+ start_date: z.ZodNumber;
649
+ trial_start: z.ZodNullable<z.ZodNumber>;
650
+ trial_end: z.ZodNullable<z.ZodNumber>;
651
+ trial_settings: z.ZodObject<{
652
+ end_behavior: z.ZodObject<{
653
+ missing_payment_method: z.ZodEnum<{
654
+ cancel: "cancel";
655
+ create_invoice: "create_invoice";
656
+ pause: "pause";
657
+ }>;
658
+ }, z.core.$strict>;
659
+ }, z.core.$strict>;
660
+ cancel_at_period_end: z.ZodBoolean;
661
+ cancel_at: z.ZodNullable<z.ZodNumber>;
662
+ canceled_at: z.ZodNullable<z.ZodNumber>;
663
+ ended_at: z.ZodNullable<z.ZodNumber>;
664
+ cancellation_details: z.ZodObject<{
665
+ reason: z.ZodNullable<z.ZodEnum<{
666
+ cancellation_requested: "cancellation_requested";
667
+ payment_failed: "payment_failed";
668
+ }>>;
669
+ comment: z.ZodNullable<z.ZodString>;
670
+ }, z.core.$strict>;
671
+ pause_collection: z.ZodNullable<z.ZodObject<{
672
+ behavior: z.ZodEnum<{
673
+ void: "void";
674
+ keep_as_draft: "keep_as_draft";
675
+ mark_uncollectible: "mark_uncollectible";
676
+ }>;
677
+ resumes_at: z.ZodNullable<z.ZodNumber>;
678
+ }, z.core.$strict>>;
679
+ automatic_tax: z.ZodObject<{
680
+ enabled: z.ZodBoolean;
681
+ }, z.core.$strict>;
682
+ discount: z.ZodNullable<z.ZodObject<{
683
+ object: z.ZodLiteral<"discount">;
684
+ coupon: z.ZodString;
685
+ promotion_code: z.ZodNullable<z.ZodString>;
686
+ start: z.ZodNumber;
687
+ end: z.ZodNullable<z.ZodNumber>;
688
+ }, z.core.$strict>>;
689
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
690
+ test_clock: z.ZodNullable<z.ZodString>;
691
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
692
+ created: z.ZodNumber;
693
+ }, z.core.$strict>>;
694
+ has_more: z.ZodBoolean;
695
+ url: z.ZodString;
696
+ }, z.core.$strict>;
697
+ readonly sdk: "subscriptions.list";
698
+ readonly expandable: "subscription";
699
+ }, {
700
+ readonly operationId: "retrieveSubscription";
701
+ readonly method: "get";
702
+ readonly path: "/v1/subscriptions/{id}";
703
+ readonly tag: "Subscriptions";
704
+ readonly summary: "Retrieve a subscription";
705
+ readonly auth: "service";
706
+ readonly scope: "payments:read";
707
+ readonly params: {
708
+ readonly id: "The subscription (`sub_…`).";
709
+ };
710
+ readonly query: z.ZodObject<{
711
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
712
+ }, z.core.$strict>;
713
+ readonly response: z.ZodObject<{
714
+ id: z.ZodString;
715
+ object: z.ZodLiteral<"subscription">;
716
+ livemode: z.ZodBoolean;
717
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
718
+ status: z.ZodEnum<{
719
+ active: "active";
720
+ incomplete: "incomplete";
721
+ incomplete_expired: "incomplete_expired";
722
+ trialing: "trialing";
723
+ past_due: "past_due";
724
+ unpaid: "unpaid";
725
+ canceled: "canceled";
726
+ paused: "paused";
727
+ }>;
728
+ currency: z.ZodEnum<{
729
+ FAIR: "FAIR";
730
+ EUR: "EUR";
731
+ USD: "USD";
732
+ GBP: "GBP";
733
+ CHF: "CHF";
734
+ SEK: "SEK";
735
+ NOK: "NOK";
736
+ DKK: "DKK";
737
+ PLN: "PLN";
738
+ CZK: "CZK";
739
+ CAD: "CAD";
740
+ AUD: "AUD";
741
+ JPY: "JPY";
742
+ }>;
743
+ items: z.ZodObject<{
744
+ object: z.ZodLiteral<"list">;
745
+ data: z.ZodArray<z.ZodObject<{
746
+ id: z.ZodString;
747
+ object: z.ZodLiteral<"subscription_item">;
748
+ livemode: z.ZodBoolean;
749
+ subscription: z.ZodString;
750
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
751
+ quantity: z.ZodNumber;
752
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
753
+ created: z.ZodNumber;
754
+ }, z.core.$strict>>;
755
+ has_more: z.ZodBoolean;
756
+ url: z.ZodString;
757
+ }, z.core.$strict>;
758
+ collection_method: z.ZodEnum<{
759
+ charge_automatically: "charge_automatically";
760
+ send_invoice: "send_invoice";
761
+ }>;
762
+ days_until_due: z.ZodNullable<z.ZodNumber>;
763
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
764
+ description: z.ZodNullable<z.ZodString>;
765
+ billing_cycle_anchor: z.ZodNumber;
766
+ current_period_start: z.ZodNumber;
767
+ current_period_end: z.ZodNumber;
768
+ start_date: z.ZodNumber;
769
+ trial_start: z.ZodNullable<z.ZodNumber>;
770
+ trial_end: z.ZodNullable<z.ZodNumber>;
771
+ trial_settings: z.ZodObject<{
772
+ end_behavior: z.ZodObject<{
773
+ missing_payment_method: z.ZodEnum<{
774
+ cancel: "cancel";
775
+ create_invoice: "create_invoice";
776
+ pause: "pause";
777
+ }>;
778
+ }, z.core.$strict>;
779
+ }, z.core.$strict>;
780
+ cancel_at_period_end: z.ZodBoolean;
781
+ cancel_at: z.ZodNullable<z.ZodNumber>;
782
+ canceled_at: z.ZodNullable<z.ZodNumber>;
783
+ ended_at: z.ZodNullable<z.ZodNumber>;
784
+ cancellation_details: z.ZodObject<{
785
+ reason: z.ZodNullable<z.ZodEnum<{
786
+ cancellation_requested: "cancellation_requested";
787
+ payment_failed: "payment_failed";
788
+ }>>;
789
+ comment: z.ZodNullable<z.ZodString>;
790
+ }, z.core.$strict>;
791
+ pause_collection: z.ZodNullable<z.ZodObject<{
792
+ behavior: z.ZodEnum<{
793
+ void: "void";
794
+ keep_as_draft: "keep_as_draft";
795
+ mark_uncollectible: "mark_uncollectible";
796
+ }>;
797
+ resumes_at: z.ZodNullable<z.ZodNumber>;
798
+ }, z.core.$strict>>;
799
+ automatic_tax: z.ZodObject<{
800
+ enabled: z.ZodBoolean;
801
+ }, z.core.$strict>;
802
+ discount: z.ZodNullable<z.ZodObject<{
803
+ object: z.ZodLiteral<"discount">;
804
+ coupon: z.ZodString;
805
+ promotion_code: z.ZodNullable<z.ZodString>;
806
+ start: z.ZodNumber;
807
+ end: z.ZodNullable<z.ZodNumber>;
808
+ }, z.core.$strict>>;
809
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
810
+ test_clock: z.ZodNullable<z.ZodString>;
811
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
812
+ created: z.ZodNumber;
813
+ }, z.core.$strict>;
814
+ readonly sdk: "subscriptions.retrieve";
815
+ readonly expandable: "subscription";
816
+ }, {
817
+ readonly operationId: "updateSubscription";
818
+ readonly method: "post";
819
+ readonly path: "/v1/subscriptions/{id}";
820
+ readonly tag: "Subscriptions";
821
+ readonly summary: "Update a subscription";
822
+ readonly description: "Items, plan changes (prorated as `proration_behavior` says), collection, trial, cancellation at period end, pausing and discounts. A field sent as `\"\"` is cleared; `metadata` is a patch.";
823
+ readonly auth: "service";
824
+ readonly scope: "payments:write";
825
+ readonly idempotent: true;
826
+ readonly params: {
827
+ readonly id: "The subscription (`sub_…`).";
828
+ };
829
+ readonly body: z.ZodObject<{
830
+ items: z.ZodOptional<z.ZodArray<z.ZodObject<{
831
+ id: z.ZodOptional<z.ZodString>;
832
+ price: z.ZodOptional<z.ZodString>;
833
+ quantity: z.ZodOptional<z.ZodNumber>;
834
+ deleted: z.ZodOptional<z.ZodBoolean>;
835
+ metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
836
+ }, z.core.$strict>>>;
837
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
838
+ create_prorations: "create_prorations";
839
+ none: "none";
840
+ always_invoice: "always_invoice";
841
+ }>>;
842
+ proration_date: z.ZodOptional<z.ZodNumber>;
843
+ default_payment_method: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
844
+ collection_method: z.ZodOptional<z.ZodEnum<{
845
+ charge_automatically: "charge_automatically";
846
+ send_invoice: "send_invoice";
847
+ }>>;
848
+ days_until_due: z.ZodOptional<z.ZodNumber>;
849
+ description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
850
+ cancel_at_period_end: z.ZodOptional<z.ZodBoolean>;
851
+ cancel_at: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"">]>>;
852
+ pause_collection: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
853
+ behavior: z.ZodEnum<{
854
+ void: "void";
855
+ keep_as_draft: "keep_as_draft";
856
+ mark_uncollectible: "mark_uncollectible";
857
+ }>;
858
+ resumes_at: z.ZodOptional<z.ZodNumber>;
859
+ }, z.core.$strict>, z.ZodLiteral<"">]>>;
860
+ trial_end: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"now">]>>;
861
+ coupon: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>>;
862
+ promotion_code: z.ZodOptional<z.ZodString>;
863
+ discounts: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
864
+ coupon: z.ZodOptional<z.ZodString>;
865
+ promotion_code: z.ZodOptional<z.ZodString>;
866
+ }, z.core.$strict>>, z.ZodLiteral<"">]>>;
867
+ payment_behavior: z.ZodOptional<z.ZodEnum<{
868
+ allow_incomplete: "allow_incomplete";
869
+ default_incomplete: "default_incomplete";
870
+ error_if_incomplete: "error_if_incomplete";
871
+ }>>;
872
+ automatic_tax: z.ZodOptional<z.ZodObject<{
873
+ enabled: z.ZodBoolean;
874
+ }, z.core.$strict>>;
875
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
876
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
877
+ }, z.core.$strict>;
878
+ readonly response: z.ZodObject<{
879
+ id: z.ZodString;
880
+ object: z.ZodLiteral<"subscription">;
881
+ livemode: z.ZodBoolean;
882
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
883
+ status: z.ZodEnum<{
884
+ active: "active";
885
+ incomplete: "incomplete";
886
+ incomplete_expired: "incomplete_expired";
887
+ trialing: "trialing";
888
+ past_due: "past_due";
889
+ unpaid: "unpaid";
890
+ canceled: "canceled";
891
+ paused: "paused";
892
+ }>;
893
+ currency: z.ZodEnum<{
894
+ FAIR: "FAIR";
895
+ EUR: "EUR";
896
+ USD: "USD";
897
+ GBP: "GBP";
898
+ CHF: "CHF";
899
+ SEK: "SEK";
900
+ NOK: "NOK";
901
+ DKK: "DKK";
902
+ PLN: "PLN";
903
+ CZK: "CZK";
904
+ CAD: "CAD";
905
+ AUD: "AUD";
906
+ JPY: "JPY";
907
+ }>;
908
+ items: z.ZodObject<{
909
+ object: z.ZodLiteral<"list">;
910
+ data: z.ZodArray<z.ZodObject<{
911
+ id: z.ZodString;
912
+ object: z.ZodLiteral<"subscription_item">;
913
+ livemode: z.ZodBoolean;
914
+ subscription: z.ZodString;
915
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
916
+ quantity: z.ZodNumber;
917
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
918
+ created: z.ZodNumber;
919
+ }, z.core.$strict>>;
920
+ has_more: z.ZodBoolean;
921
+ url: z.ZodString;
922
+ }, z.core.$strict>;
923
+ collection_method: z.ZodEnum<{
924
+ charge_automatically: "charge_automatically";
925
+ send_invoice: "send_invoice";
926
+ }>;
927
+ days_until_due: z.ZodNullable<z.ZodNumber>;
928
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
929
+ description: z.ZodNullable<z.ZodString>;
930
+ billing_cycle_anchor: z.ZodNumber;
931
+ current_period_start: z.ZodNumber;
932
+ current_period_end: z.ZodNumber;
933
+ start_date: z.ZodNumber;
934
+ trial_start: z.ZodNullable<z.ZodNumber>;
935
+ trial_end: z.ZodNullable<z.ZodNumber>;
936
+ trial_settings: z.ZodObject<{
937
+ end_behavior: z.ZodObject<{
938
+ missing_payment_method: z.ZodEnum<{
939
+ cancel: "cancel";
940
+ create_invoice: "create_invoice";
941
+ pause: "pause";
942
+ }>;
943
+ }, z.core.$strict>;
944
+ }, z.core.$strict>;
945
+ cancel_at_period_end: z.ZodBoolean;
946
+ cancel_at: z.ZodNullable<z.ZodNumber>;
947
+ canceled_at: z.ZodNullable<z.ZodNumber>;
948
+ ended_at: z.ZodNullable<z.ZodNumber>;
949
+ cancellation_details: z.ZodObject<{
950
+ reason: z.ZodNullable<z.ZodEnum<{
951
+ cancellation_requested: "cancellation_requested";
952
+ payment_failed: "payment_failed";
953
+ }>>;
954
+ comment: z.ZodNullable<z.ZodString>;
955
+ }, z.core.$strict>;
956
+ pause_collection: z.ZodNullable<z.ZodObject<{
957
+ behavior: z.ZodEnum<{
958
+ void: "void";
959
+ keep_as_draft: "keep_as_draft";
960
+ mark_uncollectible: "mark_uncollectible";
961
+ }>;
962
+ resumes_at: z.ZodNullable<z.ZodNumber>;
963
+ }, z.core.$strict>>;
964
+ automatic_tax: z.ZodObject<{
965
+ enabled: z.ZodBoolean;
966
+ }, z.core.$strict>;
967
+ discount: z.ZodNullable<z.ZodObject<{
968
+ object: z.ZodLiteral<"discount">;
969
+ coupon: z.ZodString;
970
+ promotion_code: z.ZodNullable<z.ZodString>;
971
+ start: z.ZodNumber;
972
+ end: z.ZodNullable<z.ZodNumber>;
973
+ }, z.core.$strict>>;
974
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
975
+ test_clock: z.ZodNullable<z.ZodString>;
976
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
977
+ created: z.ZodNumber;
978
+ }, z.core.$strict>;
979
+ readonly sdk: "subscriptions.update";
980
+ readonly expandable: "subscription";
981
+ }, {
982
+ readonly operationId: "cancelSubscription";
983
+ readonly method: "delete";
984
+ readonly path: "/v1/subscriptions/{id}";
985
+ readonly tag: "Subscriptions";
986
+ readonly summary: "Cancel a subscription";
987
+ readonly description: "Now, optionally prorating the unused time and invoicing at once. Answers the canceled subscription.";
988
+ readonly auth: "service";
989
+ readonly scope: "payments:write";
990
+ readonly params: {
991
+ readonly id: "The subscription (`sub_…`).";
992
+ };
993
+ readonly body: z.ZodObject<{
994
+ invoice_now: z.ZodOptional<z.ZodBoolean>;
995
+ prorate: z.ZodOptional<z.ZodBoolean>;
996
+ cancellation_details: z.ZodOptional<z.ZodObject<{
997
+ comment: z.ZodOptional<z.ZodString>;
998
+ }, z.core.$strict>>;
999
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
1000
+ }, z.core.$strict>;
1001
+ readonly response: z.ZodObject<{
1002
+ id: z.ZodString;
1003
+ object: z.ZodLiteral<"subscription">;
1004
+ livemode: z.ZodBoolean;
1005
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
1006
+ status: z.ZodEnum<{
1007
+ active: "active";
1008
+ incomplete: "incomplete";
1009
+ incomplete_expired: "incomplete_expired";
1010
+ trialing: "trialing";
1011
+ past_due: "past_due";
1012
+ unpaid: "unpaid";
1013
+ canceled: "canceled";
1014
+ paused: "paused";
1015
+ }>;
1016
+ currency: z.ZodEnum<{
1017
+ FAIR: "FAIR";
1018
+ EUR: "EUR";
1019
+ USD: "USD";
1020
+ GBP: "GBP";
1021
+ CHF: "CHF";
1022
+ SEK: "SEK";
1023
+ NOK: "NOK";
1024
+ DKK: "DKK";
1025
+ PLN: "PLN";
1026
+ CZK: "CZK";
1027
+ CAD: "CAD";
1028
+ AUD: "AUD";
1029
+ JPY: "JPY";
1030
+ }>;
1031
+ items: z.ZodObject<{
1032
+ object: z.ZodLiteral<"list">;
1033
+ data: z.ZodArray<z.ZodObject<{
1034
+ id: z.ZodString;
1035
+ object: z.ZodLiteral<"subscription_item">;
1036
+ livemode: z.ZodBoolean;
1037
+ subscription: z.ZodString;
1038
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
1039
+ quantity: z.ZodNumber;
1040
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1041
+ created: z.ZodNumber;
1042
+ }, z.core.$strict>>;
1043
+ has_more: z.ZodBoolean;
1044
+ url: z.ZodString;
1045
+ }, z.core.$strict>;
1046
+ collection_method: z.ZodEnum<{
1047
+ charge_automatically: "charge_automatically";
1048
+ send_invoice: "send_invoice";
1049
+ }>;
1050
+ days_until_due: z.ZodNullable<z.ZodNumber>;
1051
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
1052
+ description: z.ZodNullable<z.ZodString>;
1053
+ billing_cycle_anchor: z.ZodNumber;
1054
+ current_period_start: z.ZodNumber;
1055
+ current_period_end: z.ZodNumber;
1056
+ start_date: z.ZodNumber;
1057
+ trial_start: z.ZodNullable<z.ZodNumber>;
1058
+ trial_end: z.ZodNullable<z.ZodNumber>;
1059
+ trial_settings: z.ZodObject<{
1060
+ end_behavior: z.ZodObject<{
1061
+ missing_payment_method: z.ZodEnum<{
1062
+ cancel: "cancel";
1063
+ create_invoice: "create_invoice";
1064
+ pause: "pause";
1065
+ }>;
1066
+ }, z.core.$strict>;
1067
+ }, z.core.$strict>;
1068
+ cancel_at_period_end: z.ZodBoolean;
1069
+ cancel_at: z.ZodNullable<z.ZodNumber>;
1070
+ canceled_at: z.ZodNullable<z.ZodNumber>;
1071
+ ended_at: z.ZodNullable<z.ZodNumber>;
1072
+ cancellation_details: z.ZodObject<{
1073
+ reason: z.ZodNullable<z.ZodEnum<{
1074
+ cancellation_requested: "cancellation_requested";
1075
+ payment_failed: "payment_failed";
1076
+ }>>;
1077
+ comment: z.ZodNullable<z.ZodString>;
1078
+ }, z.core.$strict>;
1079
+ pause_collection: z.ZodNullable<z.ZodObject<{
1080
+ behavior: z.ZodEnum<{
1081
+ void: "void";
1082
+ keep_as_draft: "keep_as_draft";
1083
+ mark_uncollectible: "mark_uncollectible";
1084
+ }>;
1085
+ resumes_at: z.ZodNullable<z.ZodNumber>;
1086
+ }, z.core.$strict>>;
1087
+ automatic_tax: z.ZodObject<{
1088
+ enabled: z.ZodBoolean;
1089
+ }, z.core.$strict>;
1090
+ discount: z.ZodNullable<z.ZodObject<{
1091
+ object: z.ZodLiteral<"discount">;
1092
+ coupon: z.ZodString;
1093
+ promotion_code: z.ZodNullable<z.ZodString>;
1094
+ start: z.ZodNumber;
1095
+ end: z.ZodNullable<z.ZodNumber>;
1096
+ }, z.core.$strict>>;
1097
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
1098
+ test_clock: z.ZodNullable<z.ZodString>;
1099
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1100
+ created: z.ZodNumber;
1101
+ }, z.core.$strict>;
1102
+ readonly sdk: "subscriptions.cancel";
1103
+ readonly expandable: "subscription";
1104
+ }, {
1105
+ readonly operationId: "resumeSubscription";
1106
+ readonly method: "post";
1107
+ readonly path: "/v1/subscriptions/{id}/resume";
1108
+ readonly tag: "Subscriptions";
1109
+ readonly summary: "Resume a paused subscription";
1110
+ readonly auth: "service";
1111
+ readonly scope: "payments:write";
1112
+ readonly idempotent: true;
1113
+ readonly params: {
1114
+ readonly id: "The subscription (`sub_…`).";
1115
+ };
1116
+ readonly body: z.ZodObject<{
1117
+ billing_cycle_anchor: z.ZodOptional<z.ZodEnum<{
1118
+ now: "now";
1119
+ unchanged: "unchanged";
1120
+ }>>;
1121
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
1122
+ create_prorations: "create_prorations";
1123
+ none: "none";
1124
+ always_invoice: "always_invoice";
1125
+ }>>;
1126
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
1127
+ }, z.core.$strict>;
1128
+ readonly response: z.ZodObject<{
1129
+ id: z.ZodString;
1130
+ object: z.ZodLiteral<"subscription">;
1131
+ livemode: z.ZodBoolean;
1132
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
1133
+ status: z.ZodEnum<{
1134
+ active: "active";
1135
+ incomplete: "incomplete";
1136
+ incomplete_expired: "incomplete_expired";
1137
+ trialing: "trialing";
1138
+ past_due: "past_due";
1139
+ unpaid: "unpaid";
1140
+ canceled: "canceled";
1141
+ paused: "paused";
1142
+ }>;
1143
+ currency: z.ZodEnum<{
1144
+ FAIR: "FAIR";
1145
+ EUR: "EUR";
1146
+ USD: "USD";
1147
+ GBP: "GBP";
1148
+ CHF: "CHF";
1149
+ SEK: "SEK";
1150
+ NOK: "NOK";
1151
+ DKK: "DKK";
1152
+ PLN: "PLN";
1153
+ CZK: "CZK";
1154
+ CAD: "CAD";
1155
+ AUD: "AUD";
1156
+ JPY: "JPY";
1157
+ }>;
1158
+ items: z.ZodObject<{
1159
+ object: z.ZodLiteral<"list">;
1160
+ data: z.ZodArray<z.ZodObject<{
1161
+ id: z.ZodString;
1162
+ object: z.ZodLiteral<"subscription_item">;
1163
+ livemode: z.ZodBoolean;
1164
+ subscription: z.ZodString;
1165
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
1166
+ quantity: z.ZodNumber;
1167
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1168
+ created: z.ZodNumber;
1169
+ }, z.core.$strict>>;
1170
+ has_more: z.ZodBoolean;
1171
+ url: z.ZodString;
1172
+ }, z.core.$strict>;
1173
+ collection_method: z.ZodEnum<{
1174
+ charge_automatically: "charge_automatically";
1175
+ send_invoice: "send_invoice";
1176
+ }>;
1177
+ days_until_due: z.ZodNullable<z.ZodNumber>;
1178
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
1179
+ description: z.ZodNullable<z.ZodString>;
1180
+ billing_cycle_anchor: z.ZodNumber;
1181
+ current_period_start: z.ZodNumber;
1182
+ current_period_end: z.ZodNumber;
1183
+ start_date: z.ZodNumber;
1184
+ trial_start: z.ZodNullable<z.ZodNumber>;
1185
+ trial_end: z.ZodNullable<z.ZodNumber>;
1186
+ trial_settings: z.ZodObject<{
1187
+ end_behavior: z.ZodObject<{
1188
+ missing_payment_method: z.ZodEnum<{
1189
+ cancel: "cancel";
1190
+ create_invoice: "create_invoice";
1191
+ pause: "pause";
1192
+ }>;
1193
+ }, z.core.$strict>;
1194
+ }, z.core.$strict>;
1195
+ cancel_at_period_end: z.ZodBoolean;
1196
+ cancel_at: z.ZodNullable<z.ZodNumber>;
1197
+ canceled_at: z.ZodNullable<z.ZodNumber>;
1198
+ ended_at: z.ZodNullable<z.ZodNumber>;
1199
+ cancellation_details: z.ZodObject<{
1200
+ reason: z.ZodNullable<z.ZodEnum<{
1201
+ cancellation_requested: "cancellation_requested";
1202
+ payment_failed: "payment_failed";
1203
+ }>>;
1204
+ comment: z.ZodNullable<z.ZodString>;
1205
+ }, z.core.$strict>;
1206
+ pause_collection: z.ZodNullable<z.ZodObject<{
1207
+ behavior: z.ZodEnum<{
1208
+ void: "void";
1209
+ keep_as_draft: "keep_as_draft";
1210
+ mark_uncollectible: "mark_uncollectible";
1211
+ }>;
1212
+ resumes_at: z.ZodNullable<z.ZodNumber>;
1213
+ }, z.core.$strict>>;
1214
+ automatic_tax: z.ZodObject<{
1215
+ enabled: z.ZodBoolean;
1216
+ }, z.core.$strict>;
1217
+ discount: z.ZodNullable<z.ZodObject<{
1218
+ object: z.ZodLiteral<"discount">;
1219
+ coupon: z.ZodString;
1220
+ promotion_code: z.ZodNullable<z.ZodString>;
1221
+ start: z.ZodNumber;
1222
+ end: z.ZodNullable<z.ZodNumber>;
1223
+ }, z.core.$strict>>;
1224
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
1225
+ test_clock: z.ZodNullable<z.ZodString>;
1226
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1227
+ created: z.ZodNumber;
1228
+ }, z.core.$strict>;
1229
+ readonly sdk: "subscriptions.resume";
1230
+ readonly expandable: "subscription";
1231
+ }, {
1232
+ readonly operationId: "searchSubscriptions";
1233
+ readonly method: "get";
1234
+ readonly path: "/v1/subscriptions/search";
1235
+ readonly tag: "Subscriptions";
1236
+ readonly summary: "Search subscriptions";
1237
+ readonly description: "Stripe's query language over the subscription's fields and `metadata['key']`.";
1238
+ readonly auth: "service";
1239
+ readonly scope: "payments:read";
1240
+ readonly query: z.ZodObject<{
1241
+ query: z.ZodString;
1242
+ limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
1243
+ page: z.ZodOptional<z.ZodString>;
1244
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
1245
+ }, z.core.$strict>;
1246
+ readonly response: z.ZodObject<{
1247
+ object: z.ZodLiteral<"search_result">;
1248
+ data: z.ZodArray<z.ZodObject<{
1249
+ id: z.ZodString;
1250
+ object: z.ZodLiteral<"subscription">;
1251
+ livemode: z.ZodBoolean;
1252
+ customer: z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>;
1253
+ status: z.ZodEnum<{
1254
+ active: "active";
1255
+ incomplete: "incomplete";
1256
+ incomplete_expired: "incomplete_expired";
1257
+ trialing: "trialing";
1258
+ past_due: "past_due";
1259
+ unpaid: "unpaid";
1260
+ canceled: "canceled";
1261
+ paused: "paused";
1262
+ }>;
1263
+ currency: z.ZodEnum<{
1264
+ FAIR: "FAIR";
1265
+ EUR: "EUR";
1266
+ USD: "USD";
1267
+ GBP: "GBP";
1268
+ CHF: "CHF";
1269
+ SEK: "SEK";
1270
+ NOK: "NOK";
1271
+ DKK: "DKK";
1272
+ PLN: "PLN";
1273
+ CZK: "CZK";
1274
+ CAD: "CAD";
1275
+ AUD: "AUD";
1276
+ JPY: "JPY";
1277
+ }>;
1278
+ items: z.ZodObject<{
1279
+ object: z.ZodLiteral<"list">;
1280
+ data: z.ZodArray<z.ZodObject<{
1281
+ id: z.ZodString;
1282
+ object: z.ZodLiteral<"subscription_item">;
1283
+ livemode: z.ZodBoolean;
1284
+ subscription: z.ZodString;
1285
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
1286
+ quantity: z.ZodNumber;
1287
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1288
+ created: z.ZodNumber;
1289
+ }, z.core.$strict>>;
1290
+ has_more: z.ZodBoolean;
1291
+ url: z.ZodString;
1292
+ }, z.core.$strict>;
1293
+ collection_method: z.ZodEnum<{
1294
+ charge_automatically: "charge_automatically";
1295
+ send_invoice: "send_invoice";
1296
+ }>;
1297
+ days_until_due: z.ZodNullable<z.ZodNumber>;
1298
+ default_payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
1299
+ description: z.ZodNullable<z.ZodString>;
1300
+ billing_cycle_anchor: z.ZodNumber;
1301
+ current_period_start: z.ZodNumber;
1302
+ current_period_end: z.ZodNumber;
1303
+ start_date: z.ZodNumber;
1304
+ trial_start: z.ZodNullable<z.ZodNumber>;
1305
+ trial_end: z.ZodNullable<z.ZodNumber>;
1306
+ trial_settings: z.ZodObject<{
1307
+ end_behavior: z.ZodObject<{
1308
+ missing_payment_method: z.ZodEnum<{
1309
+ cancel: "cancel";
1310
+ create_invoice: "create_invoice";
1311
+ pause: "pause";
1312
+ }>;
1313
+ }, z.core.$strict>;
1314
+ }, z.core.$strict>;
1315
+ cancel_at_period_end: z.ZodBoolean;
1316
+ cancel_at: z.ZodNullable<z.ZodNumber>;
1317
+ canceled_at: z.ZodNullable<z.ZodNumber>;
1318
+ ended_at: z.ZodNullable<z.ZodNumber>;
1319
+ cancellation_details: z.ZodObject<{
1320
+ reason: z.ZodNullable<z.ZodEnum<{
1321
+ cancellation_requested: "cancellation_requested";
1322
+ payment_failed: "payment_failed";
1323
+ }>>;
1324
+ comment: z.ZodNullable<z.ZodString>;
1325
+ }, z.core.$strict>;
1326
+ pause_collection: z.ZodNullable<z.ZodObject<{
1327
+ behavior: z.ZodEnum<{
1328
+ void: "void";
1329
+ keep_as_draft: "keep_as_draft";
1330
+ mark_uncollectible: "mark_uncollectible";
1331
+ }>;
1332
+ resumes_at: z.ZodNullable<z.ZodNumber>;
1333
+ }, z.core.$strict>>;
1334
+ automatic_tax: z.ZodObject<{
1335
+ enabled: z.ZodBoolean;
1336
+ }, z.core.$strict>;
1337
+ discount: z.ZodNullable<z.ZodObject<{
1338
+ object: z.ZodLiteral<"discount">;
1339
+ coupon: z.ZodString;
1340
+ promotion_code: z.ZodNullable<z.ZodString>;
1341
+ start: z.ZodNumber;
1342
+ end: z.ZodNullable<z.ZodNumber>;
1343
+ }, z.core.$strict>>;
1344
+ latest_invoice: z.ZodNullable<z.ZodType<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">, z.core.$ZodTypeInternals<string | import("../..").Ref<"invoice">, string | import("../..").Ref<"invoice">>>>;
1345
+ test_clock: z.ZodNullable<z.ZodString>;
1346
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1347
+ created: z.ZodNumber;
1348
+ }, z.core.$strict>>;
1349
+ has_more: z.ZodBoolean;
1350
+ next_page: z.ZodNullable<z.ZodString>;
1351
+ url: z.ZodString;
1352
+ total_count: z.ZodOptional<z.ZodNumber>;
1353
+ }, z.core.$strict>;
1354
+ readonly sdk: "subscriptions.search";
1355
+ readonly expandable: "subscription";
1356
+ }, {
1357
+ readonly operationId: "createSubscriptionItem";
1358
+ readonly method: "post";
1359
+ readonly path: "/v1/subscription_items";
1360
+ readonly tag: "Subscription items";
1361
+ readonly summary: "Add an item to a subscription";
1362
+ readonly description: "Prorated as `proration_behavior` says.";
1363
+ readonly auth: "service";
1364
+ readonly scope: "payments:write";
1365
+ readonly idempotent: true;
1366
+ readonly body: z.ZodObject<{
1367
+ subscription: z.ZodString;
1368
+ price: z.ZodString;
1369
+ quantity: z.ZodOptional<z.ZodNumber>;
1370
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
1371
+ create_prorations: "create_prorations";
1372
+ none: "none";
1373
+ always_invoice: "always_invoice";
1374
+ }>>;
1375
+ proration_date: z.ZodOptional<z.ZodNumber>;
1376
+ metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
1377
+ }, z.core.$strict>;
1378
+ readonly response: z.ZodObject<{
1379
+ id: z.ZodString;
1380
+ object: z.ZodLiteral<"subscription_item">;
1381
+ livemode: z.ZodBoolean;
1382
+ subscription: z.ZodString;
1383
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
1384
+ quantity: z.ZodNumber;
1385
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1386
+ created: z.ZodNumber;
1387
+ }, z.core.$strict>;
1388
+ readonly sdk: "subscriptionItems.create";
1389
+ }, {
1390
+ readonly operationId: "listSubscriptionItems";
1391
+ readonly method: "get";
1392
+ readonly path: "/v1/subscription_items";
1393
+ readonly tag: "Subscription items";
1394
+ readonly summary: "List a subscription's items";
1395
+ readonly auth: "service";
1396
+ readonly scope: "payments:read";
1397
+ readonly query: z.ZodObject<{
1398
+ limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
1399
+ starting_after: z.ZodOptional<z.ZodString>;
1400
+ ending_before: z.ZodOptional<z.ZodString>;
1401
+ created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
1402
+ gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
1403
+ gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
1404
+ lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
1405
+ lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
1406
+ }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
1407
+ gt?: number | undefined;
1408
+ gte?: number | undefined;
1409
+ lt?: number | undefined;
1410
+ lte?: number | undefined;
1411
+ }>>]>>;
1412
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
1413
+ subscription: z.ZodString;
1414
+ }, z.core.$strict>;
1415
+ readonly response: z.ZodObject<{
1416
+ object: z.ZodLiteral<"list">;
1417
+ data: z.ZodArray<z.ZodObject<{
1418
+ id: z.ZodString;
1419
+ object: z.ZodLiteral<"subscription_item">;
1420
+ livemode: z.ZodBoolean;
1421
+ subscription: z.ZodString;
1422
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
1423
+ quantity: z.ZodNumber;
1424
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1425
+ created: z.ZodNumber;
1426
+ }, z.core.$strict>>;
1427
+ has_more: z.ZodBoolean;
1428
+ url: z.ZodString;
1429
+ }, z.core.$strict>;
1430
+ readonly sdk: "subscriptionItems.list";
1431
+ readonly expandable: "subscription_item";
1432
+ }, {
1433
+ readonly operationId: "retrieveSubscriptionItem";
1434
+ readonly method: "get";
1435
+ readonly path: "/v1/subscription_items/{id}";
1436
+ readonly tag: "Subscription items";
1437
+ readonly summary: "Retrieve a subscription item";
1438
+ readonly auth: "service";
1439
+ readonly scope: "payments:read";
1440
+ readonly params: {
1441
+ readonly id: "The subscription item (`si_…`).";
1442
+ };
1443
+ readonly query: z.ZodObject<{
1444
+ expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
1445
+ }, z.core.$strict>;
1446
+ readonly response: z.ZodObject<{
1447
+ id: z.ZodString;
1448
+ object: z.ZodLiteral<"subscription_item">;
1449
+ livemode: z.ZodBoolean;
1450
+ subscription: z.ZodString;
1451
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
1452
+ quantity: z.ZodNumber;
1453
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1454
+ created: z.ZodNumber;
1455
+ }, z.core.$strict>;
1456
+ readonly sdk: "subscriptionItems.retrieve";
1457
+ readonly expandable: "subscription_item";
1458
+ }, {
1459
+ readonly operationId: "updateSubscriptionItem";
1460
+ readonly method: "post";
1461
+ readonly path: "/v1/subscription_items/{id}";
1462
+ readonly tag: "Subscription items";
1463
+ readonly summary: "Update a subscription item";
1464
+ readonly description: "Its price or quantity, prorated as `proration_behavior` says.";
1465
+ readonly auth: "service";
1466
+ readonly scope: "payments:write";
1467
+ readonly idempotent: true;
1468
+ readonly params: {
1469
+ readonly id: "The subscription item (`si_…`).";
1470
+ };
1471
+ readonly body: z.ZodObject<{
1472
+ price: z.ZodOptional<z.ZodString>;
1473
+ quantity: z.ZodOptional<z.ZodNumber>;
1474
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
1475
+ create_prorations: "create_prorations";
1476
+ none: "none";
1477
+ always_invoice: "always_invoice";
1478
+ }>>;
1479
+ proration_date: z.ZodOptional<z.ZodNumber>;
1480
+ metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
1481
+ }, z.core.$strict>;
1482
+ readonly response: z.ZodObject<{
1483
+ id: z.ZodString;
1484
+ object: z.ZodLiteral<"subscription_item">;
1485
+ livemode: z.ZodBoolean;
1486
+ subscription: z.ZodString;
1487
+ price: z.ZodType<import("../..").Ref<"price">, import("../..").Ref<"price">, z.core.$ZodTypeInternals<import("../..").Ref<"price">, import("../..").Ref<"price">>>;
1488
+ quantity: z.ZodNumber;
1489
+ metadata: z.ZodRecord<z.ZodString, z.ZodString>;
1490
+ created: z.ZodNumber;
1491
+ }, z.core.$strict>;
1492
+ readonly sdk: "subscriptionItems.update";
1493
+ }, {
1494
+ readonly operationId: "deleteSubscriptionItem";
1495
+ readonly method: "delete";
1496
+ readonly path: "/v1/subscription_items/{id}";
1497
+ readonly tag: "Subscription items";
1498
+ readonly summary: "Remove an item from a subscription";
1499
+ readonly description: "Prorated as `proration_behavior` says.";
1500
+ readonly auth: "service";
1501
+ readonly scope: "payments:write";
1502
+ readonly params: {
1503
+ readonly id: "The subscription item (`si_…`).";
1504
+ };
1505
+ readonly body: z.ZodObject<{
1506
+ proration_behavior: z.ZodOptional<z.ZodEnum<{
1507
+ create_prorations: "create_prorations";
1508
+ none: "none";
1509
+ always_invoice: "always_invoice";
1510
+ }>>;
1511
+ proration_date: z.ZodOptional<z.ZodNumber>;
1512
+ }, z.core.$strict>;
1513
+ readonly response: z.ZodObject<{
1514
+ id: z.ZodString;
1515
+ object: z.ZodLiteral<"subscription_item">;
1516
+ deleted: z.ZodLiteral<true>;
1517
+ }, z.core.$strict>;
1518
+ readonly sdk: "subscriptionItems.del";
1519
+ }];