@fantastic.dev/better-stripe 0.57.0 → 0.59.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 (230) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +3 -1
  3. package/dist/client/connect/payoutAdoptionTestHelpers.d.ts +356 -50
  4. package/dist/client/connect/payoutAdoptionTestHelpers.d.ts.map +1 -1
  5. package/dist/client/connect/payoutExecutionTestHelpers.d.ts +162 -9
  6. package/dist/client/connect/payoutExecutionTestHelpers.d.ts.map +1 -1
  7. package/dist/client/connect/payoutLargeAdoptionTestHelpers.d.ts +356 -50
  8. package/dist/client/connect/payoutLargeAdoptionTestHelpers.d.ts.map +1 -1
  9. package/dist/client/connect/payoutSyncTestHelpers.d.ts +162 -9
  10. package/dist/client/connect/payoutSyncTestHelpers.d.ts.map +1 -1
  11. package/dist/client/usage/allowanceClient.d.ts +51 -0
  12. package/dist/client/usage/allowanceClient.d.ts.map +1 -0
  13. package/dist/client/usage/allowanceClient.js +64 -0
  14. package/dist/client/usage/allowanceClient.js.map +1 -0
  15. package/dist/client/usage/allowanceTerms.d.ts +64 -0
  16. package/dist/client/usage/allowanceTerms.d.ts.map +1 -0
  17. package/dist/client/usage/allowanceTerms.js +101 -0
  18. package/dist/client/usage/allowanceTerms.js.map +1 -0
  19. package/dist/client/usage/client.d.ts +2 -2
  20. package/dist/client/usage/client.d.ts.map +1 -1
  21. package/dist/client/usage/client.js +2 -2
  22. package/dist/client/usage/client.js.map +1 -1
  23. package/dist/client/usage/correctionClient.d.ts +33 -0
  24. package/dist/client/usage/correctionClient.d.ts.map +1 -0
  25. package/dist/client/usage/correctionClient.js +27 -0
  26. package/dist/client/usage/correctionClient.js.map +1 -0
  27. package/dist/client/usage/correctionEligibility.d.ts +4 -0
  28. package/dist/client/usage/correctionEligibility.d.ts.map +1 -0
  29. package/dist/client/usage/correctionEligibility.js +7 -0
  30. package/dist/client/usage/correctionEligibility.js.map +1 -0
  31. package/dist/client/usage/correctionInvoice.d.ts +9 -0
  32. package/dist/client/usage/correctionInvoice.d.ts.map +1 -0
  33. package/dist/client/usage/correctionInvoice.js +218 -0
  34. package/dist/client/usage/correctionInvoice.js.map +1 -0
  35. package/dist/client/usage/correctionInvoiceProof.d.ts +29 -0
  36. package/dist/client/usage/correctionInvoiceProof.d.ts.map +1 -0
  37. package/dist/client/usage/correctionInvoiceProof.js +41 -0
  38. package/dist/client/usage/correctionInvoiceProof.js.map +1 -0
  39. package/dist/client/usage/correctionProofs.d.ts +36 -0
  40. package/dist/client/usage/correctionProofs.d.ts.map +1 -0
  41. package/dist/client/usage/correctionProofs.js +41 -0
  42. package/dist/client/usage/correctionProofs.js.map +1 -0
  43. package/dist/client/usage/correctionProvider.d.ts +6 -0
  44. package/dist/client/usage/correctionProvider.d.ts.map +1 -0
  45. package/dist/client/usage/correctionProvider.js +243 -0
  46. package/dist/client/usage/correctionProvider.js.map +1 -0
  47. package/dist/client/usage/correctionRead.d.ts +27 -0
  48. package/dist/client/usage/correctionRead.d.ts.map +1 -0
  49. package/dist/client/usage/correctionRead.js +36 -0
  50. package/dist/client/usage/correctionRead.js.map +1 -0
  51. package/dist/client/usage/correctionTerms.d.ts +64 -0
  52. package/dist/client/usage/correctionTerms.d.ts.map +1 -0
  53. package/dist/client/usage/correctionTerms.js +65 -0
  54. package/dist/client/usage/correctionTerms.js.map +1 -0
  55. package/dist/client/usage/correctionTransport.fixtures.d.ts +37 -0
  56. package/dist/client/usage/correctionTransport.fixtures.d.ts.map +1 -0
  57. package/dist/client/usage/correctionTransport.fixtures.js +322 -0
  58. package/dist/client/usage/correctionTransport.fixtures.js.map +1 -0
  59. package/dist/client/usage/creditClient.d.ts +1 -1
  60. package/dist/client/usage/index.d.ts +4 -0
  61. package/dist/client/usage/index.d.ts.map +1 -1
  62. package/dist/client/usage/observationClient.d.ts +20 -0
  63. package/dist/client/usage/observationClient.d.ts.map +1 -1
  64. package/dist/client/usage/observationClient.js +20 -6
  65. package/dist/client/usage/observationClient.js.map +1 -1
  66. package/dist/client/usage/records.d.ts +1 -1
  67. package/dist/client/usage/records.d.ts.map +1 -1
  68. package/dist/client/usage/records.js.map +1 -1
  69. package/dist/client/usage/summary.d.ts +3 -0
  70. package/dist/client/usage/summary.d.ts.map +1 -1
  71. package/dist/client/usage/summary.js +9 -4
  72. package/dist/client/usage/summary.js.map +1 -1
  73. package/dist/client/usageExports.d.ts +4 -0
  74. package/dist/client/usageExports.d.ts.map +1 -1
  75. package/dist/component/_generated/api.d.ts +20 -0
  76. package/dist/component/_generated/api.d.ts.map +1 -1
  77. package/dist/component/_generated/api.js.map +1 -1
  78. package/dist/component/_generated/component.d.ts +324 -13
  79. package/dist/component/_generated/component.d.ts.map +1 -1
  80. package/dist/component/accountClosure/mutations.d.ts.map +1 -1
  81. package/dist/component/accountClosure/mutations.js +13 -0
  82. package/dist/component/accountClosure/mutations.js.map +1 -1
  83. package/dist/component/balanceFunding/internal/actions.d.ts +11 -11
  84. package/dist/component/balanceFunding/mutations.d.ts +43 -43
  85. package/dist/component/balanceFunding/workflowValidators.d.ts +16 -16
  86. package/dist/component/earnings/triggers.d.ts +288 -10
  87. package/dist/component/earnings/triggers.d.ts.map +1 -1
  88. package/dist/component/schema.d.ts +162 -9
  89. package/dist/component/schema.js +7 -0
  90. package/dist/component/schema.js.map +1 -1
  91. package/dist/component/usage/mutations.d.ts.map +1 -1
  92. package/dist/component/usage/mutations.js +4 -0
  93. package/dist/component/usage/mutations.js.map +1 -1
  94. package/dist/component/usage/queries.d.ts +2 -2
  95. package/dist/component/usage/schema.d.ts +21 -15
  96. package/dist/component/usage/schema.d.ts.map +1 -1
  97. package/dist/component/usage/schema.js +4 -2
  98. package/dist/component/usage/schema.js.map +1 -1
  99. package/dist/component/usageAllowance/helpers.d.ts +78 -0
  100. package/dist/component/usageAllowance/helpers.d.ts.map +1 -0
  101. package/dist/component/usageAllowance/helpers.js +99 -0
  102. package/dist/component/usageAllowance/helpers.js.map +1 -0
  103. package/dist/component/usageAllowance/mutations.d.ts +37 -0
  104. package/dist/component/usageAllowance/mutations.d.ts.map +1 -0
  105. package/dist/component/usageAllowance/mutations.js +99 -0
  106. package/dist/component/usageAllowance/mutations.js.map +1 -0
  107. package/dist/component/usageAllowance/queries.d.ts +36 -0
  108. package/dist/component/usageAllowance/queries.d.ts.map +1 -0
  109. package/dist/component/usageAllowance/queries.js +122 -0
  110. package/dist/component/usageAllowance/queries.js.map +1 -0
  111. package/dist/component/usageAllowance/reservations.d.ts +25 -0
  112. package/dist/component/usageAllowance/reservations.d.ts.map +1 -0
  113. package/dist/component/usageAllowance/reservations.js +150 -0
  114. package/dist/component/usageAllowance/reservations.js.map +1 -0
  115. package/dist/component/usageAllowance/schema.d.ts +77 -0
  116. package/dist/component/usageAllowance/schema.d.ts.map +1 -0
  117. package/dist/component/usageAllowance/schema.js +32 -0
  118. package/dist/component/usageAllowance/schema.js.map +1 -0
  119. package/dist/component/usageCorrections/accounting.d.ts +5 -0
  120. package/dist/component/usageCorrections/accounting.d.ts.map +1 -0
  121. package/dist/component/usageCorrections/accounting.js +55 -0
  122. package/dist/component/usageCorrections/accounting.js.map +1 -0
  123. package/dist/component/usageCorrections/cancellation.d.ts +6 -0
  124. package/dist/component/usageCorrections/cancellation.d.ts.map +1 -0
  125. package/dist/component/usageCorrections/cancellation.js +29 -0
  126. package/dist/component/usageCorrections/cancellation.js.map +1 -0
  127. package/dist/component/usageCorrections/helpers.d.ts +60 -0
  128. package/dist/component/usageCorrections/helpers.d.ts.map +1 -0
  129. package/dist/component/usageCorrections/helpers.js +52 -0
  130. package/dist/component/usageCorrections/helpers.js.map +1 -0
  131. package/dist/component/usageCorrections/invoice.d.ts +38 -0
  132. package/dist/component/usageCorrections/invoice.d.ts.map +1 -0
  133. package/dist/component/usageCorrections/invoice.js +82 -0
  134. package/dist/component/usageCorrections/invoice.js.map +1 -0
  135. package/dist/component/usageCorrections/mutations.d.ts +121 -0
  136. package/dist/component/usageCorrections/mutations.d.ts.map +1 -0
  137. package/dist/component/usageCorrections/mutations.js +256 -0
  138. package/dist/component/usageCorrections/mutations.js.map +1 -0
  139. package/dist/component/usageCorrections/queries.d.ts +115 -0
  140. package/dist/component/usageCorrections/queries.d.ts.map +1 -0
  141. package/dist/component/usageCorrections/queries.js +84 -0
  142. package/dist/component/usageCorrections/queries.js.map +1 -0
  143. package/dist/component/usageCorrections/schema.d.ts +248 -0
  144. package/dist/component/usageCorrections/schema.d.ts.map +1 -0
  145. package/dist/component/usageCorrections/schema.js +74 -0
  146. package/dist/component/usageCorrections/schema.js.map +1 -0
  147. package/dist/component/usageCredits/queries.d.ts +1 -1
  148. package/dist/component/usageCredits/queries.d.ts.map +1 -1
  149. package/dist/component/usageCredits/queries.js +6 -0
  150. package/dist/component/usageCredits/queries.js.map +1 -1
  151. package/dist/component/usageCredits/schema.d.ts +5 -5
  152. package/dist/component/usageCredits/schema.d.ts.map +1 -1
  153. package/dist/component/usageCredits/schema.js +1 -1
  154. package/dist/component/usageCredits/schema.js.map +1 -1
  155. package/dist/component/usageDelivery/fields.d.ts +2 -2
  156. package/dist/component/usageDelivery/fields.d.ts.map +1 -1
  157. package/dist/component/usageDelivery/fields.js +1 -1
  158. package/dist/component/usageDelivery/fields.js.map +1 -1
  159. package/dist/component/usageDelivery/helpers.d.ts +7 -6
  160. package/dist/component/usageDelivery/helpers.d.ts.map +1 -1
  161. package/dist/component/usageDelivery/mutations.d.ts +6 -6
  162. package/dist/component/usageDelivery/mutations.d.ts.map +1 -1
  163. package/dist/component/usageDelivery/mutations.js +9 -1
  164. package/dist/component/usageDelivery/mutations.js.map +1 -1
  165. package/dist/component/usageDelivery/queries.d.ts +8 -6
  166. package/dist/component/usageDelivery/queries.d.ts.map +1 -1
  167. package/dist/component/usageDelivery/schema.d.ts +4 -4
  168. package/dist/component/usageDelivery/steps.d.ts +2 -2
  169. package/dist/component/usageDelivery/steps.js +1 -1
  170. package/dist/component/usageDelivery/steps.js.map +1 -1
  171. package/dist/component/usageObservations/queries.d.ts.map +1 -1
  172. package/dist/component/usageObservations/queries.js +4 -2
  173. package/dist/component/usageObservations/queries.js.map +1 -1
  174. package/dist/component/usageSubscriptions/retirement.d.ts.map +1 -1
  175. package/dist/component/usageSubscriptions/retirement.js +24 -2
  176. package/dist/component/usageSubscriptions/retirement.js.map +1 -1
  177. package/docs/README.md +4 -0
  178. package/docs/usage-corrections.md +249 -0
  179. package/docs/usage-limits.md +217 -0
  180. package/package.json +3 -1
  181. package/src/client/usage/allowanceClient.test.ts +93 -0
  182. package/src/client/usage/allowanceClient.ts +134 -0
  183. package/src/client/usage/allowanceTerms.test.ts +131 -0
  184. package/src/client/usage/allowanceTerms.ts +172 -0
  185. package/src/client/usage/client.ts +2 -2
  186. package/src/client/usage/correctionClient.test.ts +153 -0
  187. package/src/client/usage/correctionClient.ts +62 -0
  188. package/src/client/usage/correctionCredits.test.ts +156 -0
  189. package/src/client/usage/correctionEligibility.ts +14 -0
  190. package/src/client/usage/correctionInvoice.test.ts +127 -0
  191. package/src/client/usage/correctionInvoice.ts +269 -0
  192. package/src/client/usage/correctionInvoiceProof.ts +40 -0
  193. package/src/client/usage/correctionProofs.ts +40 -0
  194. package/src/client/usage/correctionProvider.ts +326 -0
  195. package/src/client/usage/correctionRead.ts +73 -0
  196. package/src/client/usage/correctionRecovery.test.ts +113 -0
  197. package/src/client/usage/correctionTerms.ts +98 -0
  198. package/src/client/usage/correctionTransport.fixtures.ts +372 -0
  199. package/src/client/usage/index.ts +19 -0
  200. package/src/client/usage/observationClient.ts +20 -6
  201. package/src/client/usage/records.ts +7 -1
  202. package/src/client/usage/summary.ts +12 -4
  203. package/src/client/usageExports.ts +19 -0
  204. package/src/component/_generated/api.ts +20 -0
  205. package/src/component/_generated/component.ts +423 -1
  206. package/src/component/accountClosure/mutations.ts +17 -0
  207. package/src/component/schema.ts +14 -0
  208. package/src/component/usage/allowance.test.ts +435 -0
  209. package/src/component/usage/mutations.ts +13 -0
  210. package/src/component/usage/schema.ts +6 -1
  211. package/src/component/usageAllowance/helpers.ts +137 -0
  212. package/src/component/usageAllowance/mutations.ts +139 -0
  213. package/src/component/usageAllowance/queries.ts +140 -0
  214. package/src/component/usageAllowance/reservations.ts +220 -0
  215. package/src/component/usageAllowance/schema.ts +37 -0
  216. package/src/component/usageCorrections/accounting.ts +79 -0
  217. package/src/component/usageCorrections/cancellation.ts +32 -0
  218. package/src/component/usageCorrections/corrections.test.ts +389 -0
  219. package/src/component/usageCorrections/helpers.ts +57 -0
  220. package/src/component/usageCorrections/invoice.ts +103 -0
  221. package/src/component/usageCorrections/mutations.ts +278 -0
  222. package/src/component/usageCorrections/queries.ts +94 -0
  223. package/src/component/usageCorrections/schema.ts +90 -0
  224. package/src/component/usageCredits/queries.ts +4 -0
  225. package/src/component/usageCredits/schema.ts +1 -0
  226. package/src/component/usageDelivery/fields.ts +1 -0
  227. package/src/component/usageDelivery/mutations.ts +8 -3
  228. package/src/component/usageDelivery/steps.ts +1 -1
  229. package/src/component/usageObservations/queries.ts +5 -2
  230. package/src/component/usageSubscriptions/retirement.ts +31 -2
