chargebee 3.25.0-beta.1 → 3.25.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 (166) hide show
  1. package/CHANGELOG.md +66 -4
  2. package/README.md +0 -39
  3. package/cjs/RequestWrapper.js +1 -28
  4. package/cjs/chargebee.cjs.js +0 -3
  5. package/cjs/chargebee.cjs.worker.js +0 -2
  6. package/cjs/createChargebee.js +0 -5
  7. package/cjs/environment.js +1 -1
  8. package/cjs/resources/api_endpoints.js +1 -2
  9. package/cjs/resources/webhook/eventType.js +2 -0
  10. package/esm/RequestWrapper.js +1 -28
  11. package/esm/chargebee.esm.js +0 -2
  12. package/esm/chargebee.esm.worker.js +0 -1
  13. package/esm/createChargebee.js +0 -5
  14. package/esm/environment.js +1 -1
  15. package/esm/resources/api_endpoints.js +1 -2
  16. package/esm/resources/webhook/eventType.js +2 -0
  17. package/package.json +1 -4
  18. package/types/core.d.ts +23 -6
  19. package/types/index.d.ts +0 -17
  20. package/types/resources/Content.d.ts +0 -1
  21. package/types/resources/Customer.d.ts +14 -4
  22. package/types/resources/Estimate.d.ts +14 -4
  23. package/types/resources/Event.d.ts +2 -0
  24. package/types/resources/Gift.d.ts +23 -6
  25. package/types/resources/HostedPage.d.ts +1 -0
  26. package/types/resources/Invoice.d.ts +14 -5
  27. package/types/resources/OmnichannelSubscription.d.ts +6 -0
  28. package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -0
  29. package/types/resources/PaymentIntent.d.ts +35 -10
  30. package/types/resources/PaymentSource.d.ts +7 -2
  31. package/types/resources/Purchase.d.ts +7 -2
  32. package/types/resources/Subscription.d.ts +49 -14
  33. package/types/resources/WebhookEvent.d.ts +22 -4
  34. package/cjs/chargebeeZodValidationError.js +0 -18
  35. package/cjs/schema/addon.schema.js +0 -153
  36. package/cjs/schema/address.schema.js +0 -35
  37. package/cjs/schema/alert.schema.js +0 -38
  38. package/cjs/schema/attached_item.schema.js +0 -58
  39. package/cjs/schema/business_entity.schema.js +0 -46
  40. package/cjs/schema/card.schema.js +0 -165
  41. package/cjs/schema/comment.schema.js +0 -69
  42. package/cjs/schema/coupon.schema.js +0 -209
  43. package/cjs/schema/coupon_code.schema.js +0 -14
  44. package/cjs/schema/coupon_set.schema.js +0 -28
  45. package/cjs/schema/credit_note.schema.js +0 -288
  46. package/cjs/schema/currency.schema.js +0 -32
  47. package/cjs/schema/customer.schema.js +0 -986
  48. package/cjs/schema/customer_entitlement.schema.js +0 -14
  49. package/cjs/schema/differential_price.schema.js +0 -68
  50. package/cjs/schema/entitlement.schema.js +0 -27
  51. package/cjs/schema/entitlement_override.schema.js +0 -33
  52. package/cjs/schema/estimate.schema.js +0 -1525
  53. package/cjs/schema/export.schema.js +0 -1545
  54. package/cjs/schema/feature.schema.js +0 -37
  55. package/cjs/schema/gift.schema.js +0 -277
  56. package/cjs/schema/hosted_page.schema.js +0 -1649
  57. package/cjs/schema/in_app_subscription.schema.js +0 -68
  58. package/cjs/schema/index.js +0 -80
  59. package/cjs/schema/invoice.schema.js +0 -1467
  60. package/cjs/schema/item.schema.js +0 -91
  61. package/cjs/schema/item_entitlement.schema.js +0 -45
  62. package/cjs/schema/item_family.schema.js +0 -21
  63. package/cjs/schema/item_price.schema.js +0 -190
  64. package/cjs/schema/non_subscription.schema.js +0 -28
  65. package/cjs/schema/offer_event.schema.js +0 -13
  66. package/cjs/schema/offer_fulfillment.schema.js +0 -20
  67. package/cjs/schema/omnichannel_one_time_order.schema.js +0 -26
  68. package/cjs/schema/omnichannel_subscription.schema.js +0 -89
  69. package/cjs/schema/omnichannel_subscription_item.schema.js +0 -13
  70. package/cjs/schema/order.schema.js +0 -273
  71. package/cjs/schema/payment_intent.schema.js +0 -117
  72. package/cjs/schema/payment_schedule_scheme.schema.js +0 -20
  73. package/cjs/schema/payment_source.schema.js +0 -358
  74. package/cjs/schema/payment_voucher.schema.js +0 -57
  75. package/cjs/schema/personalized_offer.schema.js +0 -28
  76. package/cjs/schema/plan.schema.js +0 -225
  77. package/cjs/schema/portal_session.schema.js +0 -22
  78. package/cjs/schema/price_variant.schema.js +0 -36
  79. package/cjs/schema/pricing_page_session.schema.js +0 -135
  80. package/cjs/schema/promotional_credit.schema.js +0 -78
  81. package/cjs/schema/purchase.schema.js +0 -272
  82. package/cjs/schema/quote.schema.js +0 -1557
  83. package/cjs/schema/ramp.schema.js +0 -209
  84. package/cjs/schema/recorded_purchase.schema.js +0 -32
  85. package/cjs/schema/resource_migration.schema.js +0 -14
  86. package/cjs/schema/site_migration_detail.schema.js +0 -81
  87. package/cjs/schema/subscription.schema.js +0 -2993
  88. package/cjs/schema/subscription_entitlement.schema.js +0 -25
  89. package/cjs/schema/time_machine.schema.js +0 -17
  90. package/cjs/schema/transaction.schema.js +0 -70
  91. package/cjs/schema/unbilled_charge.schema.js +0 -113
  92. package/cjs/schema/usage.schema.js +0 -93
  93. package/cjs/schema/usage_charge.schema.js +0 -17
  94. package/cjs/schema/usage_event.schema.js +0 -28
  95. package/cjs/schema/usage_file.schema.js +0 -13
  96. package/cjs/schema/usage_summary.schema.js +0 -17
  97. package/cjs/schema/virtual_bank_account.schema.js +0 -43
  98. package/cjs/schema/webhook_endpoint.schema.js +0 -504
  99. package/cjs/validationLoader.js +0 -59
  100. package/esm/chargebeeZodValidationError.js +0 -14
  101. package/esm/schema/addon.schema.js +0 -150
  102. package/esm/schema/address.schema.js +0 -32
  103. package/esm/schema/alert.schema.js +0 -35
  104. package/esm/schema/attached_item.schema.js +0 -55
  105. package/esm/schema/business_entity.schema.js +0 -43
  106. package/esm/schema/card.schema.js +0 -162
  107. package/esm/schema/comment.schema.js +0 -66
  108. package/esm/schema/coupon.schema.js +0 -206
  109. package/esm/schema/coupon_code.schema.js +0 -11
  110. package/esm/schema/coupon_set.schema.js +0 -25
  111. package/esm/schema/credit_note.schema.js +0 -285
  112. package/esm/schema/currency.schema.js +0 -29
  113. package/esm/schema/customer.schema.js +0 -983
  114. package/esm/schema/customer_entitlement.schema.js +0 -11
  115. package/esm/schema/differential_price.schema.js +0 -65
  116. package/esm/schema/entitlement.schema.js +0 -24
  117. package/esm/schema/entitlement_override.schema.js +0 -30
  118. package/esm/schema/estimate.schema.js +0 -1522
  119. package/esm/schema/export.schema.js +0 -1542
  120. package/esm/schema/feature.schema.js +0 -34
  121. package/esm/schema/gift.schema.js +0 -274
  122. package/esm/schema/hosted_page.schema.js +0 -1646
  123. package/esm/schema/in_app_subscription.schema.js +0 -65
  124. package/esm/schema/index.js +0 -64
  125. package/esm/schema/invoice.schema.js +0 -1464
  126. package/esm/schema/item.schema.js +0 -88
  127. package/esm/schema/item_entitlement.schema.js +0 -42
  128. package/esm/schema/item_family.schema.js +0 -18
  129. package/esm/schema/item_price.schema.js +0 -187
  130. package/esm/schema/non_subscription.schema.js +0 -25
  131. package/esm/schema/offer_event.schema.js +0 -10
  132. package/esm/schema/offer_fulfillment.schema.js +0 -17
  133. package/esm/schema/omnichannel_one_time_order.schema.js +0 -23
  134. package/esm/schema/omnichannel_subscription.schema.js +0 -86
  135. package/esm/schema/omnichannel_subscription_item.schema.js +0 -10
  136. package/esm/schema/order.schema.js +0 -270
  137. package/esm/schema/payment_intent.schema.js +0 -114
  138. package/esm/schema/payment_schedule_scheme.schema.js +0 -17
  139. package/esm/schema/payment_source.schema.js +0 -355
  140. package/esm/schema/payment_voucher.schema.js +0 -54
  141. package/esm/schema/personalized_offer.schema.js +0 -25
  142. package/esm/schema/plan.schema.js +0 -222
  143. package/esm/schema/portal_session.schema.js +0 -19
  144. package/esm/schema/price_variant.schema.js +0 -33
  145. package/esm/schema/pricing_page_session.schema.js +0 -132
  146. package/esm/schema/promotional_credit.schema.js +0 -75
  147. package/esm/schema/purchase.schema.js +0 -269
  148. package/esm/schema/quote.schema.js +0 -1554
  149. package/esm/schema/ramp.schema.js +0 -206
  150. package/esm/schema/recorded_purchase.schema.js +0 -29
  151. package/esm/schema/resource_migration.schema.js +0 -11
  152. package/esm/schema/site_migration_detail.schema.js +0 -78
  153. package/esm/schema/subscription.schema.js +0 -2990
  154. package/esm/schema/subscription_entitlement.schema.js +0 -22
  155. package/esm/schema/time_machine.schema.js +0 -14
  156. package/esm/schema/transaction.schema.js +0 -67
  157. package/esm/schema/unbilled_charge.schema.js +0 -110
  158. package/esm/schema/usage.schema.js +0 -90
  159. package/esm/schema/usage_charge.schema.js +0 -14
  160. package/esm/schema/usage_event.schema.js +0 -25
  161. package/esm/schema/usage_file.schema.js +0 -10
  162. package/esm/schema/usage_summary.schema.js +0 -14
  163. package/esm/schema/virtual_bank_account.schema.js +0 -40
  164. package/esm/schema/webhook_endpoint.schema.js +0 -501
  165. package/esm/validationLoader.js +0 -56
  166. package/types/resources/QuoteEntitlement.d.ts +0 -16