@@ -8307,6 +8307,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8307
8307
  {
8308
8308
  delivery:
8309
8309
  | "queued"
8310
+ | "canceled"
8310
8311
  | "sending"
8311
8312
  | "provider_accepted"
8312
8313
  | "rejected"
@@ -8353,6 +8354,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8353
8354
  page: Array<{
8354
8355
  delivery:
8355
8356
  | "queued"
8357
+ | "canceled"
8356
8358
  | "sending"
8357
8359
  | "provider_accepted"
8358
8360
  | "rejected"
@@ -8378,6 +8380,101 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8378
8380
  >;
8379
8381
  };
8380
8382
  };
8383
+ usageAllowance: {
8384
+ mutations: {
8385
+ configure: FunctionReference<
8386
+ "mutation",
8387
+ "internal",
8388
+ { bindingJson: string; expectedRevision: number; policyJson: string },
8389
+ { revision: number },
8390
+ Name
8391
+ >;
8392
+ release: FunctionReference<
8393
+ "mutation",
8394
+ "internal",
8395
+ {
8396
+ reason: "work_failed" | "abandoned_before_work";
8397
+ reservationId: string;
8398
+ scope: {
8399
+ customerAccount: string;
8400
+ livemode: boolean;
8401
+ meterId: string;
8402
+ stripeAccountId: string;
8403
+ };
8404
+ },
8405
+ null,
8406
+ Name
8407
+ >;
8408
+ reserve: FunctionReference<
8409
+ "mutation",
8410
+ "internal",
8411
+ { inputJson: string; subscriptionJson: string },
8412
+ | {
8413
+ reason: "not_entitled" | "hard_limit";
8414
+ revision: number;
8415
+ state: "denied";
8416
+ }
8417
+ | {
8418
+ reservationId: string;
8419
+ revision: number;
8420
+ state: "reserved" | "committed" | "released";
8421
+ },
8422
+ Name
8423
+ >;
8424
+ };
8425
+ queries: {
8426
+ readHistory: FunctionReference<
8427
+ "query",
8428
+ "internal",
8429
+ {
8430
+ bindingJson: string;
8431
+ paginationOpts: {
8432
+ cursor: string | null;
8433
+ endCursor?: string | null;
8434
+ id?: number;
8435
+ maximumBytesRead?: number;
8436
+ maximumRowsRead?: number;
8437
+ numItems: number;
8438
+ };
8439
+ },
8440
+ {
8441
+ continueCursor: string;
8442
+ isDone: boolean;
8443
+ page: Array<{
8444
+ _creationTime: number;
8445
+ _id: string;
8446
+ at: number;
8447
+ evidenceJson: string;
8448
+ key: string;
8449
+ kind:
8450
+ "policy" | "reservation" | "commit" | "release" | "correction";
8451
+ }>;
8452
+ },
8453
+ Name
8454
+ >;
8455
+ reconciliation: FunctionReference<
8456
+ "query",
8457
+ "internal",
8458
+ { bindingJson: string },
8459
+ {
8460
+ acceptedScaledQuantity: string;
8461
+ consumedScaledQuantity: string;
8462
+ reason: string;
8463
+ repaired: false;
8464
+ reservedScaledQuantity: string;
8465
+ status: "matched" | "held";
8466
+ },
8467
+ Name
8468
+ >;
8469
+ status: FunctionReference<
8470
+ "query",
8471
+ "internal",
8472
+ { bindingJson: string },
8473
+ string | null,
8474
+ Name
8475
+ >;
8476
+ };
8477
+ };
8381
8478
  usageCatalog: {
8382
8479
  mutations: {
8383
8480
  complete: FunctionReference<
@@ -8456,6 +8553,319 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8456
8553
  >;
8457
8554
  };
8458
8555
  };
8556
+ usageCorrections: {
8557
+ mutations: {
8558
+ adopt: FunctionReference<
8559
+ "mutation",
8560
+ "internal",
8561
+ { key: string; proofJson: string },
8562
+ {
8563
+ _creationTime: number;
8564
+ _id: string;
8565
+ adjustmentJson?: string;
8566
+ attempt: number;
8567
+ attemptedAt?: number;
8568
+ cashConsequence:
8569
+ | "none"
8570
+ | "operator_resolution_required"
8571
+ | "verified_external_adjustment";
8572
+ correctionId: string;
8573
+ creditNoteId?: string;
8574
+ customerAccount?: string;
8575
+ eventId: string;
8576
+ firstAttemptAt: number;
8577
+ historyCount: number;
8578
+ inputJson: string;
8579
+ invoiceId?: string;
8580
+ key: string;
8581
+ leaseUntil?: number;
8582
+ nativeAdjustmentId?: string;
8583
+ nativeCreditNoteStatus?: "issued" | "void";
8584
+ nativeStatus?: "pending" | "complete";
8585
+ observedAt?: number;
8586
+ quantity: string;
8587
+ reason: string;
8588
+ recordJson: string;
8589
+ refundId?: string;
8590
+ resolution?: "event_cancellation" | "invoice_credit";
8591
+ restoredQuantity: string;
8592
+ scaledQuantity: string;
8593
+ scopeKey: string;
8594
+ state:
8595
+ | "requested"
8596
+ | "provider_accepted"
8597
+ | "confirmed"
8598
+ | "held"
8599
+ | "unsupported"
8600
+ | "invoice_adjustment_required";
8601
+ stripeAccountId?: string;
8602
+ subscriptionJson: string;
8603
+ },
8604
+ Name
8605
+ >;
8606
+ claim: FunctionReference<
8607
+ "mutation",
8608
+ "internal",
8609
+ { key: string },
8610
+ { attempt: number; kind: "ready" | "busy" | "done" },
8611
+ Name
8612
+ >;
8613
+ prepare: FunctionReference<
8614
+ "mutation",
8615
+ "internal",
8616
+ { inputJson: string },
8617
+ {
8618
+ _creationTime: number;
8619
+ _id: string;
8620
+ adjustmentJson?: string;
8621
+ attempt: number;
8622
+ attemptedAt?: number;
8623
+ cashConsequence:
8624
+ | "none"
8625
+ | "operator_resolution_required"
8626
+ | "verified_external_adjustment";
8627
+ correctionId: string;
8628
+ creditNoteId?: string;
8629
+ customerAccount?: string;
8630
+ eventId: string;
8631
+ firstAttemptAt: number;
8632
+ historyCount: number;
8633
+ inputJson: string;
8634
+ invoiceId?: string;
8635
+ key: string;
8636
+ leaseUntil?: number;
8637
+ nativeAdjustmentId?: string;
8638
+ nativeCreditNoteStatus?: "issued" | "void";
8639
+ nativeStatus?: "pending" | "complete";
8640
+ observedAt?: number;
8641
+ quantity: string;
8642
+ reason: string;
8643
+ recordJson: string;
8644
+ refundId?: string;
8645
+ resolution?: "event_cancellation" | "invoice_credit";
8646
+ restoredQuantity: string;
8647
+ scaledQuantity: string;
8648
+ scopeKey: string;
8649
+ state:
8650
+ | "requested"
8651
+ | "provider_accepted"
8652
+ | "confirmed"
8653
+ | "held"
8654
+ | "unsupported"
8655
+ | "invoice_adjustment_required";
8656
+ stripeAccountId?: string;
8657
+ subscriptionJson: string;
8658
+ },
8659
+ Name
8660
+ >;
8661
+ save: FunctionReference<
8662
+ "mutation",
8663
+ "internal",
8664
+ { attempt: number; key: string; outcomeJson: string },
8665
+ {
8666
+ _creationTime: number;
8667
+ _id: string;
8668
+ adjustmentJson?: string;
8669
+ attempt: number;
8670
+ attemptedAt?: number;
8671
+ cashConsequence:
8672
+ | "none"
8673
+ | "operator_resolution_required"
8674
+ | "verified_external_adjustment";
8675
+ correctionId: string;
8676
+ creditNoteId?: string;
8677
+ customerAccount?: string;
8678
+ eventId: string;
8679
+ firstAttemptAt: number;
8680
+ historyCount: number;
8681
+ inputJson: string;
8682
+ invoiceId?: string;
8683
+ key: string;
8684
+ leaseUntil?: number;
8685
+ nativeAdjustmentId?: string;
8686
+ nativeCreditNoteStatus?: "issued" | "void";
8687
+ nativeStatus?: "pending" | "complete";
8688
+ observedAt?: number;
8689
+ quantity: string;
8690
+ reason: string;
8691
+ recordJson: string;
8692
+ refundId?: string;
8693
+ resolution?: "event_cancellation" | "invoice_credit";
8694
+ restoredQuantity: string;
8695
+ scaledQuantity: string;
8696
+ scopeKey: string;
8697
+ state:
8698
+ | "requested"
8699
+ | "provider_accepted"
8700
+ | "confirmed"
8701
+ | "held"
8702
+ | "unsupported"
8703
+ | "invoice_adjustment_required";
8704
+ stripeAccountId?: string;
8705
+ subscriptionJson: string;
8706
+ },
8707
+ Name
8708
+ >;
8709
+ };
8710
+ queries: {
8711
+ get: FunctionReference<
8712
+ "query",
8713
+ "internal",
8714
+ {
8715
+ correctionId: string;
8716
+ eventId: string;
8717
+ scope: {
8718
+ customerAccount: string;
8719
+ livemode: boolean;
8720
+ meterId: string;
8721
+ stripeAccountId: string;
8722
+ };
8723
+ },
8724
+ {
8725
+ _creationTime: number;
8726
+ _id: string;
8727
+ adjustmentJson?: string;
8728
+ attempt: number;
8729
+ attemptedAt?: number;
8730
+ cashConsequence:
8731
+ | "none"
8732
+ | "operator_resolution_required"
8733
+ | "verified_external_adjustment";
8734
+ correctionId: string;
8735
+ creditNoteId?: string;
8736
+ customerAccount?: string;
8737
+ eventId: string;
8738
+ firstAttemptAt: number;
8739
+ historyCount: number;
8740
+ inputJson: string;
8741
+ invoiceId?: string;
8742
+ key: string;
8743
+ leaseUntil?: number;
8744
+ nativeAdjustmentId?: string;
8745
+ nativeCreditNoteStatus?: "issued" | "void";
8746
+ nativeStatus?: "pending" | "complete";
8747
+ observedAt?: number;
8748
+ quantity: string;
8749
+ reason: string;
8750
+ recordJson: string;
8751
+ refundId?: string;
8752
+ resolution?: "event_cancellation" | "invoice_credit";
8753
+ restoredQuantity: string;
8754
+ scaledQuantity: string;
8755
+ scopeKey: string;
8756
+ state:
8757
+ | "requested"
8758
+ | "provider_accepted"
8759
+ | "confirmed"
8760
+ | "held"
8761
+ | "unsupported"
8762
+ | "invoice_adjustment_required";
8763
+ stripeAccountId?: string;
8764
+ subscriptionJson: string;
8765
+ } | null,
8766
+ Name
8767
+ >;
8768
+ periodHistory: FunctionReference<
8769
+ "query",
8770
+ "internal",
8771
+ {
8772
+ paginationOpts: {
8773
+ cursor: string | null;
8774
+ endCursor?: string | null;
8775
+ id?: number;
8776
+ maximumBytesRead?: number;
8777
+ maximumRowsRead?: number;
8778
+ numItems: number;
8779
+ };
8780
+ period: { end: number; start: number };
8781
+ scope: {
8782
+ customerAccount: string;
8783
+ livemode: boolean;
8784
+ meterId: string;
8785
+ stripeAccountId: string;
8786
+ };
8787
+ },
8788
+ {
8789
+ continueCursor: string;
8790
+ isDone: boolean;
8791
+ legacyHistoryMissing: boolean;
8792
+ page: Array<{
8793
+ _creationTime: number;
8794
+ _id: string;
8795
+ at: number;
8796
+ eventId: string;
8797
+ evidenceJson: string;
8798
+ key: string;
8799
+ occurredAt?: number;
8800
+ reason: string;
8801
+ recordJson: string;
8802
+ scopeKey: string;
8803
+ sequence: number;
8804
+ state:
8805
+ | "requested"
8806
+ | "provider_accepted"
8807
+ | "confirmed"
8808
+ | "held"
8809
+ | "unsupported"
8810
+ | "invoice_adjustment_required";
8811
+ subscriptionJson: string;
8812
+ }>;
8813
+ pageStatus?: "SplitRecommended" | "SplitRequired" | null;
8814
+ splitCursor?: string | null;
8815
+ },
8816
+ Name
8817
+ >;
8818
+ readHistory: FunctionReference<
8819
+ "query",
8820
+ "internal",
8821
+ {
8822
+ eventId: string;
8823
+ paginationOpts: {
8824
+ cursor: string | null;
8825
+ endCursor?: string | null;
8826
+ id?: number;
8827
+ maximumBytesRead?: number;
8828
+ maximumRowsRead?: number;
8829
+ numItems: number;
8830
+ };
8831
+ scope: {
8832
+ customerAccount: string;
8833
+ livemode: boolean;
8834
+ meterId: string;
8835
+ stripeAccountId: string;
8836
+ };
8837
+ },
8838
+ {
8839
+ continueCursor: string;
8840
+ isDone: boolean;
8841
+ page: Array<{
8842
+ _creationTime: number;
8843
+ _id: string;
8844
+ at: number;
8845
+ eventId: string;
8846
+ evidenceJson: string;
8847
+ key: string;
8848
+ occurredAt?: number;
8849
+ reason: string;
8850
+ recordJson: string;
8851
+ scopeKey: string;
8852
+ sequence: number;
8853
+ state:
8854
+ | "requested"
8855
+ | "provider_accepted"
8856
+ | "confirmed"
8857
+ | "held"
8858
+ | "unsupported"
8859
+ | "invoice_adjustment_required";
8860
+ subscriptionJson: string;
8861
+ }>;
8862
+ pageStatus?: "SplitRecommended" | "SplitRequired" | null;
8863
+ splitCursor?: string | null;
8864
+ },
8865
+ Name
8866
+ >;
8867
+ };
8868
+ };
8459
8869
  usageCredits: {
8460
8870
  mutations: {
8461
8871
  cancelPurchase: FunctionReference<
@@ -8837,7 +9247,8 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8837
9247
  | "release"
8838
9248
  | "observation"
8839
9249
  | "recovery"
8840
- | "closure";
9250
+ | "closure"
9251
+ | "correction";
8841
9252
  purchaseKey?: string;
8842
9253
  sourceKey: string;
8843
9254
  }>;
@@ -8868,6 +9279,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8868
9279
  held: boolean;
8869
9280
  providerIdentifier: string;
8870
9281
  reason?:
9282
+ | "usage_canceled"
8871
9283
  | "billing_period_closed"
8872
9284
  | "rate_limited"
8873
9285
  | "provider_unavailable"
@@ -8880,6 +9292,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8880
9292
  receipt?: { created: number; identifier: string };
8881
9293
  state:
8882
9294
  | "queued"
9295
+ | "canceled"
8883
9296
  | "sending"
8884
9297
  | "provider_accepted"
8885
9298
  | "rejected"
@@ -8947,6 +9360,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8947
9360
  held: boolean;
8948
9361
  providerIdentifier: string;
8949
9362
  reason?:
9363
+ | "usage_canceled"
8950
9364
  | "billing_period_closed"
8951
9365
  | "rate_limited"
8952
9366
  | "provider_unavailable"
@@ -8959,6 +9373,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
8959
9373
  receipt?: { created: number; identifier: string };
8960
9374
  state:
8961
9375
  | "queued"
9376
+ | "canceled"
8962
9377
  | "sending"
8963
9378
  | "provider_accepted"
8964
9379
  | "rejected"
@@ -9002,6 +9417,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
9002
9417
  held: boolean;
9003
9418
  providerIdentifier: string;
9004
9419
  reason?:
9420
+ | "usage_canceled"
9005
9421
  | "billing_period_closed"
9006
9422
  | "rate_limited"
9007
9423
  | "provider_unavailable"
@@ -9014,6 +9430,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
9014
9430
  receipt?: { created: number; identifier: string };
9015
9431
  state:
9016
9432
  | "queued"
9433
+ | "canceled"
9017
9434
  | "sending"
9018
9435
  | "provider_accepted"
9019
9436
  | "rejected"
@@ -9057,6 +9474,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
9057
9474
  held: boolean;
9058
9475
  providerIdentifier: string;
9059
9476
  reason?:
9477
+ | "usage_canceled"
9060
9478
  | "billing_period_closed"
9061
9479
  | "rate_limited"
9062
9480
  | "provider_unavailable"
@@ -9069,6 +9487,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
9069
9487
  receipt?: { created: number; identifier: string };
9070
9488
  state:
9071
9489
  | "queued"
9490
+ | "canceled"
9072
9491
  | "sending"
9073
9492
  | "provider_accepted"
9074
9493
  | "rejected"
@@ -9127,6 +9546,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
9127
9546
  _creationTime: number;
9128
9547
  _id: string;
9129
9548
  attempts: number;
9549
+ correctionKey?: string;
9130
9550
  definitionVersion?: 1;
9131
9551
  dispatch?: string;
9132
9552
  eventId: string;
@@ -9138,6 +9558,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
9138
9558
  provider?: string;
9139
9559
  providerIdentifier: string;
9140
9560
  reason?:
9561
+ | "usage_canceled"
9141
9562
  | "billing_period_closed"
9142
9563
  | "rate_limited"
9143
9564
  | "provider_unavailable"
@@ -9151,6 +9572,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
9151
9572
  scopeKey: string;
9152
9573
  state:
9153
9574
  | "queued"
9575
+ | "canceled"
9154
9576
  | "sending"
9155
9577
  | "provider_accepted"
9156
9578
  | "rejected"
@@ -1,3 +1,4 @@
1
+ import { unresolvedCorrectionStates } from "../usageCorrections/cancellation.js";
1
2
  import { v } from "convex/values";
2
3
  import { mutation } from "../_generated/server.js";
3
4
  import { closureByStripeId } from "./helpers.js";
@@ -7,6 +8,22 @@ export const prepare = mutation({
7
8
  args: { stripeAccountId: v.string() },
8
9
  returns: v.object({ closure: closureDoc, isRetry: v.boolean() }),
9
10
  handler: async (ctx, { stripeAccountId }) => {
11
+ for (const state of unresolvedCorrectionStates) {
12
+ const payerCorrection = await ctx.db
13
+ .query("usageCorrections")
14
+ .withIndex("by_payer_state", (q) =>
15
+ q.eq("customerAccount", stripeAccountId).eq("state", state),
16
+ )
17
+ .first();
18
+ const realmCorrection = await ctx.db
19
+ .query("usageCorrections")
20
+ .withIndex("by_realm_state", (q) =>
21
+ q.eq("stripeAccountId", stripeAccountId).eq("state", state),
22
+ )
23
+ .first();
24
+ if (payerCorrection || realmCorrection)
25
+ throw new Error("Resolve usage corrections before account closure");
26
+ }
10
27
  const payerLock = await ctx.db
11
28
  .query("usageSubscriptionLocks")
12
29
  .withIndex("by_payer", (q) => q.eq("customerAccount", stripeAccountId))
@@ -1,3 +1,12 @@
1
+ import {
2
+ claimsTable as usageCorrectionClaims,
3
+ operationsTable as usageCorrections,
4
+ historyTable as usageCorrectionHistory,
5
+ } from "./usageCorrections/schema.js";
6
+ import {
7
+ policiesTable as usageAllowancePolicies,
8
+ historyTable as usageAllowanceHistory,
9
+ } from "./usageAllowance/schema.js";
1
10
  import {
2
11
  accountsTable as usageCreditAccounts,
3
12
  purchasesTable as usageCreditPurchases,
@@ -116,6 +125,11 @@ import { pricesTable, productsTable } from "./products/schema";
116
125
  import { webhookEventsTable } from "./webhooks/schema";
117
126
 
118
127
  export default defineSchema({
128
+ usageCorrectionClaims,
129
+ usageCorrections,
130
+ usageCorrectionHistory,
131
+ usageAllowancePolicies,
132
+ usageAllowanceHistory,
119
133
  usageSubscriptionControls,
120
134
  usageSubscriptionIntents,
121
135
  usageSubscriptionLocks,