@@ -1,2990 +0,0 @@
1
- // Generated Zod schemas: Subscription
2
- // Actions: create, createForCustomer, createWithItems, subscriptionsForCustomer, contractTermsForSubscription, listDiscounts, removeScheduledCancellation, removeCoupons, update, updateForItems, changeTermEnd, reactivate, addChargeAtTermEnd, chargeAddonAtTermEnd, chargeFutureRenewals, editAdvanceInvoiceSchedule, removeAdvanceInvoiceSchedule, regenerateInvoice, importSubscription, importForCustomer, importContractTerm, importUnbilledCharges, importForItems, overrideBillingProfile, pause, cancel, cancelForItems, resume, move
3
- // Do not edit manually – regenerate via sdk-generator
4
- import { z } from 'zod';
5
- //Subscription.create
6
- const CreateSubscriptionMetaDataSchema = z.looseObject({});
7
- const CreateSubscriptionCustomerSchema = z.looseObject({
8
- id: z.string().max(50).optional(),
9
- email: z.string().email().max(70).optional(),
10
- first_name: z.string().max(150).optional(),
11
- last_name: z.string().max(150).optional(),
12
- company: z.string().max(250).optional(),
13
- phone: z.string().max(50).optional(),
14
- locale: z.string().max(50).optional(),
15
- taxability: z.enum(['taxable', 'exempt']).optional(),
16
- entity_code: z
17
- .enum([
18
- 'a',
19
- 'b',
20
- 'c',
21
- 'd',
22
- 'e',
23
- 'f',
24
- 'g',
25
- 'h',
26
- 'i',
27
- 'j',
28
- 'k',
29
- 'l',
30
- 'm',
31
- 'n',
32
- 'p',
33
- 'q',
34
- 'r',
35
- 'med1',
36
- 'med2',
37
- ])
38
- .optional(),
39
- exempt_number: z.string().max(100).optional(),
40
- net_term_days: z.number().int().optional(),
41
- taxjar_exemption_category: z
42
- .enum(['wholesale', 'government', 'other'])
43
- .optional(),
44
- auto_collection: z.enum(['on', 'off']).optional(),
45
- offline_payment_method: z
46
- .enum([
47
- 'no_preference',
48
- 'cash',
49
- 'check',
50
- 'bank_transfer',
51
- 'ach_credit',
52
- 'sepa_credit',
53
- 'boleto',
54
- 'us_automated_bank_transfer',
55
- 'eu_automated_bank_transfer',
56
- 'uk_automated_bank_transfer',
57
- 'jp_automated_bank_transfer',
58
- 'mx_automated_bank_transfer',
59
- 'custom',
60
- ])
61
- .optional(),
62
- allow_direct_debit: z.boolean().default(false).optional(),
63
- consolidated_invoicing: z.boolean().optional(),
64
- vat_number: z.string().max(20).optional(),
65
- vat_number_prefix: z.string().max(10).optional(),
66
- entity_identifier_scheme: z.string().max(50).optional(),
67
- entity_identifier_standard: z.string().max(50).optional(),
68
- is_einvoice_enabled: z.boolean().optional(),
69
- einvoicing_method: z.enum(['automatic', 'manual', 'site_default']).optional(),
70
- registered_for_gst: z.boolean().optional(),
71
- business_customer_without_vat_number: z.boolean().optional(),
72
- exemption_details: z.array(z.string().optional()).optional(),
73
- customer_type: z
74
- .enum(['residential', 'business', 'senior_citizen', 'industrial'])
75
- .optional(),
76
- });
77
- const CreateSubscriptionAdditionalInformationSchema = z.looseObject({});
78
- const CreateSubscriptionCardSchema = z.object({
79
- gateway: z
80
- .enum([
81
- 'chargebee',
82
- 'chargebee_payments',
83
- 'adyen',
84
- 'stripe',
85
- 'wepay',
86
- 'braintree',
87
- 'authorize_net',
88
- 'paypal_pro',
89
- 'pin',
90
- 'eway',
91
- 'eway_rapid',
92
- 'worldpay',
93
- 'balanced_payments',
94
- 'beanstream',
95
- 'bluepay',
96
- 'elavon',
97
- 'first_data_global',
98
- 'hdfc',
99
- 'migs',
100
- 'nmi',
101
- 'ogone',
102
- 'paymill',
103
- 'paypal_payflow_pro',
104
- 'sage_pay',
105
- 'tco',
106
- 'wirecard',
107
- 'amazon_payments',
108
- 'paypal_express_checkout',
109
- 'orbital',
110
- 'moneris_us',
111
- 'moneris',
112
- 'bluesnap',
113
- 'cybersource',
114
- 'vantiv',
115
- 'checkout_com',
116
- 'paypal',
117
- 'ingenico_direct',
118
- 'exact',
119
- 'mollie',
120
- 'quickbooks',
121
- 'razorpay',
122
- 'global_payments',
123
- 'bank_of_america',
124
- 'ecentric',
125
- 'metrics_global',
126
- 'windcave',
127
- 'pay_com',
128
- 'ebanx',
129
- 'dlocal',
130
- 'nuvei',
131
- 'solidgate',
132
- 'paystack',
133
- 'jp_morgan',
134
- 'deutsche_bank',
135
- 'ezidebit',
136
- 'twikey',
137
- 'tempus',
138
- 'moyasar',
139
- 'payway',
140
- ])
141
- .optional(),
142
- gateway_account_id: z.string().max(50).optional(),
143
- tmp_token: z.string().max(300).optional(),
144
- first_name: z.string().max(50).optional(),
145
- last_name: z.string().max(50).optional(),
146
- number: z.string().max(1500).optional(),
147
- expiry_month: z.number().int().min(1).max(12).optional(),
148
- expiry_year: z.number().int().optional(),
149
- cvv: z.string().max(520).optional(),
150
- preferred_scheme: z
151
- .enum(['cartes_bancaires', 'mastercard', 'visa'])
152
- .optional(),
153
- billing_addr1: z.string().max(150).optional(),
154
- billing_addr2: z.string().max(150).optional(),
155
- billing_city: z.string().max(50).optional(),
156
- billing_state_code: z.string().max(50).optional(),
157
- billing_state: z.string().max(50).optional(),
158
- billing_zip: z.string().max(20).optional(),
159
- billing_country: z.string().max(50).optional(),
160
- ip_address: z.string().max(50).optional(),
161
- additional_information: CreateSubscriptionAdditionalInformationSchema.optional(),
162
- });
163
- const CreateSubscriptionBillingAddressSchema = z.looseObject({});
164
- const CreateSubscriptionBankAccountSchema = z.object({
165
- gateway_account_id: z.string().max(50).optional(),
166
- iban: z.string().max(50).min(10).optional(),
167
- first_name: z.string().max(150).optional(),
168
- last_name: z.string().max(150).optional(),
169
- company: z.string().max(250).optional(),
170
- email: z.string().email().max(70).optional(),
171
- phone: z.string().max(50).optional(),
172
- bank_name: z.string().max(100).optional(),
173
- account_number: z.string().max(17).min(4).optional(),
174
- routing_number: z.string().max(9).min(3).optional(),
175
- bank_code: z.string().max(20).optional(),
176
- account_type: z
177
- .enum(['checking', 'savings', 'business_checking', 'current'])
178
- .optional(),
179
- account_holder_type: z.enum(['individual', 'company']).optional(),
180
- echeck_type: z.enum(['web', 'ppd', 'ccd']).optional(),
181
- issuing_country: z.string().max(50).optional(),
182
- swedish_identity_number: z.string().max(12).min(10).optional(),
183
- billing_address: CreateSubscriptionBillingAddressSchema.optional(),
184
- });
185
- const CreateSubscriptionPaymentMethodSchema = z.object({
186
- type: z
187
- .enum([
188
- 'card',
189
- 'paypal_express_checkout',
190
- 'amazon_payments',
191
- 'direct_debit',
192
- 'generic',
193
- 'alipay',
194
- 'unionpay',
195
- 'apple_pay',
196
- 'wechat_pay',
197
- 'ideal',
198
- 'google_pay',
199
- 'sofort',
200
- 'bancontact',
201
- 'giropay',
202
- 'dotpay',
203
- 'upi',
204
- 'netbanking_emandates',
205
- 'venmo',
206
- 'pay_to',
207
- 'faster_payments',
208
- 'sepa_instant_transfer',
209
- 'automated_bank_transfer',
210
- 'klarna_pay_now',
211
- 'online_banking_poland',
212
- 'payconiq_by_bancontact',
213
- 'electronic_payment_standard',
214
- 'kbc_payment_button',
215
- 'pay_by_bank',
216
- 'trustly',
217
- 'stablecoin',
218
- 'kakao_pay',
219
- 'naver_pay',
220
- 'revolut_pay',
221
- 'cash_app_pay',
222
- 'pix',
223
- 'twint',
224
- 'go_pay',
225
- 'grab_pay',
226
- 'pay_co',
227
- 'after_pay',
228
- 'swish',
229
- 'payme',
230
- ])
231
- .optional(),
232
- gateway: z
233
- .enum([
234
- 'chargebee_payments',
235
- 'adyen',
236
- 'stripe',
237
- 'wepay',
238
- 'braintree',
239
- 'authorize_net',
240
- 'paypal_pro',
241
- 'pin',
242
- 'eway',
243
- 'eway_rapid',
244
- 'worldpay',
245
- 'balanced_payments',
246
- 'beanstream',
247
- 'bluepay',
248
- 'elavon',
249
- 'first_data_global',
250
- 'hdfc',
251
- 'migs',
252
- 'nmi',
253
- 'ogone',
254
- 'paymill',
255
- 'paypal_payflow_pro',
256
- 'sage_pay',
257
- 'tco',
258
- 'wirecard',
259
- 'amazon_payments',
260
- 'paypal_express_checkout',
261
- 'gocardless',
262
- 'orbital',
263
- 'moneris_us',
264
- 'moneris',
265
- 'bluesnap',
266
- 'cybersource',
267
- 'vantiv',
268
- 'checkout_com',
269
- 'paypal',
270
- 'ingenico_direct',
271
- 'exact',
272
- 'mollie',
273
- 'quickbooks',
274
- 'razorpay',
275
- 'global_payments',
276
- 'bank_of_america',
277
- 'ecentric',
278
- 'metrics_global',
279
- 'windcave',
280
- 'pay_com',
281
- 'ebanx',
282
- 'dlocal',
283
- 'nuvei',
284
- 'solidgate',
285
- 'paystack',
286
- 'jp_morgan',
287
- 'deutsche_bank',
288
- 'ezidebit',
289
- 'twikey',
290
- 'tempus',
291
- 'moyasar',
292
- 'payway',
293
- ])
294
- .optional(),
295
- gateway_account_id: z.string().max(50).optional(),
296
- reference_id: z.string().max(200).optional(),
297
- tmp_token: z.string().max(65000).optional(),
298
- issuing_country: z.string().max(50).optional(),
299
- additional_information: CreateSubscriptionAdditionalInformationSchema.optional(),
300
- });
301
- const CreateSubscriptionPaymentIntentSchema = z.object({
302
- id: z.string().max(150).optional(),
303
- gateway_account_id: z.string().max(50).optional(),
304
- gw_token: z.string().max(65000).optional(),
305
- payment_method_type: z
306
- .enum([
307
- 'card',
308
- 'ideal',
309
- 'sofort',
310
- 'bancontact',
311
- 'google_pay',
312
- 'dotpay',
313
- 'giropay',
314
- 'apple_pay',
315
- 'upi',
316
- 'netbanking_emandates',
317
- 'paypal_express_checkout',
318
- 'direct_debit',
319
- 'boleto',
320
- 'venmo',
321
- 'amazon_payments',
322
- 'pay_to',
323
- 'faster_payments',
324
- 'sepa_instant_transfer',
325
- 'klarna_pay_now',
326
- 'online_banking_poland',
327
- 'payconiq_by_bancontact',
328
- 'electronic_payment_standard',
329
- 'kbc_payment_button',
330
- 'pay_by_bank',
331
- 'trustly',
332
- 'stablecoin',
333
- 'kakao_pay',
334
- 'naver_pay',
335
- 'revolut_pay',
336
- 'cash_app_pay',
337
- 'wechat_pay',
338
- 'alipay',
339
- 'pix',
340
- 'twint',
341
- 'go_pay',
342
- 'grab_pay',
343
- 'pay_co',
344
- 'after_pay',
345
- 'swish',
346
- 'payme',
347
- ])
348
- .optional(),
349
- reference_id: z.string().max(65000).optional(),
350
- gw_payment_method_id: z.string().max(65000).optional(),
351
- additional_information: CreateSubscriptionAdditionalInformationSchema.optional(),
352
- });
353
- const CreateSubscriptionShippingAddressSchema = z.object({
354
- first_name: z.string().max(150).optional(),
355
- last_name: z.string().max(150).optional(),
356
- email: z.string().email().max(70).optional(),
357
- company: z.string().max(250).optional(),
358
- phone: z.string().max(50).optional(),
359
- line1: z.string().max(150).optional(),
360
- line2: z.string().max(150).optional(),
361
- line3: z.string().max(150).optional(),
362
- city: z.string().max(50).optional(),
363
- state_code: z.string().max(50).optional(),
364
- state: z.string().max(50).optional(),
365
- zip: z.string().max(20).optional(),
366
- country: z.string().max(50).optional(),
367
- validation_status: z
368
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
369
- .optional(),
370
- });
371
- const CreateSubscriptionStatementDescriptorSchema = z.object({
372
- descriptor: z.string().max(65000).optional(),
373
- });
374
- const CreateSubscriptionContractTermSchema = z.object({
375
- action_at_term_end: z.enum(['renew', 'evergreen', 'cancel']).optional(),
376
- cancellation_cutoff_period: z.number().int().optional(),
377
- });
378
- const CreateSubscriptionEntityIdentifiersSchema = z.object({
379
- id: z.array(z.string().max(40).optional()).optional(),
380
- scheme: z.array(z.string().max(50).optional()).optional(),
381
- value: z.array(z.string().max(50).optional()).optional(),
382
- standard: z.array(z.string().max(50).optional()).optional(),
383
- });
384
- const CreateSubscriptionTaxProvidersFieldsSchema = z.object({
385
- provider_name: z.array(z.string().max(50).optional()).optional(),
386
- field_id: z.array(z.string().max(50).optional()).optional(),
387
- field_value: z.array(z.string().max(50).optional()).optional(),
388
- });
389
- const CreateSubscriptionAddonsSchema = z.object({
390
- id: z.array(z.string().max(100).optional()).optional(),
391
- quantity: z.array(z.number().int().min(1).optional()).optional(),
392
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
393
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
394
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
395
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
396
- trial_end: z.array(z.number().int().optional()).optional(),
397
- });
398
- const CreateSubscriptionEventBasedAddonsSchema = z.object({
399
- id: z.array(z.string().max(100).optional()).optional(),
400
- quantity: z.array(z.number().int().min(1).optional()).optional(),
401
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
402
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
403
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
404
- service_period_in_days: z
405
- .array(z.number().int().min(1).max(4000).optional())
406
- .optional(),
407
- on_event: z
408
- .array(z
409
- .enum([
410
- 'subscription_creation',
411
- 'subscription_trial_start',
412
- 'plan_activation',
413
- 'subscription_activation',
414
- 'contract_termination',
415
- ])
416
- .optional())
417
- .optional(),
418
- charge_once: z.array(z.boolean().default(true).optional()).optional(),
419
- charge_on: z.array(z.enum(['immediately', 'on_event']).optional()).optional(),
420
- });
421
- const CreateSubscriptionCouponsSchema = z.object({
422
- coupon_id: z.array(z.string().max(100).optional()).optional(),
423
- apply_till: z.array(z.number().int().optional()).optional(),
424
- });
425
- const CreateSubscriptionBodySchema = z.looseObject({
426
- id: z.string().max(50).optional(),
427
- plan_id: z.string().max(100),
428
- plan_quantity: z.number().int().min(1).optional(),
429
- plan_quantity_in_decimal: z.string().max(33).optional(),
430
- plan_unit_price: z.number().int().min(0).optional(),
431
- plan_unit_price_in_decimal: z.string().max(39).optional(),
432
- setup_fee: z.number().int().min(0).optional(),
433
- trial_end: z.number().int().optional(),
434
- billing_cycles: z.number().int().min(0).optional(),
435
- mandatory_addons_to_remove: z
436
- .array(z.string().max(100).optional())
437
- .optional(),
438
- start_date: z.number().int().optional(),
439
- coupon: z.string().max(100).optional(),
440
- auto_collection: z.enum(['on', 'off']).optional(),
441
- terms_to_charge: z.number().int().min(1).optional(),
442
- billing_alignment_mode: z.enum(['immediate', 'delayed']).optional(),
443
- offline_payment_method: z
444
- .enum([
445
- 'no_preference',
446
- 'cash',
447
- 'check',
448
- 'bank_transfer',
449
- 'ach_credit',
450
- 'sepa_credit',
451
- 'boleto',
452
- 'us_automated_bank_transfer',
453
- 'eu_automated_bank_transfer',
454
- 'uk_automated_bank_transfer',
455
- 'jp_automated_bank_transfer',
456
- 'mx_automated_bank_transfer',
457
- 'custom',
458
- ])
459
- .optional(),
460
- po_number: z.string().max(100).optional(),
461
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
462
- token_id: z.string().max(40).optional(),
463
- affiliate_token: z.string().max(250).optional(),
464
- created_from_ip: z.string().max(50).optional(),
465
- invoice_notes: z.string().max(2000).optional(),
466
- invoice_date: z.number().int().optional(),
467
- meta_data: CreateSubscriptionMetaDataSchema.optional(),
468
- invoice_immediately: z.boolean().optional(),
469
- free_period: z.number().int().min(1).optional(),
470
- free_period_unit: z.enum(['day', 'week', 'month', 'year']).optional(),
471
- contract_term_billing_cycle_on_renewal: z
472
- .number()
473
- .int()
474
- .min(1)
475
- .max(100)
476
- .optional(),
477
- trial_end_action: z
478
- .enum([
479
- 'site_default',
480
- 'plan_default',
481
- 'activate_subscription',
482
- 'cancel_subscription',
483
- ])
484
- .optional(),
485
- client_profile_id: z.string().max(50).optional(),
486
- payment_initiator: z.enum(['customer', 'merchant']).optional(),
487
- customer: CreateSubscriptionCustomerSchema.optional(),
488
- card: CreateSubscriptionCardSchema.optional(),
489
- bank_account: CreateSubscriptionBankAccountSchema.optional(),
490
- payment_method: CreateSubscriptionPaymentMethodSchema.optional(),
491
- payment_intent: CreateSubscriptionPaymentIntentSchema.optional(),
492
- billing_address: CreateSubscriptionBillingAddressSchema.optional(),
493
- shipping_address: CreateSubscriptionShippingAddressSchema.optional(),
494
- statement_descriptor: CreateSubscriptionStatementDescriptorSchema.optional(),
495
- contract_term: CreateSubscriptionContractTermSchema.optional(),
496
- entity_identifiers: CreateSubscriptionEntityIdentifiersSchema.optional(),
497
- tax_providers_fields: CreateSubscriptionTaxProvidersFieldsSchema.optional(),
498
- addons: CreateSubscriptionAddonsSchema.optional(),
499
- event_based_addons: CreateSubscriptionEventBasedAddonsSchema.optional(),
500
- coupons: CreateSubscriptionCouponsSchema.optional(),
501
- });
502
- export { CreateSubscriptionBodySchema };
503
- //Subscription.createForCustomer
504
- const CreateForCustomerSubscriptionMetaDataSchema = z.looseObject({});
505
- const CreateForCustomerSubscriptionShippingAddressSchema = z.object({
506
- first_name: z.string().max(150).optional(),
507
- last_name: z.string().max(150).optional(),
508
- email: z.string().email().max(70).optional(),
509
- company: z.string().max(250).optional(),
510
- phone: z.string().max(50).optional(),
511
- line1: z.string().max(150).optional(),
512
- line2: z.string().max(150).optional(),
513
- line3: z.string().max(150).optional(),
514
- city: z.string().max(50).optional(),
515
- state_code: z.string().max(50).optional(),
516
- state: z.string().max(50).optional(),
517
- zip: z.string().max(20).optional(),
518
- country: z.string().max(50).optional(),
519
- validation_status: z
520
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
521
- .optional(),
522
- });
523
- const CreateForCustomerSubscriptionStatementDescriptorSchema = z.object({
524
- descriptor: z.string().max(65000).optional(),
525
- });
526
- const CreateForCustomerSubscriptionAdditionalInformationSchema = z.looseObject({});
527
- const CreateForCustomerSubscriptionPaymentIntentSchema = z.object({
528
- id: z.string().max(150).optional(),
529
- gateway_account_id: z.string().max(50).optional(),
530
- gw_token: z.string().max(65000).optional(),
531
- payment_method_type: z
532
- .enum([
533
- 'card',
534
- 'ideal',
535
- 'sofort',
536
- 'bancontact',
537
- 'google_pay',
538
- 'dotpay',
539
- 'giropay',
540
- 'apple_pay',
541
- 'upi',
542
- 'netbanking_emandates',
543
- 'paypal_express_checkout',
544
- 'direct_debit',
545
- 'boleto',
546
- 'venmo',
547
- 'amazon_payments',
548
- 'pay_to',
549
- 'faster_payments',
550
- 'sepa_instant_transfer',
551
- 'klarna_pay_now',
552
- 'online_banking_poland',
553
- 'payconiq_by_bancontact',
554
- 'electronic_payment_standard',
555
- 'kbc_payment_button',
556
- 'pay_by_bank',
557
- 'trustly',
558
- 'stablecoin',
559
- 'kakao_pay',
560
- 'naver_pay',
561
- 'revolut_pay',
562
- 'cash_app_pay',
563
- 'wechat_pay',
564
- 'alipay',
565
- 'pix',
566
- 'twint',
567
- 'go_pay',
568
- 'grab_pay',
569
- 'pay_co',
570
- 'after_pay',
571
- 'swish',
572
- 'payme',
573
- ])
574
- .optional(),
575
- reference_id: z.string().max(65000).optional(),
576
- gw_payment_method_id: z.string().max(65000).optional(),
577
- additional_information: CreateForCustomerSubscriptionAdditionalInformationSchema.optional(),
578
- });
579
- const CreateForCustomerSubscriptionContractTermSchema = z.object({
580
- action_at_term_end: z.enum(['renew', 'evergreen', 'cancel']).optional(),
581
- cancellation_cutoff_period: z.number().int().optional(),
582
- });
583
- const CreateForCustomerSubscriptionAddonsSchema = z.object({
584
- id: z.array(z.string().max(100).optional()).optional(),
585
- quantity: z.array(z.number().int().min(1).optional()).optional(),
586
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
587
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
588
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
589
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
590
- trial_end: z.array(z.number().int().optional()).optional(),
591
- });
592
- const CreateForCustomerSubscriptionEventBasedAddonsSchema = z.object({
593
- id: z.array(z.string().max(100).optional()).optional(),
594
- quantity: z.array(z.number().int().min(1).optional()).optional(),
595
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
596
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
597
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
598
- service_period_in_days: z
599
- .array(z.number().int().min(1).max(4000).optional())
600
- .optional(),
601
- on_event: z
602
- .array(z
603
- .enum([
604
- 'subscription_creation',
605
- 'subscription_trial_start',
606
- 'plan_activation',
607
- 'subscription_activation',
608
- 'contract_termination',
609
- ])
610
- .optional())
611
- .optional(),
612
- charge_once: z.array(z.boolean().default(true).optional()).optional(),
613
- charge_on: z.array(z.enum(['immediately', 'on_event']).optional()).optional(),
614
- });
615
- const CreateForCustomerSubscriptionCouponsSchema = z.object({
616
- coupon_id: z.array(z.string().max(100).optional()).optional(),
617
- apply_till: z.array(z.number().int().optional()).optional(),
618
- });
619
- const CreateForCustomerSubscriptionBodySchema = z.looseObject({
620
- id: z.string().max(50).optional(),
621
- plan_id: z.string().max(100),
622
- plan_quantity: z.number().int().min(1).optional(),
623
- plan_quantity_in_decimal: z.string().max(33).optional(),
624
- plan_unit_price: z.number().int().min(0).optional(),
625
- plan_unit_price_in_decimal: z.string().max(39).optional(),
626
- setup_fee: z.number().int().min(0).optional(),
627
- trial_end: z.number().int().optional(),
628
- billing_cycles: z.number().int().min(0).optional(),
629
- mandatory_addons_to_remove: z
630
- .array(z.string().max(100).optional())
631
- .optional(),
632
- start_date: z.number().int().optional(),
633
- coupon: z.string().max(100).optional(),
634
- auto_collection: z.enum(['on', 'off']).optional(),
635
- terms_to_charge: z.number().int().min(1).optional(),
636
- billing_alignment_mode: z.enum(['immediate', 'delayed']).optional(),
637
- offline_payment_method: z
638
- .enum([
639
- 'no_preference',
640
- 'cash',
641
- 'check',
642
- 'bank_transfer',
643
- 'ach_credit',
644
- 'sepa_credit',
645
- 'boleto',
646
- 'us_automated_bank_transfer',
647
- 'eu_automated_bank_transfer',
648
- 'uk_automated_bank_transfer',
649
- 'jp_automated_bank_transfer',
650
- 'mx_automated_bank_transfer',
651
- 'custom',
652
- ])
653
- .optional(),
654
- po_number: z.string().max(100).optional(),
655
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
656
- payment_source_id: z.string().max(40).optional(),
657
- override_relationship: z.boolean().optional(),
658
- invoice_notes: z.string().max(2000).optional(),
659
- invoice_date: z.number().int().optional(),
660
- meta_data: CreateForCustomerSubscriptionMetaDataSchema.optional(),
661
- invoice_immediately: z.boolean().optional(),
662
- replace_primary_payment_source: z.boolean().default(true).optional(),
663
- free_period: z.number().int().min(1).optional(),
664
- free_period_unit: z.enum(['day', 'week', 'month', 'year']).optional(),
665
- contract_term_billing_cycle_on_renewal: z
666
- .number()
667
- .int()
668
- .min(1)
669
- .max(100)
670
- .optional(),
671
- trial_end_action: z
672
- .enum([
673
- 'site_default',
674
- 'plan_default',
675
- 'activate_subscription',
676
- 'cancel_subscription',
677
- ])
678
- .optional(),
679
- payment_initiator: z.enum(['customer', 'merchant']).optional(),
680
- shipping_address: CreateForCustomerSubscriptionShippingAddressSchema.optional(),
681
- statement_descriptor: CreateForCustomerSubscriptionStatementDescriptorSchema.optional(),
682
- payment_intent: CreateForCustomerSubscriptionPaymentIntentSchema.optional(),
683
- contract_term: CreateForCustomerSubscriptionContractTermSchema.optional(),
684
- addons: CreateForCustomerSubscriptionAddonsSchema.optional(),
685
- event_based_addons: CreateForCustomerSubscriptionEventBasedAddonsSchema.optional(),
686
- coupons: CreateForCustomerSubscriptionCouponsSchema.optional(),
687
- });
688
- export { CreateForCustomerSubscriptionBodySchema };
689
- //Subscription.createWithItems
690
- const CreateWithItemsSubscriptionMetaDataSchema = z.looseObject({});
691
- const CreateWithItemsSubscriptionShippingAddressSchema = z.object({
692
- first_name: z.string().max(150).optional(),
693
- last_name: z.string().max(150).optional(),
694
- email: z.string().email().max(70).optional(),
695
- company: z.string().max(250).optional(),
696
- phone: z.string().max(50).optional(),
697
- line1: z.string().max(150).optional(),
698
- line2: z.string().max(150).optional(),
699
- line3: z.string().max(150).optional(),
700
- city: z.string().max(50).optional(),
701
- state_code: z.string().max(50).optional(),
702
- state: z.string().max(50).optional(),
703
- zip: z.string().max(20).optional(),
704
- country: z.string().max(50).optional(),
705
- validation_status: z
706
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
707
- .optional(),
708
- });
709
- const CreateWithItemsSubscriptionStatementDescriptorSchema = z.object({
710
- descriptor: z.string().max(65000).optional(),
711
- });
712
- const CreateWithItemsSubscriptionAdditionalInformationSchema = z.looseObject({});
713
- const CreateWithItemsSubscriptionPaymentIntentSchema = z.object({
714
- id: z.string().max(150).optional(),
715
- gateway_account_id: z.string().max(50).optional(),
716
- gw_token: z.string().max(65000).optional(),
717
- payment_method_type: z
718
- .enum([
719
- 'card',
720
- 'ideal',
721
- 'sofort',
722
- 'bancontact',
723
- 'google_pay',
724
- 'dotpay',
725
- 'giropay',
726
- 'apple_pay',
727
- 'upi',
728
- 'netbanking_emandates',
729
- 'paypal_express_checkout',
730
- 'direct_debit',
731
- 'boleto',
732
- 'venmo',
733
- 'amazon_payments',
734
- 'pay_to',
735
- 'faster_payments',
736
- 'sepa_instant_transfer',
737
- 'klarna_pay_now',
738
- 'online_banking_poland',
739
- 'payconiq_by_bancontact',
740
- 'electronic_payment_standard',
741
- 'kbc_payment_button',
742
- 'pay_by_bank',
743
- 'trustly',
744
- 'stablecoin',
745
- 'kakao_pay',
746
- 'naver_pay',
747
- 'revolut_pay',
748
- 'cash_app_pay',
749
- 'wechat_pay',
750
- 'alipay',
751
- 'pix',
752
- 'twint',
753
- 'go_pay',
754
- 'grab_pay',
755
- 'pay_co',
756
- 'after_pay',
757
- 'swish',
758
- 'payme',
759
- ])
760
- .optional(),
761
- reference_id: z.string().max(65000).optional(),
762
- gw_payment_method_id: z.string().max(65000).optional(),
763
- additional_information: CreateWithItemsSubscriptionAdditionalInformationSchema.optional(),
764
- });
765
- const CreateWithItemsSubscriptionContractTermSchema = z.object({
766
- action_at_term_end: z.enum(['renew', 'evergreen', 'cancel']).optional(),
767
- contract_start: z.number().int().optional(),
768
- cancellation_cutoff_period: z.number().int().optional(),
769
- });
770
- const CreateWithItemsSubscriptionBillingOverrideSchema = z.object({
771
- max_excess_payment_usage: z.number().int().min(-1).optional(),
772
- max_refundable_credits_usage: z.number().int().min(-1).optional(),
773
- });
774
- const CreateWithItemsSubscriptionSubscriptionItemsSchema = z.object({
775
- item_price_id: z.array(z.string().max(100).optional()),
776
- quantity: z.array(z.number().int().min(1).optional()).optional(),
777
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
778
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
779
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
780
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
781
- trial_end: z.array(z.number().int().optional()).optional(),
782
- service_period_days: z
783
- .array(z.number().int().min(1).max(730).optional())
784
- .optional(),
785
- charge_on_event: z
786
- .array(z
787
- .enum([
788
- 'subscription_creation',
789
- 'subscription_trial_start',
790
- 'plan_activation',
791
- 'subscription_activation',
792
- 'contract_termination',
793
- ])
794
- .optional())
795
- .optional(),
796
- charge_once: z.array(z.boolean().optional()).optional(),
797
- item_type: z.array(z.enum(['plan', 'addon', 'charge']).optional()).optional(),
798
- charge_on_option: z
799
- .array(z.enum(['immediately', 'on_event']).optional())
800
- .optional(),
801
- usage_accumulation_reset_frequency: z
802
- .array(z.enum(['never', 'subscription_billing_frequency']).optional())
803
- .optional(),
804
- });
805
- const CreateWithItemsSubscriptionDiscountsSchema = z.object({
806
- apply_on: z
807
- .array(z.enum(['invoice_amount', 'specific_item_price']).optional())
808
- .optional(),
809
- duration_type: z.array(z.enum(['one_time', 'forever', 'limited_period']).optional()),
810
- percentage: z.array(z.number().min(0.01).max(100).optional()).optional(),
811
- amount: z.array(z.number().int().min(0).optional()).optional(),
812
- period: z.array(z.number().int().min(1).optional()).optional(),
813
- period_unit: z
814
- .array(z.enum(['day', 'week', 'month', 'year']).optional())
815
- .optional(),
816
- included_in_mrr: z.array(z.boolean().optional()).optional(),
817
- item_price_id: z.array(z.string().max(100).optional()).optional(),
818
- quantity: z.array(z.number().int().min(1).optional()).optional(),
819
- });
820
- const CreateWithItemsSubscriptionItemTiersSchema = z.object({
821
- item_price_id: z.array(z.string().max(100).optional()).optional(),
822
- starting_unit: z.array(z.number().int().min(1).optional()).optional(),
823
- ending_unit: z.array(z.number().int().optional()).optional(),
824
- price: z.array(z.number().int().min(0).optional()).optional(),
825
- starting_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
826
- ending_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
827
- price_in_decimal: z.array(z.string().max(39).optional()).optional(),
828
- pricing_type: z
829
- .array(z.enum(['per_unit', 'flat_fee', 'package']).optional())
830
- .optional(),
831
- package_size: z.array(z.number().int().min(1).optional()).optional(),
832
- });
833
- const CreateWithItemsSubscriptionCouponsSchema = z.object({
834
- coupon_id: z.array(z.string().max(100).optional()).optional(),
835
- apply_till: z.array(z.number().int().optional()).optional(),
836
- });
837
- const CreateWithItemsSubscriptionBodySchema = z.looseObject({
838
- id: z.string().max(50).optional(),
839
- business_entity_id: z.string().max(50).optional(),
840
- trial_end: z.number().int().optional(),
841
- billing_cycles: z.number().int().min(0).optional(),
842
- setup_fee: z.number().int().min(0).optional(),
843
- mandatory_items_to_remove: z.array(z.string().max(100).optional()).optional(),
844
- net_term_days: z.number().int().optional(),
845
- start_date: z.number().int().optional(),
846
- coupon: z.string().max(100).optional(),
847
- auto_collection: z.enum(['on', 'off']).optional(),
848
- terms_to_charge: z.number().int().min(1).optional(),
849
- billing_alignment_mode: z.enum(['immediate', 'delayed']).optional(),
850
- offline_payment_method: z
851
- .enum([
852
- 'no_preference',
853
- 'cash',
854
- 'check',
855
- 'bank_transfer',
856
- 'ach_credit',
857
- 'sepa_credit',
858
- 'boleto',
859
- 'us_automated_bank_transfer',
860
- 'eu_automated_bank_transfer',
861
- 'uk_automated_bank_transfer',
862
- 'jp_automated_bank_transfer',
863
- 'mx_automated_bank_transfer',
864
- 'custom',
865
- ])
866
- .optional(),
867
- po_number: z.string().max(100).optional(),
868
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
869
- payment_source_id: z.string().max(40).optional(),
870
- override_relationship: z.boolean().optional(),
871
- invoice_notes: z.string().max(2000).optional(),
872
- invoice_date: z.number().int().optional(),
873
- meta_data: CreateWithItemsSubscriptionMetaDataSchema.optional(),
874
- invoice_immediately: z.boolean().optional(),
875
- replace_primary_payment_source: z.boolean().default(true).optional(),
876
- free_period: z.number().int().min(1).optional(),
877
- free_period_unit: z.enum(['day', 'week', 'month', 'year']).optional(),
878
- contract_term_billing_cycle_on_renewal: z
879
- .number()
880
- .int()
881
- .min(1)
882
- .max(100)
883
- .optional(),
884
- create_pending_invoices: z.boolean().optional(),
885
- auto_close_invoices: z.boolean().optional(),
886
- first_invoice_pending: z.boolean().default(false).optional(),
887
- trial_end_action: z
888
- .enum([
889
- 'site_default',
890
- 'plan_default',
891
- 'activate_subscription',
892
- 'cancel_subscription',
893
- ])
894
- .optional(),
895
- payment_initiator: z.enum(['customer', 'merchant']).optional(),
896
- shipping_address: CreateWithItemsSubscriptionShippingAddressSchema.optional(),
897
- statement_descriptor: CreateWithItemsSubscriptionStatementDescriptorSchema.optional(),
898
- payment_intent: CreateWithItemsSubscriptionPaymentIntentSchema.optional(),
899
- contract_term: CreateWithItemsSubscriptionContractTermSchema.optional(),
900
- billing_override: CreateWithItemsSubscriptionBillingOverrideSchema.optional(),
901
- subscription_items: CreateWithItemsSubscriptionSubscriptionItemsSchema.optional(),
902
- discounts: CreateWithItemsSubscriptionDiscountsSchema.optional(),
903
- item_tiers: CreateWithItemsSubscriptionItemTiersSchema.optional(),
904
- coupons: CreateWithItemsSubscriptionCouponsSchema.optional(),
905
- });
906
- export { CreateWithItemsSubscriptionBodySchema };
907
- //Subscription.subscriptionsForCustomer
908
- const SubscriptionsForCustomerSubscriptionBodySchema = z.looseObject({
909
- limit: z.number().int().min(1).max(100).optional(),
910
- offset: z.string().max(1000).optional(),
911
- });
912
- export { SubscriptionsForCustomerSubscriptionBodySchema };
913
- //Subscription.contractTermsForSubscription
914
- const ContractTermsForSubscriptionSubscriptionSortBySchema = z.looseObject({
915
- asc: z.enum(['created_at']).optional(),
916
- desc: z.enum(['created_at']).optional(),
917
- });
918
- const ContractTermsForSubscriptionSubscriptionBodySchema = z.looseObject({
919
- limit: z.number().int().min(1).max(100).optional(),
920
- offset: z.string().max(1000).optional(),
921
- sort_by: ContractTermsForSubscriptionSubscriptionSortBySchema.optional(),
922
- });
923
- export { ContractTermsForSubscriptionSubscriptionBodySchema };
924
- //Subscription.listDiscounts
925
- const ListDiscountsSubscriptionBodySchema = z.looseObject({
926
- limit: z.number().int().min(1).max(100).optional(),
927
- offset: z.string().max(1000).optional(),
928
- });
929
- export { ListDiscountsSubscriptionBodySchema };
930
- //Subscription.removeScheduledCancellation
931
- const RemoveScheduledCancellationSubscriptionContractTermSchema = z.object({
932
- action_at_term_end: z.enum(['renew', 'evergreen', 'cancel']).optional(),
933
- cancellation_cutoff_period: z.number().int().optional(),
934
- });
935
- const RemoveScheduledCancellationSubscriptionBodySchema = z.looseObject({
936
- billing_cycles: z.number().int().min(0).optional(),
937
- contract_term_billing_cycle_on_renewal: z
938
- .number()
939
- .int()
940
- .min(1)
941
- .max(100)
942
- .optional(),
943
- contract_term: RemoveScheduledCancellationSubscriptionContractTermSchema.optional(),
944
- });
945
- export { RemoveScheduledCancellationSubscriptionBodySchema };
946
- //Subscription.removeCoupons
947
- const RemoveCouponsSubscriptionBodySchema = z.looseObject({
948
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
949
- });
950
- export { RemoveCouponsSubscriptionBodySchema };
951
- //Subscription.update
952
- const UpdateSubscriptionMetaDataSchema = z.looseObject({});
953
- const UpdateSubscriptionAdditionalInformationSchema = z.looseObject({});
954
- const UpdateSubscriptionCardSchema = z.object({
955
- gateway: z
956
- .enum([
957
- 'chargebee',
958
- 'chargebee_payments',
959
- 'adyen',
960
- 'stripe',
961
- 'wepay',
962
- 'braintree',
963
- 'authorize_net',
964
- 'paypal_pro',
965
- 'pin',
966
- 'eway',
967
- 'eway_rapid',
968
- 'worldpay',
969
- 'balanced_payments',
970
- 'beanstream',
971
- 'bluepay',
972
- 'elavon',
973
- 'first_data_global',
974
- 'hdfc',
975
- 'migs',
976
- 'nmi',
977
- 'ogone',
978
- 'paymill',
979
- 'paypal_payflow_pro',
980
- 'sage_pay',
981
- 'tco',
982
- 'wirecard',
983
- 'amazon_payments',
984
- 'paypal_express_checkout',
985
- 'orbital',
986
- 'moneris_us',
987
- 'moneris',
988
- 'bluesnap',
989
- 'cybersource',
990
- 'vantiv',
991
- 'checkout_com',
992
- 'paypal',
993
- 'ingenico_direct',
994
- 'exact',
995
- 'mollie',
996
- 'quickbooks',
997
- 'razorpay',
998
- 'global_payments',
999
- 'bank_of_america',
1000
- 'ecentric',
1001
- 'metrics_global',
1002
- 'windcave',
1003
- 'pay_com',
1004
- 'ebanx',
1005
- 'dlocal',
1006
- 'nuvei',
1007
- 'solidgate',
1008
- 'paystack',
1009
- 'jp_morgan',
1010
- 'deutsche_bank',
1011
- 'ezidebit',
1012
- 'twikey',
1013
- 'tempus',
1014
- 'moyasar',
1015
- 'payway',
1016
- ])
1017
- .optional(),
1018
- gateway_account_id: z.string().max(50).optional(),
1019
- tmp_token: z.string().max(300).optional(),
1020
- first_name: z.string().max(50).optional(),
1021
- last_name: z.string().max(50).optional(),
1022
- number: z.string().max(1500).optional(),
1023
- expiry_month: z.number().int().min(1).max(12).optional(),
1024
- expiry_year: z.number().int().optional(),
1025
- cvv: z.string().max(520).optional(),
1026
- preferred_scheme: z
1027
- .enum(['cartes_bancaires', 'mastercard', 'visa'])
1028
- .optional(),
1029
- billing_addr1: z.string().max(150).optional(),
1030
- billing_addr2: z.string().max(150).optional(),
1031
- billing_city: z.string().max(50).optional(),
1032
- billing_state_code: z.string().max(50).optional(),
1033
- billing_state: z.string().max(50).optional(),
1034
- billing_zip: z.string().max(20).optional(),
1035
- billing_country: z.string().max(50).optional(),
1036
- ip_address: z.string().max(50).optional(),
1037
- additional_information: UpdateSubscriptionAdditionalInformationSchema.optional(),
1038
- });
1039
- const UpdateSubscriptionPaymentMethodSchema = z.object({
1040
- type: z
1041
- .enum([
1042
- 'card',
1043
- 'paypal_express_checkout',
1044
- 'amazon_payments',
1045
- 'direct_debit',
1046
- 'generic',
1047
- 'alipay',
1048
- 'unionpay',
1049
- 'apple_pay',
1050
- 'wechat_pay',
1051
- 'ideal',
1052
- 'google_pay',
1053
- 'sofort',
1054
- 'bancontact',
1055
- 'giropay',
1056
- 'dotpay',
1057
- 'upi',
1058
- 'netbanking_emandates',
1059
- 'venmo',
1060
- 'pay_to',
1061
- 'faster_payments',
1062
- 'sepa_instant_transfer',
1063
- 'automated_bank_transfer',
1064
- 'klarna_pay_now',
1065
- 'online_banking_poland',
1066
- 'payconiq_by_bancontact',
1067
- 'electronic_payment_standard',
1068
- 'kbc_payment_button',
1069
- 'pay_by_bank',
1070
- 'trustly',
1071
- 'stablecoin',
1072
- 'kakao_pay',
1073
- 'naver_pay',
1074
- 'revolut_pay',
1075
- 'cash_app_pay',
1076
- 'pix',
1077
- 'twint',
1078
- 'go_pay',
1079
- 'grab_pay',
1080
- 'pay_co',
1081
- 'after_pay',
1082
- 'swish',
1083
- 'payme',
1084
- ])
1085
- .optional(),
1086
- gateway: z
1087
- .enum([
1088
- 'chargebee_payments',
1089
- 'adyen',
1090
- 'stripe',
1091
- 'wepay',
1092
- 'braintree',
1093
- 'authorize_net',
1094
- 'paypal_pro',
1095
- 'pin',
1096
- 'eway',
1097
- 'eway_rapid',
1098
- 'worldpay',
1099
- 'balanced_payments',
1100
- 'beanstream',
1101
- 'bluepay',
1102
- 'elavon',
1103
- 'first_data_global',
1104
- 'hdfc',
1105
- 'migs',
1106
- 'nmi',
1107
- 'ogone',
1108
- 'paymill',
1109
- 'paypal_payflow_pro',
1110
- 'sage_pay',
1111
- 'tco',
1112
- 'wirecard',
1113
- 'amazon_payments',
1114
- 'paypal_express_checkout',
1115
- 'gocardless',
1116
- 'orbital',
1117
- 'moneris_us',
1118
- 'moneris',
1119
- 'bluesnap',
1120
- 'cybersource',
1121
- 'vantiv',
1122
- 'checkout_com',
1123
- 'paypal',
1124
- 'ingenico_direct',
1125
- 'exact',
1126
- 'mollie',
1127
- 'quickbooks',
1128
- 'razorpay',
1129
- 'global_payments',
1130
- 'bank_of_america',
1131
- 'ecentric',
1132
- 'metrics_global',
1133
- 'windcave',
1134
- 'pay_com',
1135
- 'ebanx',
1136
- 'dlocal',
1137
- 'nuvei',
1138
- 'solidgate',
1139
- 'paystack',
1140
- 'jp_morgan',
1141
- 'deutsche_bank',
1142
- 'ezidebit',
1143
- 'twikey',
1144
- 'tempus',
1145
- 'moyasar',
1146
- 'payway',
1147
- ])
1148
- .optional(),
1149
- gateway_account_id: z.string().max(50).optional(),
1150
- reference_id: z.string().max(200).optional(),
1151
- tmp_token: z.string().max(65000).optional(),
1152
- issuing_country: z.string().max(50).optional(),
1153
- additional_information: UpdateSubscriptionAdditionalInformationSchema.optional(),
1154
- });
1155
- const UpdateSubscriptionPaymentIntentSchema = z.object({
1156
- id: z.string().max(150).optional(),
1157
- gateway_account_id: z.string().max(50).optional(),
1158
- gw_token: z.string().max(65000).optional(),
1159
- payment_method_type: z
1160
- .enum([
1161
- 'card',
1162
- 'ideal',
1163
- 'sofort',
1164
- 'bancontact',
1165
- 'google_pay',
1166
- 'dotpay',
1167
- 'giropay',
1168
- 'apple_pay',
1169
- 'upi',
1170
- 'netbanking_emandates',
1171
- 'paypal_express_checkout',
1172
- 'direct_debit',
1173
- 'boleto',
1174
- 'venmo',
1175
- 'amazon_payments',
1176
- 'pay_to',
1177
- 'faster_payments',
1178
- 'sepa_instant_transfer',
1179
- 'klarna_pay_now',
1180
- 'online_banking_poland',
1181
- 'payconiq_by_bancontact',
1182
- 'electronic_payment_standard',
1183
- 'kbc_payment_button',
1184
- 'pay_by_bank',
1185
- 'trustly',
1186
- 'stablecoin',
1187
- 'kakao_pay',
1188
- 'naver_pay',
1189
- 'revolut_pay',
1190
- 'cash_app_pay',
1191
- 'wechat_pay',
1192
- 'alipay',
1193
- 'pix',
1194
- 'twint',
1195
- 'go_pay',
1196
- 'grab_pay',
1197
- 'pay_co',
1198
- 'after_pay',
1199
- 'swish',
1200
- 'payme',
1201
- ])
1202
- .optional(),
1203
- reference_id: z.string().max(65000).optional(),
1204
- gw_payment_method_id: z.string().max(65000).optional(),
1205
- additional_information: UpdateSubscriptionAdditionalInformationSchema.optional(),
1206
- });
1207
- const UpdateSubscriptionBillingAddressSchema = z.object({
1208
- first_name: z.string().max(150).optional(),
1209
- last_name: z.string().max(150).optional(),
1210
- email: z.string().email().max(70).optional(),
1211
- company: z.string().max(250).optional(),
1212
- phone: z.string().max(50).optional(),
1213
- line1: z.string().max(150).optional(),
1214
- line2: z.string().max(150).optional(),
1215
- line3: z.string().max(150).optional(),
1216
- city: z.string().max(50).optional(),
1217
- state_code: z.string().max(50).optional(),
1218
- state: z.string().max(50).optional(),
1219
- zip: z.string().max(20).optional(),
1220
- country: z.string().max(50).optional(),
1221
- validation_status: z
1222
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
1223
- .optional(),
1224
- });
1225
- const UpdateSubscriptionShippingAddressSchema = z.object({
1226
- first_name: z.string().max(150).optional(),
1227
- last_name: z.string().max(150).optional(),
1228
- email: z.string().email().max(70).optional(),
1229
- company: z.string().max(250).optional(),
1230
- phone: z.string().max(50).optional(),
1231
- line1: z.string().max(150).optional(),
1232
- line2: z.string().max(150).optional(),
1233
- line3: z.string().max(150).optional(),
1234
- city: z.string().max(50).optional(),
1235
- state_code: z.string().max(50).optional(),
1236
- state: z.string().max(50).optional(),
1237
- zip: z.string().max(20).optional(),
1238
- country: z.string().max(50).optional(),
1239
- validation_status: z
1240
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
1241
- .optional(),
1242
- });
1243
- const UpdateSubscriptionStatementDescriptorSchema = z.object({
1244
- descriptor: z.string().max(65000).optional(),
1245
- });
1246
- const UpdateSubscriptionCustomerSchema = z.object({
1247
- vat_number: z.string().max(20).optional(),
1248
- vat_number_prefix: z.string().max(10).optional(),
1249
- entity_identifier_scheme: z.string().max(50).optional(),
1250
- is_einvoice_enabled: z.boolean().optional(),
1251
- einvoicing_method: z.enum(['automatic', 'manual', 'site_default']).optional(),
1252
- entity_identifier_standard: z.string().max(50).optional(),
1253
- business_customer_without_vat_number: z.boolean().optional(),
1254
- registered_for_gst: z.boolean().optional(),
1255
- });
1256
- const UpdateSubscriptionContractTermSchema = z.object({
1257
- action_at_term_end: z
1258
- .enum(['renew', 'evergreen', 'cancel', 'renew_once'])
1259
- .optional(),
1260
- cancellation_cutoff_period: z.number().int().optional(),
1261
- });
1262
- const UpdateSubscriptionAddonsSchema = z.object({
1263
- id: z.array(z.string().max(100).optional()).optional(),
1264
- quantity: z.array(z.number().int().min(1).optional()).optional(),
1265
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
1266
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
1267
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
1268
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
1269
- trial_end: z.array(z.number().int().optional()).optional(),
1270
- proration_type: z
1271
- .array(z.enum(['full_term', 'partial_term', 'none']).optional())
1272
- .optional(),
1273
- });
1274
- const UpdateSubscriptionEventBasedAddonsSchema = z.object({
1275
- id: z.array(z.string().max(100).optional()).optional(),
1276
- quantity: z.array(z.number().int().min(1).optional()).optional(),
1277
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
1278
- service_period_in_days: z
1279
- .array(z.number().int().min(1).max(4000).optional())
1280
- .optional(),
1281
- charge_on: z.array(z.enum(['immediately', 'on_event']).optional()).optional(),
1282
- on_event: z
1283
- .array(z
1284
- .enum([
1285
- 'subscription_creation',
1286
- 'subscription_trial_start',
1287
- 'plan_activation',
1288
- 'subscription_activation',
1289
- 'contract_termination',
1290
- ])
1291
- .optional())
1292
- .optional(),
1293
- charge_once: z.array(z.boolean().default(true).optional()).optional(),
1294
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
1295
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
1296
- });
1297
- const UpdateSubscriptionCouponsSchema = z.object({
1298
- coupon_id: z.array(z.string().max(100).optional()).optional(),
1299
- apply_till: z.array(z.number().int().optional()).optional(),
1300
- });
1301
- const UpdateSubscriptionBodySchema = z.looseObject({
1302
- plan_id: z.string().max(100).optional(),
1303
- plan_quantity: z.number().int().min(1).optional(),
1304
- plan_unit_price: z.number().int().min(0).optional(),
1305
- setup_fee: z.number().int().min(0).optional(),
1306
- replace_addon_list: z.boolean().default(false).optional(),
1307
- mandatory_addons_to_remove: z
1308
- .array(z.string().max(100).optional())
1309
- .optional(),
1310
- plan_quantity_in_decimal: z.string().max(33).optional(),
1311
- plan_unit_price_in_decimal: z.string().max(39).optional(),
1312
- invoice_date: z.number().int().optional(),
1313
- start_date: z.number().int().optional(),
1314
- trial_end: z.number().int().optional(),
1315
- billing_cycles: z.number().int().min(0).optional(),
1316
- coupon: z.string().max(100).optional(),
1317
- terms_to_charge: z.number().int().min(1).optional(),
1318
- reactivate_from: z.number().int().optional(),
1319
- billing_alignment_mode: z.enum(['immediate', 'delayed']).optional(),
1320
- auto_collection: z.enum(['on', 'off']).optional(),
1321
- offline_payment_method: z
1322
- .enum([
1323
- 'no_preference',
1324
- 'cash',
1325
- 'check',
1326
- 'bank_transfer',
1327
- 'ach_credit',
1328
- 'sepa_credit',
1329
- 'boleto',
1330
- 'us_automated_bank_transfer',
1331
- 'eu_automated_bank_transfer',
1332
- 'uk_automated_bank_transfer',
1333
- 'jp_automated_bank_transfer',
1334
- 'mx_automated_bank_transfer',
1335
- 'custom',
1336
- ])
1337
- .optional(),
1338
- po_number: z.string().max(100).optional(),
1339
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
1340
- replace_coupon_list: z.boolean().default(false).optional(),
1341
- prorate: z.boolean().optional(),
1342
- end_of_term: z.boolean().default(false).optional(),
1343
- force_term_reset: z.boolean().default(false).optional(),
1344
- reactivate: z.boolean().optional(),
1345
- token_id: z.string().max(40).optional(),
1346
- invoice_notes: z.string().max(2000).optional(),
1347
- meta_data: UpdateSubscriptionMetaDataSchema.optional(),
1348
- invoice_immediately: z.boolean().optional(),
1349
- override_relationship: z.boolean().optional(),
1350
- changes_scheduled_at: z.number().int().optional(),
1351
- change_option: z
1352
- .enum(['immediately', 'end_of_term', 'specific_date'])
1353
- .optional(),
1354
- contract_term_billing_cycle_on_renewal: z
1355
- .number()
1356
- .int()
1357
- .min(1)
1358
- .max(100)
1359
- .optional(),
1360
- free_period: z.number().int().min(1).optional(),
1361
- free_period_unit: z.enum(['day', 'week', 'month', 'year']).optional(),
1362
- trial_end_action: z
1363
- .enum([
1364
- 'site_default',
1365
- 'plan_default',
1366
- 'activate_subscription',
1367
- 'cancel_subscription',
1368
- ])
1369
- .optional(),
1370
- card: UpdateSubscriptionCardSchema.optional(),
1371
- payment_method: UpdateSubscriptionPaymentMethodSchema.optional(),
1372
- payment_intent: UpdateSubscriptionPaymentIntentSchema.optional(),
1373
- billing_address: UpdateSubscriptionBillingAddressSchema.optional(),
1374
- shipping_address: UpdateSubscriptionShippingAddressSchema.optional(),
1375
- statement_descriptor: UpdateSubscriptionStatementDescriptorSchema.optional(),
1376
- customer: UpdateSubscriptionCustomerSchema.optional(),
1377
- contract_term: UpdateSubscriptionContractTermSchema.optional(),
1378
- addons: UpdateSubscriptionAddonsSchema.optional(),
1379
- event_based_addons: UpdateSubscriptionEventBasedAddonsSchema.optional(),
1380
- coupons: UpdateSubscriptionCouponsSchema.optional(),
1381
- });
1382
- export { UpdateSubscriptionBodySchema };
1383
- //Subscription.updateForItems
1384
- const UpdateForItemsSubscriptionMetaDataSchema = z.looseObject({});
1385
- const UpdateForItemsSubscriptionAdditionalInformationSchema = z.looseObject({});
1386
- const UpdateForItemsSubscriptionCardSchema = z.object({
1387
- gateway: z
1388
- .enum([
1389
- 'chargebee',
1390
- 'chargebee_payments',
1391
- 'adyen',
1392
- 'stripe',
1393
- 'wepay',
1394
- 'braintree',
1395
- 'authorize_net',
1396
- 'paypal_pro',
1397
- 'pin',
1398
- 'eway',
1399
- 'eway_rapid',
1400
- 'worldpay',
1401
- 'balanced_payments',
1402
- 'beanstream',
1403
- 'bluepay',
1404
- 'elavon',
1405
- 'first_data_global',
1406
- 'hdfc',
1407
- 'migs',
1408
- 'nmi',
1409
- 'ogone',
1410
- 'paymill',
1411
- 'paypal_payflow_pro',
1412
- 'sage_pay',
1413
- 'tco',
1414
- 'wirecard',
1415
- 'amazon_payments',
1416
- 'paypal_express_checkout',
1417
- 'orbital',
1418
- 'moneris_us',
1419
- 'moneris',
1420
- 'bluesnap',
1421
- 'cybersource',
1422
- 'vantiv',
1423
- 'checkout_com',
1424
- 'paypal',
1425
- 'ingenico_direct',
1426
- 'exact',
1427
- 'mollie',
1428
- 'quickbooks',
1429
- 'razorpay',
1430
- 'global_payments',
1431
- 'bank_of_america',
1432
- 'ecentric',
1433
- 'metrics_global',
1434
- 'windcave',
1435
- 'pay_com',
1436
- 'ebanx',
1437
- 'dlocal',
1438
- 'nuvei',
1439
- 'solidgate',
1440
- 'paystack',
1441
- 'jp_morgan',
1442
- 'deutsche_bank',
1443
- 'ezidebit',
1444
- 'twikey',
1445
- 'tempus',
1446
- 'moyasar',
1447
- 'payway',
1448
- ])
1449
- .optional(),
1450
- gateway_account_id: z.string().max(50).optional(),
1451
- tmp_token: z.string().max(300).optional(),
1452
- first_name: z.string().max(50).optional(),
1453
- last_name: z.string().max(50).optional(),
1454
- number: z.string().max(1500).optional(),
1455
- expiry_month: z.number().int().min(1).max(12).optional(),
1456
- expiry_year: z.number().int().optional(),
1457
- cvv: z.string().max(520).optional(),
1458
- preferred_scheme: z
1459
- .enum(['cartes_bancaires', 'mastercard', 'visa'])
1460
- .optional(),
1461
- billing_addr1: z.string().max(150).optional(),
1462
- billing_addr2: z.string().max(150).optional(),
1463
- billing_city: z.string().max(50).optional(),
1464
- billing_state_code: z.string().max(50).optional(),
1465
- billing_state: z.string().max(50).optional(),
1466
- billing_zip: z.string().max(20).optional(),
1467
- billing_country: z.string().max(50).optional(),
1468
- ip_address: z.string().max(50).optional(),
1469
- additional_information: UpdateForItemsSubscriptionAdditionalInformationSchema.optional(),
1470
- });
1471
- const UpdateForItemsSubscriptionPaymentMethodSchema = z.object({
1472
- type: z
1473
- .enum([
1474
- 'card',
1475
- 'paypal_express_checkout',
1476
- 'amazon_payments',
1477
- 'direct_debit',
1478
- 'generic',
1479
- 'alipay',
1480
- 'unionpay',
1481
- 'apple_pay',
1482
- 'wechat_pay',
1483
- 'ideal',
1484
- 'google_pay',
1485
- 'sofort',
1486
- 'bancontact',
1487
- 'giropay',
1488
- 'dotpay',
1489
- 'upi',
1490
- 'netbanking_emandates',
1491
- 'venmo',
1492
- 'pay_to',
1493
- 'faster_payments',
1494
- 'sepa_instant_transfer',
1495
- 'automated_bank_transfer',
1496
- 'klarna_pay_now',
1497
- 'online_banking_poland',
1498
- 'payconiq_by_bancontact',
1499
- 'electronic_payment_standard',
1500
- 'kbc_payment_button',
1501
- 'pay_by_bank',
1502
- 'trustly',
1503
- 'stablecoin',
1504
- 'kakao_pay',
1505
- 'naver_pay',
1506
- 'revolut_pay',
1507
- 'cash_app_pay',
1508
- 'pix',
1509
- 'twint',
1510
- 'go_pay',
1511
- 'grab_pay',
1512
- 'pay_co',
1513
- 'after_pay',
1514
- 'swish',
1515
- 'payme',
1516
- ])
1517
- .optional(),
1518
- gateway: z
1519
- .enum([
1520
- 'chargebee_payments',
1521
- 'adyen',
1522
- 'stripe',
1523
- 'wepay',
1524
- 'braintree',
1525
- 'authorize_net',
1526
- 'paypal_pro',
1527
- 'pin',
1528
- 'eway',
1529
- 'eway_rapid',
1530
- 'worldpay',
1531
- 'balanced_payments',
1532
- 'beanstream',
1533
- 'bluepay',
1534
- 'elavon',
1535
- 'first_data_global',
1536
- 'hdfc',
1537
- 'migs',
1538
- 'nmi',
1539
- 'ogone',
1540
- 'paymill',
1541
- 'paypal_payflow_pro',
1542
- 'sage_pay',
1543
- 'tco',
1544
- 'wirecard',
1545
- 'amazon_payments',
1546
- 'paypal_express_checkout',
1547
- 'gocardless',
1548
- 'orbital',
1549
- 'moneris_us',
1550
- 'moneris',
1551
- 'bluesnap',
1552
- 'cybersource',
1553
- 'vantiv',
1554
- 'checkout_com',
1555
- 'paypal',
1556
- 'ingenico_direct',
1557
- 'exact',
1558
- 'mollie',
1559
- 'quickbooks',
1560
- 'razorpay',
1561
- 'global_payments',
1562
- 'bank_of_america',
1563
- 'ecentric',
1564
- 'metrics_global',
1565
- 'windcave',
1566
- 'pay_com',
1567
- 'ebanx',
1568
- 'dlocal',
1569
- 'nuvei',
1570
- 'solidgate',
1571
- 'paystack',
1572
- 'jp_morgan',
1573
- 'deutsche_bank',
1574
- 'ezidebit',
1575
- 'twikey',
1576
- 'tempus',
1577
- 'moyasar',
1578
- 'payway',
1579
- ])
1580
- .optional(),
1581
- gateway_account_id: z.string().max(50).optional(),
1582
- reference_id: z.string().max(200).optional(),
1583
- tmp_token: z.string().max(65000).optional(),
1584
- issuing_country: z.string().max(50).optional(),
1585
- additional_information: UpdateForItemsSubscriptionAdditionalInformationSchema.optional(),
1586
- });
1587
- const UpdateForItemsSubscriptionPaymentIntentSchema = z.object({
1588
- id: z.string().max(150).optional(),
1589
- gateway_account_id: z.string().max(50).optional(),
1590
- gw_token: z.string().max(65000).optional(),
1591
- payment_method_type: z
1592
- .enum([
1593
- 'card',
1594
- 'ideal',
1595
- 'sofort',
1596
- 'bancontact',
1597
- 'google_pay',
1598
- 'dotpay',
1599
- 'giropay',
1600
- 'apple_pay',
1601
- 'upi',
1602
- 'netbanking_emandates',
1603
- 'paypal_express_checkout',
1604
- 'direct_debit',
1605
- 'boleto',
1606
- 'venmo',
1607
- 'amazon_payments',
1608
- 'pay_to',
1609
- 'faster_payments',
1610
- 'sepa_instant_transfer',
1611
- 'klarna_pay_now',
1612
- 'online_banking_poland',
1613
- 'payconiq_by_bancontact',
1614
- 'electronic_payment_standard',
1615
- 'kbc_payment_button',
1616
- 'pay_by_bank',
1617
- 'trustly',
1618
- 'stablecoin',
1619
- 'kakao_pay',
1620
- 'naver_pay',
1621
- 'revolut_pay',
1622
- 'cash_app_pay',
1623
- 'wechat_pay',
1624
- 'alipay',
1625
- 'pix',
1626
- 'twint',
1627
- 'go_pay',
1628
- 'grab_pay',
1629
- 'pay_co',
1630
- 'after_pay',
1631
- 'swish',
1632
- 'payme',
1633
- ])
1634
- .optional(),
1635
- reference_id: z.string().max(65000).optional(),
1636
- gw_payment_method_id: z.string().max(65000).optional(),
1637
- additional_information: UpdateForItemsSubscriptionAdditionalInformationSchema.optional(),
1638
- });
1639
- const UpdateForItemsSubscriptionBillingAddressSchema = z.object({
1640
- first_name: z.string().max(150).optional(),
1641
- last_name: z.string().max(150).optional(),
1642
- email: z.string().email().max(70).optional(),
1643
- company: z.string().max(250).optional(),
1644
- phone: z.string().max(50).optional(),
1645
- line1: z.string().max(150).optional(),
1646
- line2: z.string().max(150).optional(),
1647
- line3: z.string().max(150).optional(),
1648
- city: z.string().max(50).optional(),
1649
- state_code: z.string().max(50).optional(),
1650
- state: z.string().max(50).optional(),
1651
- zip: z.string().max(20).optional(),
1652
- country: z.string().max(50).optional(),
1653
- validation_status: z
1654
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
1655
- .optional(),
1656
- });
1657
- const UpdateForItemsSubscriptionShippingAddressSchema = z.object({
1658
- first_name: z.string().max(150).optional(),
1659
- last_name: z.string().max(150).optional(),
1660
- email: z.string().email().max(70).optional(),
1661
- company: z.string().max(250).optional(),
1662
- phone: z.string().max(50).optional(),
1663
- line1: z.string().max(150).optional(),
1664
- line2: z.string().max(150).optional(),
1665
- line3: z.string().max(150).optional(),
1666
- city: z.string().max(50).optional(),
1667
- state_code: z.string().max(50).optional(),
1668
- state: z.string().max(50).optional(),
1669
- zip: z.string().max(20).optional(),
1670
- country: z.string().max(50).optional(),
1671
- validation_status: z
1672
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
1673
- .optional(),
1674
- });
1675
- const UpdateForItemsSubscriptionStatementDescriptorSchema = z.object({
1676
- descriptor: z.string().max(65000).optional(),
1677
- });
1678
- const UpdateForItemsSubscriptionCustomerSchema = z.object({
1679
- vat_number: z.string().max(20).optional(),
1680
- vat_number_prefix: z.string().max(10).optional(),
1681
- entity_identifier_scheme: z.string().max(50).optional(),
1682
- is_einvoice_enabled: z.boolean().optional(),
1683
- einvoicing_method: z.enum(['automatic', 'manual', 'site_default']).optional(),
1684
- entity_identifier_standard: z.string().max(50).optional(),
1685
- business_customer_without_vat_number: z.boolean().optional(),
1686
- registered_for_gst: z.boolean().optional(),
1687
- });
1688
- const UpdateForItemsSubscriptionContractTermSchema = z.object({
1689
- action_at_term_end: z
1690
- .enum(['renew', 'evergreen', 'cancel', 'renew_once'])
1691
- .optional(),
1692
- cancellation_cutoff_period: z.number().int().optional(),
1693
- contract_start: z.number().int().optional(),
1694
- });
1695
- const UpdateForItemsSubscriptionBillingOverrideSchema = z.object({
1696
- max_excess_payment_usage: z.number().int().min(-1).optional(),
1697
- max_refundable_credits_usage: z.number().int().min(-1).optional(),
1698
- });
1699
- const UpdateForItemsSubscriptionSubscriptionItemsSchema = z.object({
1700
- item_price_id: z.array(z.string().max(100).optional()),
1701
- quantity: z.array(z.number().int().min(1).optional()).optional(),
1702
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
1703
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
1704
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
1705
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
1706
- trial_end: z.array(z.number().int().optional()).optional(),
1707
- service_period_days: z
1708
- .array(z.number().int().min(1).max(730).optional())
1709
- .optional(),
1710
- charge_on_event: z
1711
- .array(z
1712
- .enum([
1713
- 'subscription_creation',
1714
- 'subscription_trial_start',
1715
- 'plan_activation',
1716
- 'subscription_activation',
1717
- 'contract_termination',
1718
- ])
1719
- .optional())
1720
- .optional(),
1721
- charge_once: z.array(z.boolean().optional()).optional(),
1722
- charge_on_option: z
1723
- .array(z.enum(['immediately', 'on_event']).optional())
1724
- .optional(),
1725
- item_type: z.array(z.enum(['plan', 'addon', 'charge']).optional()).optional(),
1726
- proration_type: z
1727
- .array(z.enum(['full_term', 'partial_term', 'none']).optional())
1728
- .optional(),
1729
- usage_accumulation_reset_frequency: z
1730
- .array(z.enum(['never', 'subscription_billing_frequency']).optional())
1731
- .optional(),
1732
- });
1733
- const UpdateForItemsSubscriptionDiscountsSchema = z.object({
1734
- apply_on: z
1735
- .array(z.enum(['invoice_amount', 'specific_item_price']).optional())
1736
- .optional(),
1737
- duration_type: z.array(z.enum(['one_time', 'forever', 'limited_period']).optional()),
1738
- percentage: z.array(z.number().min(0.01).max(100).optional()).optional(),
1739
- amount: z.array(z.number().int().min(0).optional()).optional(),
1740
- period: z.array(z.number().int().min(1).optional()).optional(),
1741
- period_unit: z
1742
- .array(z.enum(['day', 'week', 'month', 'year']).optional())
1743
- .optional(),
1744
- included_in_mrr: z.array(z.boolean().optional()).optional(),
1745
- item_price_id: z.array(z.string().max(100).optional()).optional(),
1746
- quantity: z.array(z.number().int().min(1).optional()).optional(),
1747
- operation_type: z.array(z.enum(['add', 'remove']).optional()),
1748
- id: z.array(z.string().max(50).optional()).optional(),
1749
- });
1750
- const UpdateForItemsSubscriptionItemTiersSchema = z.object({
1751
- item_price_id: z.array(z.string().max(100).optional()).optional(),
1752
- starting_unit: z.array(z.number().int().min(1).optional()).optional(),
1753
- ending_unit: z.array(z.number().int().optional()).optional(),
1754
- price: z.array(z.number().int().min(0).optional()).optional(),
1755
- starting_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
1756
- ending_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
1757
- price_in_decimal: z.array(z.string().max(39).optional()).optional(),
1758
- pricing_type: z
1759
- .array(z.enum(['per_unit', 'flat_fee', 'package']).optional())
1760
- .optional(),
1761
- package_size: z.array(z.number().int().min(1).optional()).optional(),
1762
- });
1763
- const UpdateForItemsSubscriptionCouponsSchema = z.object({
1764
- coupon_id: z.array(z.string().max(100).optional()).optional(),
1765
- apply_till: z.array(z.number().int().optional()).optional(),
1766
- });
1767
- const UpdateForItemsSubscriptionBodySchema = z.looseObject({
1768
- mandatory_items_to_remove: z.array(z.string().max(100).optional()).optional(),
1769
- replace_items_list: z.boolean().default(false).optional(),
1770
- setup_fee: z.number().int().min(0).optional(),
1771
- net_term_days: z.number().int().optional(),
1772
- invoice_date: z.number().int().optional(),
1773
- start_date: z.number().int().optional(),
1774
- trial_end: z.number().int().optional(),
1775
- billing_cycles: z.number().int().min(0).optional(),
1776
- coupon: z.string().max(100).optional(),
1777
- terms_to_charge: z.number().int().min(1).optional(),
1778
- reactivate_from: z.number().int().optional(),
1779
- billing_alignment_mode: z.enum(['immediate', 'delayed']).optional(),
1780
- auto_collection: z.enum(['on', 'off']).optional(),
1781
- offline_payment_method: z
1782
- .enum([
1783
- 'no_preference',
1784
- 'cash',
1785
- 'check',
1786
- 'bank_transfer',
1787
- 'ach_credit',
1788
- 'sepa_credit',
1789
- 'boleto',
1790
- 'us_automated_bank_transfer',
1791
- 'eu_automated_bank_transfer',
1792
- 'uk_automated_bank_transfer',
1793
- 'jp_automated_bank_transfer',
1794
- 'mx_automated_bank_transfer',
1795
- 'custom',
1796
- ])
1797
- .optional(),
1798
- po_number: z.string().max(100).optional(),
1799
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
1800
- replace_coupon_list: z.boolean().default(false).optional(),
1801
- prorate: z.boolean().optional(),
1802
- end_of_term: z.boolean().default(false).optional(),
1803
- force_term_reset: z.boolean().default(false).optional(),
1804
- reactivate: z.boolean().optional(),
1805
- token_id: z.string().max(40).optional(),
1806
- invoice_notes: z.string().max(2000).optional(),
1807
- meta_data: UpdateForItemsSubscriptionMetaDataSchema.optional(),
1808
- invoice_immediately: z.boolean().optional(),
1809
- override_relationship: z.boolean().optional(),
1810
- changes_scheduled_at: z.number().int().optional(),
1811
- change_option: z
1812
- .enum(['immediately', 'end_of_term', 'specific_date'])
1813
- .optional(),
1814
- contract_term_billing_cycle_on_renewal: z
1815
- .number()
1816
- .int()
1817
- .min(1)
1818
- .max(100)
1819
- .optional(),
1820
- free_period: z.number().int().min(1).optional(),
1821
- free_period_unit: z.enum(['day', 'week', 'month', 'year']).optional(),
1822
- create_pending_invoices: z.boolean().optional(),
1823
- auto_close_invoices: z.boolean().optional(),
1824
- trial_end_action: z
1825
- .enum([
1826
- 'site_default',
1827
- 'plan_default',
1828
- 'activate_subscription',
1829
- 'cancel_subscription',
1830
- ])
1831
- .optional(),
1832
- payment_initiator: z.enum(['customer', 'merchant']).optional(),
1833
- invoice_usages: z.boolean().default(false).optional(),
1834
- card: UpdateForItemsSubscriptionCardSchema.optional(),
1835
- payment_method: UpdateForItemsSubscriptionPaymentMethodSchema.optional(),
1836
- payment_intent: UpdateForItemsSubscriptionPaymentIntentSchema.optional(),
1837
- billing_address: UpdateForItemsSubscriptionBillingAddressSchema.optional(),
1838
- shipping_address: UpdateForItemsSubscriptionShippingAddressSchema.optional(),
1839
- statement_descriptor: UpdateForItemsSubscriptionStatementDescriptorSchema.optional(),
1840
- customer: UpdateForItemsSubscriptionCustomerSchema.optional(),
1841
- contract_term: UpdateForItemsSubscriptionContractTermSchema.optional(),
1842
- billing_override: UpdateForItemsSubscriptionBillingOverrideSchema.optional(),
1843
- subscription_items: UpdateForItemsSubscriptionSubscriptionItemsSchema.optional(),
1844
- discounts: UpdateForItemsSubscriptionDiscountsSchema.optional(),
1845
- item_tiers: UpdateForItemsSubscriptionItemTiersSchema.optional(),
1846
- coupons: UpdateForItemsSubscriptionCouponsSchema.optional(),
1847
- });
1848
- export { UpdateForItemsSubscriptionBodySchema };
1849
- //Subscription.changeTermEnd
1850
- const ChangeTermEndSubscriptionBodySchema = z.looseObject({
1851
- term_ends_at: z.number().int(),
1852
- prorate: z.boolean().optional(),
1853
- invoice_immediately: z.boolean().optional(),
1854
- });
1855
- export { ChangeTermEndSubscriptionBodySchema };
1856
- //Subscription.reactivate
1857
- const ReactivateSubscriptionContractTermSchema = z.object({
1858
- action_at_term_end: z.enum(['renew', 'evergreen', 'cancel']).optional(),
1859
- cancellation_cutoff_period: z.number().int().optional(),
1860
- });
1861
- const ReactivateSubscriptionStatementDescriptorSchema = z.object({
1862
- descriptor: z.string().max(65000).optional(),
1863
- });
1864
- const ReactivateSubscriptionAdditionalInformationSchema = z.looseObject({});
1865
- const ReactivateSubscriptionPaymentIntentSchema = z.object({
1866
- id: z.string().max(150).optional(),
1867
- gateway_account_id: z.string().max(50).optional(),
1868
- gw_token: z.string().max(65000).optional(),
1869
- payment_method_type: z
1870
- .enum([
1871
- 'card',
1872
- 'ideal',
1873
- 'sofort',
1874
- 'bancontact',
1875
- 'google_pay',
1876
- 'dotpay',
1877
- 'giropay',
1878
- 'apple_pay',
1879
- 'upi',
1880
- 'netbanking_emandates',
1881
- 'paypal_express_checkout',
1882
- 'direct_debit',
1883
- 'boleto',
1884
- 'venmo',
1885
- 'amazon_payments',
1886
- 'pay_to',
1887
- 'faster_payments',
1888
- 'sepa_instant_transfer',
1889
- 'klarna_pay_now',
1890
- 'online_banking_poland',
1891
- 'payconiq_by_bancontact',
1892
- 'electronic_payment_standard',
1893
- 'kbc_payment_button',
1894
- 'pay_by_bank',
1895
- 'trustly',
1896
- 'stablecoin',
1897
- 'kakao_pay',
1898
- 'naver_pay',
1899
- 'revolut_pay',
1900
- 'cash_app_pay',
1901
- 'wechat_pay',
1902
- 'alipay',
1903
- 'pix',
1904
- 'twint',
1905
- 'go_pay',
1906
- 'grab_pay',
1907
- 'pay_co',
1908
- 'after_pay',
1909
- 'swish',
1910
- 'payme',
1911
- ])
1912
- .optional(),
1913
- reference_id: z.string().max(65000).optional(),
1914
- gw_payment_method_id: z.string().max(65000).optional(),
1915
- additional_information: ReactivateSubscriptionAdditionalInformationSchema.optional(),
1916
- });
1917
- const ReactivateSubscriptionBodySchema = z.looseObject({
1918
- trial_end: z.number().int().optional(),
1919
- billing_cycles: z.number().int().min(0).optional(),
1920
- trial_period_days: z.number().int().min(1).max(365).optional(),
1921
- reactivate_from: z.number().int().optional(),
1922
- invoice_immediately: z.boolean().optional(),
1923
- billing_alignment_mode: z.enum(['immediate', 'delayed']).optional(),
1924
- terms_to_charge: z.number().int().min(1).optional(),
1925
- invoice_date: z.number().int().optional(),
1926
- contract_term_billing_cycle_on_renewal: z
1927
- .number()
1928
- .int()
1929
- .min(1)
1930
- .max(100)
1931
- .optional(),
1932
- payment_initiator: z.enum(['customer', 'merchant']).optional(),
1933
- contract_term: ReactivateSubscriptionContractTermSchema.optional(),
1934
- statement_descriptor: ReactivateSubscriptionStatementDescriptorSchema.optional(),
1935
- payment_intent: ReactivateSubscriptionPaymentIntentSchema.optional(),
1936
- });
1937
- export { ReactivateSubscriptionBodySchema };
1938
- //Subscription.addChargeAtTermEnd
1939
- const AddChargeAtTermEndSubscriptionBodySchema = z.looseObject({
1940
- amount: z.number().int().min(1).optional(),
1941
- description: z.string().max(250),
1942
- amount_in_decimal: z.string().max(39).optional(),
1943
- avalara_sale_type: z
1944
- .enum(['wholesale', 'retail', 'consumed', 'vendor_use'])
1945
- .optional(),
1946
- avalara_transaction_type: z.number().int().optional(),
1947
- avalara_service_type: z.number().int().optional(),
1948
- date_from: z.number().int().optional(),
1949
- date_to: z.number().int().optional(),
1950
- });
1951
- export { AddChargeAtTermEndSubscriptionBodySchema };
1952
- //Subscription.chargeAddonAtTermEnd
1953
- const ChargeAddonAtTermEndSubscriptionBodySchema = z.looseObject({
1954
- addon_id: z.string().max(100),
1955
- addon_quantity: z.number().int().min(1).optional(),
1956
- addon_unit_price: z.number().int().min(0).optional(),
1957
- addon_quantity_in_decimal: z.string().max(33).optional(),
1958
- addon_unit_price_in_decimal: z.string().max(39).optional(),
1959
- date_from: z.number().int().optional(),
1960
- date_to: z.number().int().optional(),
1961
- });
1962
- export { ChargeAddonAtTermEndSubscriptionBodySchema };
1963
- //Subscription.chargeFutureRenewals
1964
- const ChargeFutureRenewalsSubscriptionFixedIntervalScheduleSchema = z.object({
1965
- number_of_occurrences: z.number().int().min(1).optional(),
1966
- days_before_renewal: z.number().int().min(1).optional(),
1967
- end_schedule_on: z
1968
- .enum(['after_number_of_intervals', 'specific_date', 'subscription_end'])
1969
- .optional(),
1970
- end_date: z.number().int().optional(),
1971
- });
1972
- const ChargeFutureRenewalsSubscriptionSpecificDatesScheduleSchema = z.object({
1973
- terms_to_charge: z.array(z.number().int().optional()).optional(),
1974
- date: z.array(z.number().int().optional()).optional(),
1975
- });
1976
- const ChargeFutureRenewalsSubscriptionBodySchema = z.looseObject({
1977
- terms_to_charge: z.number().int().min(1).optional(),
1978
- invoice_immediately: z.boolean().optional(),
1979
- schedule_type: z
1980
- .enum(['immediate', 'specific_dates', 'fixed_intervals'])
1981
- .optional(),
1982
- fixed_interval_schedule: ChargeFutureRenewalsSubscriptionFixedIntervalScheduleSchema.optional(),
1983
- specific_dates_schedule: ChargeFutureRenewalsSubscriptionSpecificDatesScheduleSchema.optional(),
1984
- });
1985
- export { ChargeFutureRenewalsSubscriptionBodySchema };
1986
- //Subscription.editAdvanceInvoiceSchedule
1987
- const EditAdvanceInvoiceScheduleSubscriptionFixedIntervalScheduleSchema = z.object({
1988
- number_of_occurrences: z.number().int().min(1).optional(),
1989
- days_before_renewal: z.number().int().min(1).optional(),
1990
- end_schedule_on: z
1991
- .enum(['after_number_of_intervals', 'specific_date', 'subscription_end'])
1992
- .optional(),
1993
- end_date: z.number().int().optional(),
1994
- });
1995
- const EditAdvanceInvoiceScheduleSubscriptionSpecificDatesScheduleSchema = z.object({
1996
- id: z.array(z.string().max(50).optional()).optional(),
1997
- terms_to_charge: z.array(z.number().int().optional()).optional(),
1998
- date: z.array(z.number().int().optional()).optional(),
1999
- });
2000
- const EditAdvanceInvoiceScheduleSubscriptionBodySchema = z.looseObject({
2001
- terms_to_charge: z.number().int().min(1).optional(),
2002
- schedule_type: z.enum(['specific_dates', 'fixed_intervals']).optional(),
2003
- fixed_interval_schedule: EditAdvanceInvoiceScheduleSubscriptionFixedIntervalScheduleSchema.optional(),
2004
- specific_dates_schedule: EditAdvanceInvoiceScheduleSubscriptionSpecificDatesScheduleSchema.optional(),
2005
- });
2006
- export { EditAdvanceInvoiceScheduleSubscriptionBodySchema };
2007
- //Subscription.removeAdvanceInvoiceSchedule
2008
- const RemoveAdvanceInvoiceScheduleSubscriptionSpecificDatesScheduleSchema = z.object({
2009
- id: z.array(z.string().max(50).optional()).optional(),
2010
- });
2011
- const RemoveAdvanceInvoiceScheduleSubscriptionBodySchema = z.looseObject({
2012
- specific_dates_schedule: RemoveAdvanceInvoiceScheduleSubscriptionSpecificDatesScheduleSchema.optional(),
2013
- });
2014
- export { RemoveAdvanceInvoiceScheduleSubscriptionBodySchema };
2015
- //Subscription.regenerateInvoice
2016
- const RegenerateInvoiceSubscriptionBodySchema = z.looseObject({
2017
- date_from: z.number().int().optional(),
2018
- date_to: z.number().int().optional(),
2019
- prorate: z.boolean().optional(),
2020
- invoice_immediately: z.boolean().optional(),
2021
- });
2022
- export { RegenerateInvoiceSubscriptionBodySchema };
2023
- //Subscription.importSubscription
2024
- const ImportSubscriptionSubscriptionMetaDataSchema = z.looseObject({});
2025
- const ImportSubscriptionSubscriptionCustomerSchema = z.looseObject({
2026
- id: z.string().max(50).optional(),
2027
- email: z.string().email().max(70).optional(),
2028
- first_name: z.string().max(150).optional(),
2029
- last_name: z.string().max(150).optional(),
2030
- company: z.string().max(250).optional(),
2031
- phone: z.string().max(50).optional(),
2032
- locale: z.string().max(50).optional(),
2033
- taxability: z.enum(['taxable', 'exempt']).optional(),
2034
- entity_code: z
2035
- .enum([
2036
- 'a',
2037
- 'b',
2038
- 'c',
2039
- 'd',
2040
- 'e',
2041
- 'f',
2042
- 'g',
2043
- 'h',
2044
- 'i',
2045
- 'j',
2046
- 'k',
2047
- 'l',
2048
- 'm',
2049
- 'n',
2050
- 'p',
2051
- 'q',
2052
- 'r',
2053
- 'med1',
2054
- 'med2',
2055
- ])
2056
- .optional(),
2057
- exempt_number: z.string().max(100).optional(),
2058
- net_term_days: z.number().int().optional(),
2059
- taxjar_exemption_category: z
2060
- .enum(['wholesale', 'government', 'other'])
2061
- .optional(),
2062
- customer_type: z
2063
- .enum(['residential', 'business', 'senior_citizen', 'industrial'])
2064
- .optional(),
2065
- auto_collection: z.enum(['on', 'off']).optional(),
2066
- allow_direct_debit: z.boolean().default(false).optional(),
2067
- vat_number: z.string().max(20).optional(),
2068
- vat_number_prefix: z.string().max(10).optional(),
2069
- });
2070
- const ImportSubscriptionSubscriptionContractTermSchema = z.object({
2071
- id: z.string().max(50).optional(),
2072
- created_at: z.number().int().optional(),
2073
- contract_start: z.number().int().optional(),
2074
- billing_cycle: z.number().int().min(0).optional(),
2075
- total_amount_raised: z.number().int().min(0).optional(),
2076
- total_amount_raised_before_tax: z.number().int().min(0).optional(),
2077
- action_at_term_end: z
2078
- .enum(['renew', 'evergreen', 'cancel', 'renew_once'])
2079
- .optional(),
2080
- cancellation_cutoff_period: z.number().int().optional(),
2081
- });
2082
- const ImportSubscriptionSubscriptionAdditionalInformationSchema = z.looseObject({});
2083
- const ImportSubscriptionSubscriptionCardSchema = z.object({
2084
- gateway: z
2085
- .enum([
2086
- 'chargebee',
2087
- 'chargebee_payments',
2088
- 'adyen',
2089
- 'stripe',
2090
- 'wepay',
2091
- 'braintree',
2092
- 'authorize_net',
2093
- 'paypal_pro',
2094
- 'pin',
2095
- 'eway',
2096
- 'eway_rapid',
2097
- 'worldpay',
2098
- 'balanced_payments',
2099
- 'beanstream',
2100
- 'bluepay',
2101
- 'elavon',
2102
- 'first_data_global',
2103
- 'hdfc',
2104
- 'migs',
2105
- 'nmi',
2106
- 'ogone',
2107
- 'paymill',
2108
- 'paypal_payflow_pro',
2109
- 'sage_pay',
2110
- 'tco',
2111
- 'wirecard',
2112
- 'amazon_payments',
2113
- 'paypal_express_checkout',
2114
- 'orbital',
2115
- 'moneris_us',
2116
- 'moneris',
2117
- 'bluesnap',
2118
- 'cybersource',
2119
- 'vantiv',
2120
- 'checkout_com',
2121
- 'paypal',
2122
- 'ingenico_direct',
2123
- 'exact',
2124
- 'mollie',
2125
- 'quickbooks',
2126
- 'razorpay',
2127
- 'global_payments',
2128
- 'bank_of_america',
2129
- 'ecentric',
2130
- 'metrics_global',
2131
- 'windcave',
2132
- 'pay_com',
2133
- 'ebanx',
2134
- 'dlocal',
2135
- 'nuvei',
2136
- 'solidgate',
2137
- 'paystack',
2138
- 'jp_morgan',
2139
- 'deutsche_bank',
2140
- 'ezidebit',
2141
- 'twikey',
2142
- 'tempus',
2143
- 'moyasar',
2144
- 'payway',
2145
- ])
2146
- .optional(),
2147
- gateway_account_id: z.string().max(50).optional(),
2148
- tmp_token: z.string().max(300).optional(),
2149
- first_name: z.string().max(50).optional(),
2150
- last_name: z.string().max(50).optional(),
2151
- number: z.string().max(1500).optional(),
2152
- expiry_month: z.number().int().min(1).max(12).optional(),
2153
- expiry_year: z.number().int().optional(),
2154
- cvv: z.string().max(520).optional(),
2155
- preferred_scheme: z
2156
- .enum(['cartes_bancaires', 'mastercard', 'visa'])
2157
- .optional(),
2158
- billing_addr1: z.string().max(150).optional(),
2159
- billing_addr2: z.string().max(150).optional(),
2160
- billing_city: z.string().max(50).optional(),
2161
- billing_state_code: z.string().max(50).optional(),
2162
- billing_state: z.string().max(50).optional(),
2163
- billing_zip: z.string().max(20).optional(),
2164
- billing_country: z.string().max(50).optional(),
2165
- additional_information: ImportSubscriptionSubscriptionAdditionalInformationSchema.optional(),
2166
- });
2167
- const ImportSubscriptionSubscriptionPaymentMethodSchema = z.object({
2168
- type: z
2169
- .enum([
2170
- 'card',
2171
- 'paypal_express_checkout',
2172
- 'amazon_payments',
2173
- 'direct_debit',
2174
- 'generic',
2175
- 'alipay',
2176
- 'unionpay',
2177
- 'apple_pay',
2178
- 'wechat_pay',
2179
- 'ideal',
2180
- 'google_pay',
2181
- 'sofort',
2182
- 'bancontact',
2183
- 'giropay',
2184
- 'dotpay',
2185
- 'upi',
2186
- 'netbanking_emandates',
2187
- 'venmo',
2188
- 'pay_to',
2189
- 'faster_payments',
2190
- 'sepa_instant_transfer',
2191
- 'automated_bank_transfer',
2192
- 'klarna_pay_now',
2193
- 'online_banking_poland',
2194
- 'payconiq_by_bancontact',
2195
- 'electronic_payment_standard',
2196
- 'kbc_payment_button',
2197
- 'pay_by_bank',
2198
- 'trustly',
2199
- 'stablecoin',
2200
- 'kakao_pay',
2201
- 'naver_pay',
2202
- 'revolut_pay',
2203
- 'cash_app_pay',
2204
- 'pix',
2205
- 'twint',
2206
- 'go_pay',
2207
- 'grab_pay',
2208
- 'pay_co',
2209
- 'after_pay',
2210
- 'swish',
2211
- 'payme',
2212
- ])
2213
- .optional(),
2214
- gateway: z
2215
- .enum([
2216
- 'chargebee_payments',
2217
- 'adyen',
2218
- 'stripe',
2219
- 'wepay',
2220
- 'braintree',
2221
- 'authorize_net',
2222
- 'paypal_pro',
2223
- 'pin',
2224
- 'eway',
2225
- 'eway_rapid',
2226
- 'worldpay',
2227
- 'balanced_payments',
2228
- 'beanstream',
2229
- 'bluepay',
2230
- 'elavon',
2231
- 'first_data_global',
2232
- 'hdfc',
2233
- 'migs',
2234
- 'nmi',
2235
- 'ogone',
2236
- 'paymill',
2237
- 'paypal_payflow_pro',
2238
- 'sage_pay',
2239
- 'tco',
2240
- 'wirecard',
2241
- 'amazon_payments',
2242
- 'paypal_express_checkout',
2243
- 'gocardless',
2244
- 'orbital',
2245
- 'moneris_us',
2246
- 'moneris',
2247
- 'bluesnap',
2248
- 'cybersource',
2249
- 'vantiv',
2250
- 'checkout_com',
2251
- 'paypal',
2252
- 'ingenico_direct',
2253
- 'exact',
2254
- 'mollie',
2255
- 'quickbooks',
2256
- 'razorpay',
2257
- 'global_payments',
2258
- 'bank_of_america',
2259
- 'ecentric',
2260
- 'metrics_global',
2261
- 'windcave',
2262
- 'pay_com',
2263
- 'ebanx',
2264
- 'dlocal',
2265
- 'nuvei',
2266
- 'solidgate',
2267
- 'paystack',
2268
- 'jp_morgan',
2269
- 'deutsche_bank',
2270
- 'ezidebit',
2271
- 'twikey',
2272
- 'tempus',
2273
- 'moyasar',
2274
- 'payway',
2275
- ])
2276
- .optional(),
2277
- gateway_account_id: z.string().max(50).optional(),
2278
- reference_id: z.string().max(200).optional(),
2279
- issuing_country: z.string().max(50).optional(),
2280
- additional_information: ImportSubscriptionSubscriptionAdditionalInformationSchema.optional(),
2281
- });
2282
- const ImportSubscriptionSubscriptionBillingAddressSchema = z.object({
2283
- first_name: z.string().max(150).optional(),
2284
- last_name: z.string().max(150).optional(),
2285
- email: z.string().email().max(70).optional(),
2286
- company: z.string().max(250).optional(),
2287
- phone: z.string().max(50).optional(),
2288
- line1: z.string().max(150).optional(),
2289
- line2: z.string().max(150).optional(),
2290
- line3: z.string().max(150).optional(),
2291
- city: z.string().max(50).optional(),
2292
- state_code: z.string().max(50).optional(),
2293
- state: z.string().max(50).optional(),
2294
- zip: z.string().max(20).optional(),
2295
- country: z.string().max(50).optional(),
2296
- validation_status: z
2297
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
2298
- .optional(),
2299
- });
2300
- const ImportSubscriptionSubscriptionShippingAddressSchema = z.object({
2301
- first_name: z.string().max(150).optional(),
2302
- last_name: z.string().max(150).optional(),
2303
- email: z.string().email().max(70).optional(),
2304
- company: z.string().max(250).optional(),
2305
- phone: z.string().max(50).optional(),
2306
- line1: z.string().max(150).optional(),
2307
- line2: z.string().max(150).optional(),
2308
- line3: z.string().max(150).optional(),
2309
- city: z.string().max(50).optional(),
2310
- state_code: z.string().max(50).optional(),
2311
- state: z.string().max(50).optional(),
2312
- zip: z.string().max(20).optional(),
2313
- country: z.string().max(50).optional(),
2314
- validation_status: z
2315
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
2316
- .optional(),
2317
- });
2318
- const ImportSubscriptionSubscriptionTransactionSchema = z.object({
2319
- amount: z.number().int().min(0).optional(),
2320
- payment_method: z
2321
- .enum([
2322
- 'cash',
2323
- 'check',
2324
- 'bank_transfer',
2325
- 'other',
2326
- 'app_store',
2327
- 'play_store',
2328
- 'custom',
2329
- ])
2330
- .optional(),
2331
- reference_number: z.string().max(100).optional(),
2332
- date: z.number().int().optional(),
2333
- });
2334
- const ImportSubscriptionSubscriptionAddonsSchema = z.object({
2335
- id: z.array(z.string().max(100).optional()).optional(),
2336
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2337
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
2338
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
2339
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
2340
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
2341
- });
2342
- const ImportSubscriptionSubscriptionEventBasedAddonsSchema = z.object({
2343
- id: z.array(z.string().max(100).optional()).optional(),
2344
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2345
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
2346
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
2347
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
2348
- service_period_in_days: z
2349
- .array(z.number().int().min(1).max(4000).optional())
2350
- .optional(),
2351
- on_event: z
2352
- .array(z
2353
- .enum([
2354
- 'subscription_creation',
2355
- 'subscription_trial_start',
2356
- 'plan_activation',
2357
- 'subscription_activation',
2358
- 'contract_termination',
2359
- ])
2360
- .optional())
2361
- .optional(),
2362
- charge_once: z.array(z.boolean().default(true).optional()).optional(),
2363
- });
2364
- const ImportSubscriptionSubscriptionChargedEventBasedAddonsSchema = z.object({
2365
- id: z.array(z.string().max(100).optional()).optional(),
2366
- last_charged_at: z.array(z.number().int().optional()).optional(),
2367
- });
2368
- const ImportSubscriptionSubscriptionCouponsSchema = z.object({
2369
- coupon_id: z.array(z.string().max(100).optional()).optional(),
2370
- apply_till: z.array(z.number().int().optional()).optional(),
2371
- });
2372
- const ImportSubscriptionSubscriptionBodySchema = z.looseObject({
2373
- id: z.string().max(50).optional(),
2374
- client_profile_id: z.string().max(50).optional(),
2375
- plan_id: z.string().max(100),
2376
- plan_quantity: z.number().int().min(1).optional(),
2377
- plan_quantity_in_decimal: z.string().max(33).optional(),
2378
- plan_unit_price: z.number().int().min(0).optional(),
2379
- plan_unit_price_in_decimal: z.string().max(39).optional(),
2380
- setup_fee: z.number().int().min(0).optional(),
2381
- trial_end: z.number().int().optional(),
2382
- billing_cycles: z.number().int().min(0).optional(),
2383
- start_date: z.number().int().optional(),
2384
- auto_collection: z.enum(['on', 'off']).optional(),
2385
- po_number: z.string().max(100).optional(),
2386
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
2387
- contract_term_billing_cycle_on_renewal: z
2388
- .number()
2389
- .int()
2390
- .min(1)
2391
- .max(100)
2392
- .optional(),
2393
- status: z.enum([
2394
- 'future',
2395
- 'in_trial',
2396
- 'active',
2397
- 'non_renewing',
2398
- 'paused',
2399
- 'cancelled',
2400
- 'transferred',
2401
- ]),
2402
- current_term_end: z.number().int().optional(),
2403
- current_term_start: z.number().int().optional(),
2404
- trial_start: z.number().int().optional(),
2405
- cancelled_at: z.number().int().optional(),
2406
- started_at: z.number().int().optional(),
2407
- activated_at: z.number().int().optional(),
2408
- pause_date: z.number().int().optional(),
2409
- resume_date: z.number().int().optional(),
2410
- create_current_term_invoice: z.boolean().default(false).optional(),
2411
- affiliate_token: z.string().max(250).optional(),
2412
- invoice_notes: z.string().max(2000).optional(),
2413
- meta_data: ImportSubscriptionSubscriptionMetaDataSchema.optional(),
2414
- customer: ImportSubscriptionSubscriptionCustomerSchema.optional(),
2415
- contract_term: ImportSubscriptionSubscriptionContractTermSchema.optional(),
2416
- card: ImportSubscriptionSubscriptionCardSchema.optional(),
2417
- payment_method: ImportSubscriptionSubscriptionPaymentMethodSchema.optional(),
2418
- billing_address: ImportSubscriptionSubscriptionBillingAddressSchema.optional(),
2419
- shipping_address: ImportSubscriptionSubscriptionShippingAddressSchema.optional(),
2420
- transaction: ImportSubscriptionSubscriptionTransactionSchema.optional(),
2421
- addons: ImportSubscriptionSubscriptionAddonsSchema.optional(),
2422
- event_based_addons: ImportSubscriptionSubscriptionEventBasedAddonsSchema.optional(),
2423
- charged_event_based_addons: ImportSubscriptionSubscriptionChargedEventBasedAddonsSchema.optional(),
2424
- coupons: ImportSubscriptionSubscriptionCouponsSchema.optional(),
2425
- });
2426
- export { ImportSubscriptionSubscriptionBodySchema };
2427
- //Subscription.importForCustomer
2428
- const ImportForCustomerSubscriptionMetaDataSchema = z.looseObject({});
2429
- const ImportForCustomerSubscriptionContractTermSchema = z.object({
2430
- id: z.string().max(50).optional(),
2431
- created_at: z.number().int().optional(),
2432
- contract_start: z.number().int().optional(),
2433
- billing_cycle: z.number().int().min(0).optional(),
2434
- total_amount_raised: z.number().int().min(0).optional(),
2435
- total_amount_raised_before_tax: z.number().int().min(0).optional(),
2436
- action_at_term_end: z
2437
- .enum(['renew', 'evergreen', 'cancel', 'renew_once'])
2438
- .optional(),
2439
- cancellation_cutoff_period: z.number().int().optional(),
2440
- });
2441
- const ImportForCustomerSubscriptionTransactionSchema = z.object({
2442
- amount: z.number().int().min(0).optional(),
2443
- payment_method: z
2444
- .enum([
2445
- 'cash',
2446
- 'check',
2447
- 'bank_transfer',
2448
- 'other',
2449
- 'app_store',
2450
- 'play_store',
2451
- 'custom',
2452
- ])
2453
- .optional(),
2454
- reference_number: z.string().max(100).optional(),
2455
- date: z.number().int().optional(),
2456
- });
2457
- const ImportForCustomerSubscriptionShippingAddressSchema = z.object({
2458
- first_name: z.string().max(150).optional(),
2459
- last_name: z.string().max(150).optional(),
2460
- email: z.string().email().max(70).optional(),
2461
- company: z.string().max(250).optional(),
2462
- phone: z.string().max(50).optional(),
2463
- line1: z.string().max(150).optional(),
2464
- line2: z.string().max(150).optional(),
2465
- line3: z.string().max(150).optional(),
2466
- city: z.string().max(50).optional(),
2467
- state_code: z.string().max(50).optional(),
2468
- state: z.string().max(50).optional(),
2469
- zip: z.string().max(20).optional(),
2470
- country: z.string().max(50).optional(),
2471
- validation_status: z
2472
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
2473
- .optional(),
2474
- });
2475
- const ImportForCustomerSubscriptionAddonsSchema = z.object({
2476
- id: z.array(z.string().max(100).optional()).optional(),
2477
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2478
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
2479
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
2480
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
2481
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
2482
- });
2483
- const ImportForCustomerSubscriptionEventBasedAddonsSchema = z.object({
2484
- id: z.array(z.string().max(100).optional()).optional(),
2485
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2486
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
2487
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
2488
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
2489
- service_period_in_days: z
2490
- .array(z.number().int().min(1).max(4000).optional())
2491
- .optional(),
2492
- on_event: z
2493
- .array(z
2494
- .enum([
2495
- 'subscription_creation',
2496
- 'subscription_trial_start',
2497
- 'plan_activation',
2498
- 'subscription_activation',
2499
- 'contract_termination',
2500
- ])
2501
- .optional())
2502
- .optional(),
2503
- charge_once: z.array(z.boolean().default(true).optional()).optional(),
2504
- });
2505
- const ImportForCustomerSubscriptionChargedEventBasedAddonsSchema = z.object({
2506
- id: z.array(z.string().max(100).optional()).optional(),
2507
- last_charged_at: z.array(z.number().int().optional()).optional(),
2508
- });
2509
- const ImportForCustomerSubscriptionCouponsSchema = z.object({
2510
- coupon_id: z.array(z.string().max(100).optional()).optional(),
2511
- apply_till: z.array(z.number().int().optional()).optional(),
2512
- });
2513
- const ImportForCustomerSubscriptionBodySchema = z.looseObject({
2514
- id: z.string().max(50).optional(),
2515
- plan_id: z.string().max(100),
2516
- plan_quantity: z.number().int().min(1).optional(),
2517
- plan_quantity_in_decimal: z.string().max(33).optional(),
2518
- plan_unit_price: z.number().int().min(0).optional(),
2519
- plan_unit_price_in_decimal: z.string().max(39).optional(),
2520
- setup_fee: z.number().int().min(0).optional(),
2521
- trial_end: z.number().int().optional(),
2522
- billing_cycles: z.number().int().min(0).optional(),
2523
- start_date: z.number().int().optional(),
2524
- auto_collection: z.enum(['on', 'off']).optional(),
2525
- po_number: z.string().max(100).optional(),
2526
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
2527
- payment_source_id: z.string().max(40).optional(),
2528
- status: z.enum([
2529
- 'future',
2530
- 'in_trial',
2531
- 'active',
2532
- 'non_renewing',
2533
- 'paused',
2534
- 'cancelled',
2535
- 'transferred',
2536
- ]),
2537
- current_term_end: z.number().int().optional(),
2538
- current_term_start: z.number().int().optional(),
2539
- trial_start: z.number().int().optional(),
2540
- cancelled_at: z.number().int().optional(),
2541
- started_at: z.number().int().optional(),
2542
- activated_at: z.number().int().optional(),
2543
- pause_date: z.number().int().optional(),
2544
- resume_date: z.number().int().optional(),
2545
- contract_term_billing_cycle_on_renewal: z
2546
- .number()
2547
- .int()
2548
- .min(1)
2549
- .max(100)
2550
- .optional(),
2551
- create_current_term_invoice: z.boolean().default(false).optional(),
2552
- invoice_notes: z.string().max(2000).optional(),
2553
- meta_data: ImportForCustomerSubscriptionMetaDataSchema.optional(),
2554
- contract_term: ImportForCustomerSubscriptionContractTermSchema.optional(),
2555
- transaction: ImportForCustomerSubscriptionTransactionSchema.optional(),
2556
- shipping_address: ImportForCustomerSubscriptionShippingAddressSchema.optional(),
2557
- addons: ImportForCustomerSubscriptionAddonsSchema.optional(),
2558
- event_based_addons: ImportForCustomerSubscriptionEventBasedAddonsSchema.optional(),
2559
- charged_event_based_addons: ImportForCustomerSubscriptionChargedEventBasedAddonsSchema.optional(),
2560
- coupons: ImportForCustomerSubscriptionCouponsSchema.optional(),
2561
- });
2562
- export { ImportForCustomerSubscriptionBodySchema };
2563
- //Subscription.importContractTerm
2564
- const ImportContractTermSubscriptionContractTermSchema = z.object({
2565
- id: z.string().max(50).optional(),
2566
- created_at: z.number().int().optional(),
2567
- contract_start: z.number().int().optional(),
2568
- contract_end: z.number().int().optional(),
2569
- status: z.enum(['active', 'completed', 'cancelled', 'terminated']).optional(),
2570
- total_amount_raised: z.number().int().min(0).optional(),
2571
- total_amount_raised_before_tax: z.number().int().min(0).optional(),
2572
- total_contract_value: z.number().int().min(0).optional(),
2573
- total_contract_value_before_tax: z.number().int().min(0).optional(),
2574
- billing_cycle: z.number().int().min(0).optional(),
2575
- action_at_term_end: z
2576
- .enum(['renew', 'evergreen', 'cancel', 'renew_once'])
2577
- .optional(),
2578
- cancellation_cutoff_period: z.number().int().optional(),
2579
- });
2580
- const ImportContractTermSubscriptionBodySchema = z.looseObject({
2581
- contract_term_billing_cycle_on_renewal: z
2582
- .number()
2583
- .int()
2584
- .min(1)
2585
- .max(100)
2586
- .optional(),
2587
- contract_term: ImportContractTermSubscriptionContractTermSchema.optional(),
2588
- });
2589
- export { ImportContractTermSubscriptionBodySchema };
2590
- //Subscription.importUnbilledCharges
2591
- const ImportUnbilledChargesSubscriptionUnbilledChargesSchema = z.object({
2592
- id: z.array(z.string().max(40).optional()).optional(),
2593
- date_from: z.array(z.number().int().optional()),
2594
- date_to: z.array(z.number().int().optional()),
2595
- entity_type: z.array(z
2596
- .enum([
2597
- 'adhoc',
2598
- 'plan_item_price',
2599
- 'addon_item_price',
2600
- 'charge_item_price',
2601
- 'plan_setup',
2602
- 'plan',
2603
- 'addon',
2604
- ])
2605
- .optional()),
2606
- entity_id: z.array(z.string().max(100).optional()).optional(),
2607
- description: z.array(z.string().max(250).optional()).optional(),
2608
- unit_amount: z.array(z.number().int().min(0).optional()).optional(),
2609
- quantity: z.array(z.number().int().min(0).optional()).optional(),
2610
- amount: z.array(z.number().int().min(0).optional()).optional(),
2611
- unit_amount_in_decimal: z.array(z.string().max(39).optional()).optional(),
2612
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
2613
- amount_in_decimal: z.array(z.string().max(39).optional()).optional(),
2614
- discount_amount: z.array(z.number().int().min(0).optional()).optional(),
2615
- use_for_proration: z.array(z.boolean().default(false).optional()).optional(),
2616
- is_advance_charge: z.array(z.boolean().default(false).optional()).optional(),
2617
- });
2618
- const ImportUnbilledChargesSubscriptionDiscountsSchema = z.object({
2619
- unbilled_charge_id: z.array(z.string().max(40).optional()).optional(),
2620
- entity_type: z
2621
- .array(z
2622
- .enum([
2623
- 'item_level_coupon',
2624
- 'document_level_coupon',
2625
- 'item_level_discount',
2626
- 'document_level_discount',
2627
- ])
2628
- .optional())
2629
- .optional(),
2630
- entity_id: z.array(z.string().max(100).optional()).optional(),
2631
- description: z.array(z.string().max(250).optional()).optional(),
2632
- amount: z.array(z.number().int().min(0).optional()),
2633
- });
2634
- const ImportUnbilledChargesSubscriptionTiersSchema = z.object({
2635
- unbilled_charge_id: z.array(z.string().max(40).optional()),
2636
- starting_unit: z.array(z.number().int().min(0).optional()).optional(),
2637
- ending_unit: z.array(z.number().int().optional()).optional(),
2638
- quantity_used: z.array(z.number().int().min(0).optional()).optional(),
2639
- unit_amount: z.array(z.number().int().min(0).optional()).optional(),
2640
- starting_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
2641
- ending_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
2642
- quantity_used_in_decimal: z.array(z.string().max(33).optional()).optional(),
2643
- unit_amount_in_decimal: z.array(z.string().max(40).optional()).optional(),
2644
- });
2645
- const ImportUnbilledChargesSubscriptionBodySchema = z.looseObject({
2646
- unbilled_charges: ImportUnbilledChargesSubscriptionUnbilledChargesSchema.optional(),
2647
- discounts: ImportUnbilledChargesSubscriptionDiscountsSchema.optional(),
2648
- tiers: ImportUnbilledChargesSubscriptionTiersSchema.optional(),
2649
- });
2650
- export { ImportUnbilledChargesSubscriptionBodySchema };
2651
- //Subscription.importForItems
2652
- const ImportForItemsSubscriptionMetaDataSchema = z.looseObject({});
2653
- const ImportForItemsSubscriptionContractTermSchema = z.object({
2654
- id: z.string().max(50).optional(),
2655
- created_at: z.number().int().optional(),
2656
- contract_start: z.number().int().optional(),
2657
- billing_cycle: z.number().int().min(0).optional(),
2658
- total_amount_raised: z.number().int().min(0).optional(),
2659
- total_amount_raised_before_tax: z.number().int().min(0).optional(),
2660
- action_at_term_end: z
2661
- .enum(['renew', 'evergreen', 'cancel', 'renew_once'])
2662
- .optional(),
2663
- cancellation_cutoff_period: z.number().int().optional(),
2664
- });
2665
- const ImportForItemsSubscriptionTransactionSchema = z.object({
2666
- amount: z.number().int().min(0).optional(),
2667
- payment_method: z
2668
- .enum([
2669
- 'cash',
2670
- 'check',
2671
- 'bank_transfer',
2672
- 'other',
2673
- 'app_store',
2674
- 'play_store',
2675
- 'custom',
2676
- ])
2677
- .optional(),
2678
- reference_number: z.string().max(100).optional(),
2679
- date: z.number().int().optional(),
2680
- });
2681
- const ImportForItemsSubscriptionShippingAddressSchema = z.object({
2682
- first_name: z.string().max(150).optional(),
2683
- last_name: z.string().max(150).optional(),
2684
- email: z.string().email().max(70).optional(),
2685
- company: z.string().max(250).optional(),
2686
- phone: z.string().max(50).optional(),
2687
- line1: z.string().max(150).optional(),
2688
- line2: z.string().max(150).optional(),
2689
- line3: z.string().max(150).optional(),
2690
- city: z.string().max(50).optional(),
2691
- state_code: z.string().max(50).optional(),
2692
- state: z.string().max(50).optional(),
2693
- zip: z.string().max(20).optional(),
2694
- country: z.string().max(50).optional(),
2695
- validation_status: z
2696
- .enum(['not_validated', 'valid', 'partially_valid', 'invalid'])
2697
- .optional(),
2698
- });
2699
- const ImportForItemsSubscriptionSubscriptionItemsSchema = z.object({
2700
- item_price_id: z.array(z.string().max(100).optional()),
2701
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2702
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
2703
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
2704
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
2705
- billing_cycles: z.array(z.number().int().min(0).optional()).optional(),
2706
- trial_end: z.array(z.number().int().optional()).optional(),
2707
- service_period_days: z
2708
- .array(z.number().int().min(1).max(730).optional())
2709
- .optional(),
2710
- charge_on_event: z
2711
- .array(z
2712
- .enum([
2713
- 'subscription_creation',
2714
- 'subscription_trial_start',
2715
- 'plan_activation',
2716
- 'subscription_activation',
2717
- 'contract_termination',
2718
- ])
2719
- .optional())
2720
- .optional(),
2721
- charge_once: z.array(z.boolean().optional()).optional(),
2722
- item_type: z.array(z.enum(['plan', 'addon', 'charge']).optional()).optional(),
2723
- });
2724
- const ImportForItemsSubscriptionDiscountsSchema = z.object({
2725
- apply_on: z
2726
- .array(z.enum(['invoice_amount', 'specific_item_price']).optional())
2727
- .optional(),
2728
- duration_type: z.array(z.enum(['one_time', 'forever', 'limited_period']).optional()),
2729
- percentage: z.array(z.number().min(0.01).max(100).optional()).optional(),
2730
- amount: z.array(z.number().int().min(0).optional()).optional(),
2731
- period: z.array(z.number().int().min(1).optional()).optional(),
2732
- period_unit: z
2733
- .array(z.enum(['day', 'week', 'month', 'year']).optional())
2734
- .optional(),
2735
- included_in_mrr: z.array(z.boolean().optional()).optional(),
2736
- item_price_id: z.array(z.string().max(100).optional()).optional(),
2737
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2738
- });
2739
- const ImportForItemsSubscriptionChargedItemsSchema = z.object({
2740
- item_price_id: z.array(z.string().max(100).optional()).optional(),
2741
- last_charged_at: z.array(z.number().int().optional()).optional(),
2742
- });
2743
- const ImportForItemsSubscriptionItemTiersSchema = z.object({
2744
- item_price_id: z.array(z.string().max(100).optional()).optional(),
2745
- starting_unit: z.array(z.number().int().min(1).optional()).optional(),
2746
- ending_unit: z.array(z.number().int().optional()).optional(),
2747
- price: z.array(z.number().int().min(0).optional()).optional(),
2748
- starting_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
2749
- ending_unit_in_decimal: z.array(z.string().max(33).optional()).optional(),
2750
- price_in_decimal: z.array(z.string().max(39).optional()).optional(),
2751
- pricing_type: z
2752
- .array(z.enum(['per_unit', 'flat_fee', 'package']).optional())
2753
- .optional(),
2754
- package_size: z.array(z.number().int().min(1).optional()).optional(),
2755
- });
2756
- const ImportForItemsSubscriptionCouponsSchema = z.object({
2757
- coupon_id: z.array(z.string().max(100).optional()).optional(),
2758
- apply_till: z.array(z.number().int().optional()).optional(),
2759
- });
2760
- const ImportForItemsSubscriptionBodySchema = z.looseObject({
2761
- exhausted_coupon_ids: z.array(z.string().max(100).optional()).optional(),
2762
- id: z.string().max(50).optional(),
2763
- trial_end: z.number().int().optional(),
2764
- billing_cycles: z.number().int().min(0).optional(),
2765
- setup_fee: z.number().int().min(0).optional(),
2766
- net_term_days: z.number().int().optional(),
2767
- start_date: z.number().int().optional(),
2768
- auto_collection: z.enum(['on', 'off']).optional(),
2769
- po_number: z.string().max(100).optional(),
2770
- coupon_ids: z.array(z.string().max(100).optional()).optional(),
2771
- payment_source_id: z.string().max(40).optional(),
2772
- status: z.enum([
2773
- 'future',
2774
- 'in_trial',
2775
- 'active',
2776
- 'non_renewing',
2777
- 'paused',
2778
- 'cancelled',
2779
- 'transferred',
2780
- ]),
2781
- current_term_end: z.number().int().optional(),
2782
- current_term_start: z.number().int().optional(),
2783
- trial_start: z.number().int().optional(),
2784
- cancelled_at: z.number().int().optional(),
2785
- started_at: z.number().int().optional(),
2786
- activated_at: z.number().int().optional(),
2787
- pause_date: z.number().int().optional(),
2788
- resume_date: z.number().int().optional(),
2789
- contract_term_billing_cycle_on_renewal: z
2790
- .number()
2791
- .int()
2792
- .min(1)
2793
- .max(100)
2794
- .optional(),
2795
- create_current_term_invoice: z.boolean().default(false).optional(),
2796
- invoice_notes: z.string().max(2000).optional(),
2797
- meta_data: ImportForItemsSubscriptionMetaDataSchema.optional(),
2798
- cancel_reason_code: z.string().max(100).optional(),
2799
- create_pending_invoices: z.boolean().optional(),
2800
- auto_close_invoices: z.boolean().optional(),
2801
- contract_term: ImportForItemsSubscriptionContractTermSchema.optional(),
2802
- transaction: ImportForItemsSubscriptionTransactionSchema.optional(),
2803
- shipping_address: ImportForItemsSubscriptionShippingAddressSchema.optional(),
2804
- subscription_items: ImportForItemsSubscriptionSubscriptionItemsSchema.optional(),
2805
- discounts: ImportForItemsSubscriptionDiscountsSchema.optional(),
2806
- charged_items: ImportForItemsSubscriptionChargedItemsSchema.optional(),
2807
- item_tiers: ImportForItemsSubscriptionItemTiersSchema.optional(),
2808
- coupons: ImportForItemsSubscriptionCouponsSchema.optional(),
2809
- });
2810
- export { ImportForItemsSubscriptionBodySchema };
2811
- //Subscription.overrideBillingProfile
2812
- const OverrideBillingProfileSubscriptionBodySchema = z.looseObject({
2813
- payment_source_id: z.string().max(40).optional(),
2814
- auto_collection: z.enum(['on', 'off']).optional(),
2815
- });
2816
- export { OverrideBillingProfileSubscriptionBodySchema };
2817
- //Subscription.pause
2818
- const PauseSubscriptionBodySchema = z.looseObject({
2819
- pause_option: z
2820
- .enum(['immediately', 'end_of_term', 'specific_date', 'billing_cycles'])
2821
- .optional(),
2822
- pause_date: z.number().int().optional(),
2823
- unbilled_charges_handling: z.enum(['no_action', 'invoice']).optional(),
2824
- invoice_dunning_handling: z.enum(['continue', 'stop']).optional(),
2825
- skip_billing_cycles: z.number().int().min(1).optional(),
2826
- resume_date: z.number().int().optional(),
2827
- });
2828
- export { PauseSubscriptionBodySchema };
2829
- //Subscription.cancel
2830
- const CancelSubscriptionEventBasedAddonsSchema = z.object({
2831
- id: z.array(z.string().max(100).optional()).optional(),
2832
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2833
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
2834
- service_period_in_days: z
2835
- .array(z.number().int().min(1).max(4000).optional())
2836
- .optional(),
2837
- });
2838
- const CancelSubscriptionBodySchema = z.looseObject({
2839
- cancel_option: z
2840
- .enum([
2841
- 'immediately',
2842
- 'end_of_term',
2843
- 'specific_date',
2844
- 'end_of_billing_term',
2845
- ])
2846
- .optional(),
2847
- end_of_term: z.boolean().default(false).optional(),
2848
- cancel_at: z.number().int().optional(),
2849
- credit_option_for_current_term_charges: z
2850
- .enum(['none', 'prorate', 'full'])
2851
- .optional(),
2852
- unbilled_charges_option: z.enum(['invoice', 'delete']).optional(),
2853
- account_receivables_handling: z
2854
- .enum(['no_action', 'schedule_payment_collection', 'write_off'])
2855
- .optional(),
2856
- refundable_credits_handling: z
2857
- .enum(['no_action', 'schedule_refund'])
2858
- .optional(),
2859
- contract_term_cancel_option: z
2860
- .enum([
2861
- 'terminate_immediately',
2862
- 'end_of_contract_term',
2863
- 'specific_date',
2864
- 'end_of_subscription_billing_term',
2865
- ])
2866
- .optional(),
2867
- invoice_date: z.number().int().optional(),
2868
- cancel_reason_code: z.string().max(100).optional(),
2869
- event_based_addons: CancelSubscriptionEventBasedAddonsSchema.optional(),
2870
- });
2871
- export { CancelSubscriptionBodySchema };
2872
- //Subscription.cancelForItems
2873
- const CancelForItemsSubscriptionSubscriptionItemsSchema = z.object({
2874
- item_price_id: z.array(z.string().max(100).optional()).optional(),
2875
- quantity: z.array(z.number().int().min(1).optional()).optional(),
2876
- quantity_in_decimal: z.array(z.string().max(33).optional()).optional(),
2877
- unit_price: z.array(z.number().int().min(0).optional()).optional(),
2878
- unit_price_in_decimal: z.array(z.string().max(39).optional()).optional(),
2879
- service_period_days: z
2880
- .array(z.number().int().min(1).max(730).optional())
2881
- .optional(),
2882
- });
2883
- const CancelForItemsSubscriptionBodySchema = z.looseObject({
2884
- cancel_option: z
2885
- .enum([
2886
- 'immediately',
2887
- 'end_of_term',
2888
- 'specific_date',
2889
- 'end_of_billing_term',
2890
- ])
2891
- .optional(),
2892
- end_of_term: z.boolean().default(false).optional(),
2893
- cancel_at: z.number().int().optional(),
2894
- credit_option_for_current_term_charges: z
2895
- .enum(['none', 'prorate', 'full'])
2896
- .optional(),
2897
- unbilled_charges_option: z.enum(['invoice', 'delete']).optional(),
2898
- account_receivables_handling: z
2899
- .enum(['no_action', 'schedule_payment_collection', 'write_off'])
2900
- .optional(),
2901
- refundable_credits_handling: z
2902
- .enum(['no_action', 'schedule_refund'])
2903
- .optional(),
2904
- contract_term_cancel_option: z
2905
- .enum([
2906
- 'terminate_immediately',
2907
- 'end_of_contract_term',
2908
- 'specific_date',
2909
- 'end_of_subscription_billing_term',
2910
- ])
2911
- .optional(),
2912
- invoice_date: z.number().int().optional(),
2913
- cancel_reason_code: z.string().max(100).optional(),
2914
- decommissioned: z.boolean().default(false).optional(),
2915
- subscription_items: CancelForItemsSubscriptionSubscriptionItemsSchema.optional(),
2916
- });
2917
- export { CancelForItemsSubscriptionBodySchema };
2918
- //Subscription.resume
2919
- const ResumeSubscriptionAdditionalInformationSchema = z.looseObject({});
2920
- const ResumeSubscriptionPaymentIntentSchema = z.object({
2921
- id: z.string().max(150).optional(),
2922
- gateway_account_id: z.string().max(50).optional(),
2923
- gw_token: z.string().max(65000).optional(),
2924
- payment_method_type: z
2925
- .enum([
2926
- 'card',
2927
- 'ideal',
2928
- 'sofort',
2929
- 'bancontact',
2930
- 'google_pay',
2931
- 'dotpay',
2932
- 'giropay',
2933
- 'apple_pay',
2934
- 'upi',
2935
- 'netbanking_emandates',
2936
- 'paypal_express_checkout',
2937
- 'direct_debit',
2938
- 'boleto',
2939
- 'venmo',
2940
- 'amazon_payments',
2941
- 'pay_to',
2942
- 'faster_payments',
2943
- 'sepa_instant_transfer',
2944
- 'klarna_pay_now',
2945
- 'online_banking_poland',
2946
- 'payconiq_by_bancontact',
2947
- 'electronic_payment_standard',
2948
- 'kbc_payment_button',
2949
- 'pay_by_bank',
2950
- 'trustly',
2951
- 'stablecoin',
2952
- 'kakao_pay',
2953
- 'naver_pay',
2954
- 'revolut_pay',
2955
- 'cash_app_pay',
2956
- 'wechat_pay',
2957
- 'alipay',
2958
- 'pix',
2959
- 'twint',
2960
- 'go_pay',
2961
- 'grab_pay',
2962
- 'pay_co',
2963
- 'after_pay',
2964
- 'swish',
2965
- 'payme',
2966
- ])
2967
- .optional(),
2968
- reference_id: z.string().max(65000).optional(),
2969
- gw_payment_method_id: z.string().max(65000).optional(),
2970
- additional_information: ResumeSubscriptionAdditionalInformationSchema.optional(),
2971
- });
2972
- const ResumeSubscriptionBodySchema = z.looseObject({
2973
- resume_option: z.enum(['immediately', 'specific_date']).optional(),
2974
- resume_date: z.number().int().optional(),
2975
- charges_handling: z
2976
- .enum(['invoice_immediately', 'add_to_unbilled_charges'])
2977
- .optional(),
2978
- unpaid_invoices_handling: z
2979
- .enum(['no_action', 'schedule_payment_collection'])
2980
- .optional(),
2981
- payment_initiator: z.enum(['customer', 'merchant']).optional(),
2982
- payment_intent: ResumeSubscriptionPaymentIntentSchema.optional(),
2983
- });
2984
- export { ResumeSubscriptionBodySchema };
2985
- //Subscription.move
2986
- const MoveSubscriptionBodySchema = z.looseObject({
2987
- to_customer_id: z.string().max(50),
2988
- copy_payment_source: z.boolean().default(false).optional(),
2989
- });
2990
- export { MoveSubscriptionBodySchema };