import { A as AccountingInvoicePaymentRequestsCreateData, a as AccountingInvoicePaymentRequestsCreateResponse, b as AccountingInvoicePaymentRequestsGetData, c as AccountingInvoicePaymentRequestsGetResponse, d as AnalyticsRevenueMrrSummaryData, e as AnalyticsRevenueMrrSummaryResponse, f as AnalyticsRevenueTimeSeriesData, g as AnalyticsRevenueTimeSeriesResponse, C as CartApiKeysEnsureResponse, h as CartApiKeysRotateData, i as CartApiKeysRotateResponse, j as CartApiKeysStatusResponse, k as CartSessionsAddLineItemData, l as CartSessionsAddLineItemResponse, m as CartSessionsApplyDiscountCodeData, n as CartSessionsApplyDiscountCodeResponse, o as CartSessionsConvertData, p as CartSessionsConvertResponse, q as CartSessionsCreateData, r as CartSessionsCreateResponse, s as CartSessionsGetData, t as CartSessionsGetResponse, u as CartSessionsRemoveLineItemData, v as CartSessionsRemoveLineItemResponse, w as CartSessionsSetContactData, x as CartSessionsSetContactResponse, y as CartSessionsToggleAddOnData, z as CartSessionsToggleAddOnResponse, D as CartSessionsUpdateLineItemData, E as CartSessionsUpdateLineItemResponse, F as CheckoutSessionsCreateData, G as CheckoutSessionsCreateResponse, H as CheckoutSessionsExpireData, I as CheckoutSessionsExpireResponse, J as CheckoutSessionsGetData, K as CheckoutSessionsGetResponse, L as CreditNotesCreateData, M as CreditNotesCreateResponse, N as CreditNotesGetData, O as CreditNotesGetResponse, P as CreditNotesListData, Q as CreditNotesListResponse, R as CreditNotesListLinesData, S as CreditNotesListLinesResponse, T as CreditNotesPreviewData, V as CreditNotesPreviewResponse, W as CreditNotesVoidData, X as CreditNotesVoidResponse, Y as CustomerMetersGetData, Z as CustomerMetersGetResponse, _ as CustomerMetersListData, $ as CustomerMetersListResponse, a0 as CustomerPortalCustomerGetResponse, a1 as CustomerPortalInvoicesGetData, a2 as CustomerPortalInvoicesGetResponse, a3 as CustomerPortalInvoicesListData, a4 as CustomerPortalInvoicesListResponse, a5 as CustomerPortalMandatesCancelData, a6 as CustomerPortalMandatesCancelResponse, a7 as CustomerPortalMandatesListResponse, a8 as CustomerPortalMandatesReauthorizeData, a9 as CustomerPortalMandatesReauthorizeResponse, aa as CustomerPortalMandatesReauthorizeSendOtpData, ab as CustomerPortalMandatesReauthorizeSendOtpResponse, ac as CustomerPortalMandatesReauthorizeVerifyOtpData, ad as CustomerPortalMandatesReauthorizeVerifyOtpResponse, ae as CustomerPortalSessionsCreateData, af as CustomerPortalSessionsCreateResponse, ag as CustomerPortalSubscriptionsCancelData, ah as CustomerPortalSubscriptionsCancelResponse, ai as CustomerPortalSubscriptionsGetData, aj as CustomerPortalSubscriptionsGetResponse, ak as CustomerPortalSubscriptionsListData, al as CustomerPortalSubscriptionsListResponse, am as CustomersCreateData, an as CustomersCreateResponse, ao as CustomersGetData, ap as CustomersGetResponse, aq as CustomersListData, ar as CustomersListResponse, as as CustomersPaymentMethodsListData, at as CustomersPaymentMethodsListResponse, au as CustomersPaymentRailsGetData, av as CustomersPaymentRailsGetResponse, aw as CustomersPreferredRailsGetData, ax as CustomersPreferredRailsGetResponse, ay as CustomersUpdateData, az as CustomersUpdateResponse, aA as DdMandateRequestsGetData, aB as DdMandateRequestsGetResponse, aC as DdPreviewData, aD as DdPreviewResponse, aE as DdValidateData, aF as DdValidateResponse, aG as EntitlementsCheckData, aH as EntitlementsCheckResponse, aI as EntitlementsListData, aJ as EntitlementsListResponse, aK as EventsGetData, aL as EventsGetResponse, aM as EventsListData, aN as EventsListResponse, aO as EventsResendData, aP as EventsResendResponse, aQ as InvoicesCreateData, aR as InvoicesCreateResponse, aS as InvoicesFinalizeData, aT as InvoicesFinalizeResponse, aU as InvoicesGetData, aV as InvoicesGetResponse, aW as InvoicesListData, aX as InvoicesListResponse, aY as InvoicesMarginEstimateData, aZ as InvoicesMarginEstimateResponse, a_ as InvoicesSendData, a$ as InvoicesSendResponse, b0 as InvoicesUpdateData, b1 as InvoicesUpdateResponse, b2 as InvoicesVoidData, b3 as InvoicesVoidResponse, b4 as MandatesCancelData, b5 as MandatesCancelResponse, b6 as MandatesCreateData, b7 as MandatesCreateResponse, b8 as MandatesGetData, b9 as MandatesGetResponse, ba as MandatesListData, bb as MandatesListResponse, bc as MandatesReinstateData, bd as MandatesReinstateResponse, be as MandatesScheduleCollectionData, bf as MandatesScheduleCollectionResponse, bg as MandatesSuspendData, bh as MandatesSuspendResponse, bi as PaymentIntentsCancelData, bj as PaymentIntentsCancelResponse, bk as PaymentIntentsCaptureData, bl as PaymentIntentsCaptureResponse, bm as PaymentIntentsConfirmData, bn as PaymentIntentsConfirmResponse, bo as PaymentIntentsCreateData, bp as PaymentIntentsCreateResponse, bq as PaymentIntentsGetData, br as PaymentIntentsGetResponse, bs as PaymentIntentsListData, bt as PaymentIntentsListResponse, bu as PaymentLinksActivateData, bv as PaymentLinksActivateResponse, bw as PaymentLinksArchiveData, bx as PaymentLinksArchiveResponse, by as PaymentLinksCreateData, bz as PaymentLinksCreateResponse, bA as PaymentLinksDeactivateData, bB as PaymentLinksDeactivateResponse, bC as PaymentLinksExpireData, bD as PaymentLinksExpireResponse, bE as PaymentLinksGetData, bF as PaymentLinksGetResponse, bG as PaymentLinksListData, bH as PaymentLinksListResponse, bI as PaymentLinksUpdateData, bJ as PaymentLinksUpdateResponse, bK as PricesArchiveData, bL as PricesArchiveResponse, bM as PricesCreateData, bN as PricesCreateResponse, bO as PricesGetData, bP as PricesGetResponse, bQ as PricesListData, bR as PricesListResponse, bS as PricesUpdateData, bT as PricesUpdateResponse, bU as ProductsCreateData, bV as ProductsCreateResponse, bW as ProductsGetData, bX as ProductsGetResponse, bY as ProductsListData, bZ as ProductsListResponse, b_ as ProductsUpdateData, b$ as ProductsUpdateResponse, c0 as RefundsCreateData, c1 as RefundsCreateResponse, c2 as RefundsGetData, c3 as RefundsGetResponse, c4 as RefundsListData, c5 as RefundsListResponse, c6 as StorefrontOriginsCreateData, c7 as StorefrontOriginsCreateResponse, c8 as StorefrontOriginsDeleteData, c9 as StorefrontOriginsDeleteResponse, ca as StorefrontOriginsListResponse, cb as StorefrontProductsGetData, cc as StorefrontProductsGetResponse, cd as StorefrontProductsListData, ce as StorefrontProductsListResponse, cf as StorefrontStatusGetResponse, cg as SubscriptionsCancelData, ch as SubscriptionsCancelResponse, ci as SubscriptionsCreateData, cj as SubscriptionsCreateResponse, ck as SubscriptionsGetData, cl as SubscriptionsGetResponse, cm as SubscriptionsListData, cn as SubscriptionsListResponse, co as SubscriptionsUpdateData, cp as SubscriptionsUpdateResponse, cq as TransactionsGetData, cr as TransactionsGetResponse, cs as TransactionsListData, ct as TransactionsListResponse, cu as WebhookDeliveriesGetData, cv as WebhookDeliveriesGetResponse, cw as WebhookDeliveriesListData, cx as WebhookDeliveriesListResponse, cy as WebhookDeliveriesRetryData, cz as WebhookDeliveriesRetryResponse, cA as WebhookEndpointsCreateData, cB as WebhookEndpointsCreateResponse, cC as WebhookEndpointsDeleteData, cD as WebhookEndpointsDeleteResponse, cE as WebhookEndpointsGetData, cF as WebhookEndpointsGetResponse, cG as WebhookEndpointsListData, cH as WebhookEndpointsListResponse, cI as WebhookEndpointsRotateSecretData, cJ as WebhookEndpointsRotateSecretResponse, cK as WebhookEndpointsUpdateData, cL as WebhookEndpointsUpdateResponse, cM as UsageIngestRequest, B as BatchIngestResult, cN as DryRunResult, cO as AccountingInvoicePaymentRequestsCreateResponses, cP as AccountingInvoicePaymentRequestsCreateErrors, cQ as AccountingInvoicePaymentRequestsGetResponses, cR as AccountingInvoicePaymentRequestsGetErrors, cS as AnalyticsRevenueMrrSummaryResponses, cT as AnalyticsRevenueTimeSeriesResponses, cU as CartApiKeysEnsureData, cV as CartApiKeysEnsureResponses, cW as CartApiKeysEnsureErrors, cX as CartApiKeysRotateResponses, cY as CartApiKeysRotateErrors, cZ as CartApiKeysStatusData, c_ as CartApiKeysStatusResponses, c$ as CartApiKeysStatusErrors, d0 as CartSessionsAddLineItemResponses, d1 as CartSessionsAddLineItemErrors, d2 as CartSessionsApplyDiscountCodeResponses, d3 as CartSessionsApplyDiscountCodeErrors, d4 as CartSessionsConvertResponses, d5 as CartSessionsConvertErrors, d6 as CartSessionsCreateResponses, d7 as CartSessionsCreateErrors, d8 as CartSessionsGetResponses, d9 as CartSessionsGetErrors, da as CartSessionsRemoveLineItemResponses, db as CartSessionsRemoveLineItemErrors, dc as CartSessionsSetContactResponses, dd as CartSessionsSetContactErrors, de as CartSessionsToggleAddOnResponses, df as CartSessionsToggleAddOnErrors, dg as CartSessionsUpdateLineItemResponses, dh as CartSessionsUpdateLineItemErrors, di as CheckoutSessionsCreateResponses, dj as CheckoutSessionsCreateErrors, dk as CheckoutSessionsExpireResponses, dl as CheckoutSessionsExpireErrors, dm as CheckoutSessionsGetResponses, dn as CheckoutSessionsGetErrors, dp as CreditNotesCreateResponses, dq as CreditNotesCreateErrors, dr as CreditNotesGetResponses, ds as CreditNotesGetErrors, dt as CreditNotesListResponses, du as CreditNotesListErrors, dv as CreditNotesListLinesResponses, dw as CreditNotesListLinesErrors, dx as CreditNotesPreviewResponses, dy as CreditNotesPreviewErrors, dz as CreditNotesVoidResponses, dA as CreditNotesVoidErrors, dB as CustomerMetersGetResponses, dC as CustomerMetersGetErrors, dD as CustomerMetersListResponses, dE as CustomerMetersListErrors, dF as CustomerPortalCustomerGetData, dG as CustomerPortalCustomerGetResponses, dH as CustomerPortalCustomerGetErrors, dI as CustomerPortalInvoicesGetResponses, dJ as CustomerPortalInvoicesGetErrors, dK as CustomerPortalInvoicesListResponses, dL as CustomerPortalInvoicesListErrors, dM as CustomerPortalMandatesCancelResponses, dN as CustomerPortalMandatesCancelErrors, dO as CustomerPortalMandatesListData, dP as CustomerPortalMandatesListResponses, dQ as CustomerPortalMandatesListErrors, dR as CustomerPortalMandatesReauthorizeResponses, dS as CustomerPortalMandatesReauthorizeErrors, dT as CustomerPortalMandatesReauthorizeSendOtpResponses, dU as CustomerPortalMandatesReauthorizeSendOtpErrors, dV as CustomerPortalMandatesReauthorizeVerifyOtpResponses, dW as CustomerPortalMandatesReauthorizeVerifyOtpErrors, dX as CustomerPortalSessionsCreateResponses, dY as CustomerPortalSessionsCreateErrors, dZ as CustomerPortalSubscriptionsCancelResponses, d_ as CustomerPortalSubscriptionsCancelErrors, d$ as CustomerPortalSubscriptionsGetResponses, e0 as CustomerPortalSubscriptionsGetErrors, e1 as CustomerPortalSubscriptionsListResponses, e2 as CustomerPortalSubscriptionsListErrors, e3 as CustomersCreateResponses, e4 as CustomersCreateErrors, e5 as CustomersGetResponses, e6 as CustomersGetErrors, e7 as CustomersListResponses, e8 as CustomersListErrors, e9 as CustomersPaymentMethodsListResponses, ea as CustomersPaymentMethodsListErrors, eb as CustomersPaymentRailsGetResponses, ec as CustomersPaymentRailsGetErrors, ed as CustomersPreferredRailsGetResponses, ee as CustomersPreferredRailsGetErrors, ef as CustomersUpdateResponses, eg as CustomersUpdateErrors, eh as DdMandateRequestsGetResponses, ei as DdMandateRequestsGetErrors, ej as DdPreviewResponses, ek as DdPreviewErrors, el as DdValidateResponses, em as DdValidateErrors, en as EntitlementsCheckResponses, eo as EntitlementsCheckErrors, ep as EntitlementsListResponses, eq as EntitlementsListErrors, er as EventsGetResponses, es as EventsGetErrors, et as EventsListResponses, eu as EventsListErrors, ev as EventsResendResponses, ew as EventsResendErrors, ex as InvoicesCreateResponses, ey as InvoicesFinalizeResponses, ez as InvoicesFinalizeErrors, eA as InvoicesGetResponses, eB as InvoicesListResponses, eC as InvoicesMarginEstimateResponses, eD as InvoicesMarginEstimateErrors, eE as InvoicesSendResponses, eF as InvoicesSendErrors, eG as InvoicesUpdateResponses, eH as InvoicesVoidResponses, eI as InvoicesVoidErrors, eJ as MandatesCancelResponses, eK as MandatesCancelErrors, eL as MandatesCreateResponses, eM as MandatesCreateErrors, eN as MandatesGetResponses, eO as MandatesGetErrors, eP as MandatesListResponses, eQ as MandatesListErrors, eR as MandatesReinstateResponses, eS as MandatesReinstateErrors, eT as MandatesScheduleCollectionResponses, eU as MandatesScheduleCollectionErrors, eV as MandatesSuspendResponses, eW as MandatesSuspendErrors, eX as PaymentIntentsCancelResponses, eY as PaymentIntentsCancelErrors, eZ as PaymentIntentsCaptureResponses, e_ as PaymentIntentsCaptureErrors, e$ as PaymentIntentsConfirmResponses, f0 as PaymentIntentsConfirmErrors, f1 as PaymentIntentsCreateResponses, f2 as PaymentIntentsCreateErrors, f3 as PaymentIntentsGetResponses, f4 as PaymentIntentsGetErrors, f5 as PaymentIntentsListResponses, f6 as PaymentIntentsListErrors, f7 as PaymentLinksActivateResponses, f8 as PaymentLinksActivateErrors, f9 as PaymentLinksArchiveResponses, fa as PaymentLinksArchiveErrors, fb as PaymentLinksCreateResponses, fc as PaymentLinksCreateErrors, fd as PaymentLinksDeactivateResponses, fe as PaymentLinksDeactivateErrors, ff as PaymentLinksExpireResponses, fg as PaymentLinksExpireErrors, fh as PaymentLinksGetResponses, fi as PaymentLinksGetErrors, fj as PaymentLinksListResponses, fk as PaymentLinksListErrors, fl as PaymentLinksUpdateResponses, fm as PaymentLinksUpdateErrors, fn as PricesArchiveResponses, fo as PricesArchiveErrors, fp as PricesCreateResponses, fq as PricesCreateErrors, fr as PricesGetResponses, fs as PricesGetErrors, ft as PricesListResponses, fu as PricesListErrors, fv as PricesUpdateResponses, fw as PricesUpdateErrors, fx as ProductsCreateResponses, fy as ProductsCreateErrors, fz as ProductsGetResponses, fA as ProductsGetErrors, fB as ProductsListResponses, fC as ProductsListErrors, fD as ProductsUpdateResponses, fE as ProductsUpdateErrors, fF as RefundsCreateResponses, fG as RefundsCreateErrors, fH as RefundsGetResponses, fI as RefundsGetErrors, fJ as RefundsListResponses, fK as RefundsListErrors, fL as StorefrontOriginsCreateResponses, fM as StorefrontOriginsCreateErrors, fN as StorefrontOriginsDeleteResponses, fO as StorefrontOriginsDeleteErrors, fP as StorefrontOriginsListData, fQ as StorefrontOriginsListResponses, fR as StorefrontOriginsListErrors, fS as StorefrontProductsGetResponses, fT as StorefrontProductsGetErrors, fU as StorefrontProductsListResponses, fV as StorefrontProductsListErrors, fW as StorefrontStatusGetData, fX as StorefrontStatusGetResponses, fY as StorefrontStatusGetErrors, fZ as SubscriptionsCancelResponses, f_ as SubscriptionsCancelErrors, f$ as SubscriptionsCreateResponses, g0 as SubscriptionsCreateErrors, g1 as SubscriptionsGetResponses, g2 as SubscriptionsGetErrors, g3 as SubscriptionsListResponses, g4 as SubscriptionsListErrors, g5 as SubscriptionsUpdateResponses, g6 as SubscriptionsUpdateErrors, g7 as TransactionsGetResponses, g8 as TransactionsGetErrors, g9 as TransactionsListResponses, ga as TransactionsListErrors, gb as WebhookDeliveriesGetResponses, gc as WebhookDeliveriesGetErrors, gd as WebhookDeliveriesListResponses, ge as WebhookDeliveriesListErrors, gf as WebhookDeliveriesRetryResponses, gg as WebhookDeliveriesRetryErrors, gh as WebhookEndpointsCreateResponses, gi as WebhookEndpointsCreateErrors, gj as WebhookEndpointsDeleteResponses, gk as WebhookEndpointsDeleteErrors, gl as WebhookEndpointsGetResponses, gm as WebhookEndpointsGetErrors, gn as WebhookEndpointsListResponses, go as WebhookEndpointsListErrors, gp as WebhookEndpointsRotateSecretResponses, gq as WebhookEndpointsRotateSecretErrors, gr as WebhookEndpointsUpdateResponses, gs as WebhookEndpointsUpdateErrors } from './types.gen-C_v7ucau.mjs'; export { gt as AccountingInvoicePaymentRequest, gu as AccountingInvoicePaymentRequestsCreateError, gv as AccountingInvoicePaymentRequestsGetError, gw as ApplyCartDiscountCodeInput, gx as AttachPaymentMethodRequest, gy as AuthenticationError, gz as AvsCodeInterpretation, gA as BacsDirectDebitDetails, gB as BankAccountDetails, gC as BatchIngestRequest, gD as Benefit, gE as BillingAnchorRulesResponse, gF as BillingDetails, gG as BillingIntervalsResponse, gH as BillingPreviewErrorResponse, gI as BillingPreviewResponse, gJ as Business, gK as CancelOrderRequest, gL as CancelPaymentIntentRequest, gM as CancelPaymentRequest, gN as CancelSetupIntentRequest, gO as CancelSubscriptionInput, gP as CancelSubscriptionRequest, gQ as CancelSubscriptionScheduleRequest, gR as CapturePaymentIntentRequest, gS as CapturePaymentRequest, gT as CardDetails, gU as CartApiKeysEnsureError, gV as CartApiKeysRotateError, gW as CartApiKeysStatusError, gX as CartBillingAnchorRule, gY as CartCheckoutSession, gZ as CartConversionResponse, g_ as CartLineItem, g$ as CartLineItemInput, h0 as CartLineItemRecurring, h1 as CartSession, h2 as CartSessionErrorResponse, h3 as CartSessionResponse, h4 as CartSessionStatus, h5 as CartSessionsAddLineItemError, h6 as CartSessionsApplyDiscountCodeError, h7 as CartSessionsConvertError, h8 as CartSessionsCreateError, h9 as CartSessionsGetError, ha as CartSessionsRemoveLineItemError, hb as CartSessionsSetContactError, hc as CartSessionsToggleAddOnError, hd as CartSessionsUpdateLineItemError, he as CartStartRule, hf as ChargeCaptureResponse, hg as ChargeCreateResponse, hh as ChargeDuplicateErrorResponse, hi as ChargeErrorResponse, hj as ChargeListResponse, hk as ChargeRefundResponse, hl as ChargeRetrieveResponse, hm as CheckoutSession, hn as CheckoutSessionCreateResponse, ho as CheckoutSessionErrorResponse, hp as CheckoutSessionExpireResponse, hq as CheckoutSessionRetrieveResponse, hr as CheckoutSessionsCreateError, hs as CheckoutSessionsExpireError, ht as CheckoutSessionsGetError, hu as ClientOptions, hv as CollectionSchedule, hw as ConfirmPaymentIntentRequest, hx as ConfirmSetupIntentRequest, hy as CreateAccountingInvoicePaymentRequestInput, hz as CreateCartSessionInput, hA as CreateCheckoutSessionInput, hB as CreateCreditNoteInput, hC as CreateCustomerPortalSessionRequest, hD as CreateDiscountInput, hE as CreateExportRequest, hF as CreateImportRequest, hG as CreateMandateRequest, hH as CreateMeterPriceRequest, hI as CreateMeterRequest, hJ as CreateMeterResponse, hK as CreateOrderRequest, hL as CreatePaymentIntentRequest, hM as CreatePriceRequest, hN as CreateProductRequest, hO as CreateRefundInput, hP as CreateSetupIntentRequest, hQ as CreateSubscriptionItemInput, hR as CreateSubscriptionScheduleRequest, hS as CreateTaxRateRequest, hT as CreateTerminalPaymentRequest, hU as CreateTestEventRequest, hV as CreateVoidInput, hW as CreditEligibilityResponse, hX as CreditNote, hY as CreditNoteCreateResponse, hZ as CreditNoteEligibilityResponse, h_ as CreditNoteLine, h$ as CreditNoteLineList, i0 as CreditNoteListResponse, i1 as CreditNotePreview, i2 as CreditNotePreviewResponse, i3 as CreditNoteResponse, i4 as CreditNoteRetrieveResponse, i5 as CreditNoteVoidResponse, i6 as CustomerCreateResponse, i7 as CustomerInvoice, i8 as CustomerListResponse, i9 as CustomerMeter, ia as CustomerMeterErrorResponse, ib as CustomerMeterList, ic as CustomerMeterResponse, id as CustomerMetersGetError, ie as CustomerMetersListError, ig as CustomerOrder, ih as CustomerPayment, ii as CustomerPaymentMethodsListResponse, ij as CustomerPortalCustomerGetError, ik as CustomerPortalErrorResponse, il as CustomerPortalInvoicesGetError, im as CustomerPortalInvoicesListError, io as CustomerPortalMandatesCancelError, ip as CustomerPortalMandatesListError, iq as CustomerPortalMandatesReauthorizeError, ir as CustomerPortalMandatesReauthorizeSendOtpError, is as CustomerPortalMandatesReauthorizeVerifyOtpError, it as CustomerPortalSessionCreateResponse, iu as CustomerPortalSessionsCreateError, iv as CustomerPortalSubscriptionsCancelError, iw as CustomerPortalSubscriptionsGetError, ix as CustomerPortalSubscriptionsListError, iy as CustomerRetrieveResponse, iz as CustomerSubscription, iA as CustomerUpdateResponse, iB as CvvCodeInterpretation, iC as DdCaptureSession, iD as DdCaptureSessionResponse, iE as DdMandatePdfReference, iF as DdMandateRequestActiveResponse, iG as DdMandateRequestCancelResponse, iH as DdMandateRequestConsumeResponse, iI as DdMandateRequestCreateResponse, iJ as DdMandateRequestHistoryResponse, iK as DdMandateRequestLifecycleItem, iL as DdMandateRequestLifecycleStatus, iM as DeclineAnalyticsResponse, iN as Discount, iO as DiscountCreateResponse, iP as DiscountDeleteResponse, iQ as DiscountListResponse, iR as DiscountRetrieveResponse, iS as DiscountUpdateResponse, iT as Dispute, iU as Entitlement, iV as EntitlementCheck, iW as EntitlementCheckResponse, iX as EntitlementListResponse, iY as ErrorResponse, iZ as Event, i_ as EventErrorResponse, i$ as EventListResponse, j0 as EventRequest, j1 as EventsGetError, j2 as EventsListError, j3 as EventsResendError, j4 as Export, j5 as ExportCreateResponse, j6 as ExportRetrieveResponse, j7 as ExternalUpsertResponse, j8 as ForbiddenError, j9 as FulfillOrderRequest, ja as Import, jb as ImportCreateResponse, jc as ImportRetrieveResponse, jd as Invoice, je as InvoiceCommentDetail, jf as InvoiceCommentDetailResponse, jg as InvoiceCommentListDetailResponse, jh as InvoiceListResponse, ji as InvoiceResponse, jj as Mandate, jk as MandateActionRequest, jl as MandateActionResponse, jm as MandateListItem, jn as MandateListResponse, jo as MandateRequestLookupResponse, jp as MandateResponse, jq as MarkDeliveredResponse, jr as MeterError, js as MeterGetResponse, jt as MeterListResponse, ju as MeterPriceError, jv as MeterPriceListResponse, jw as MeterPriceResponse, jx as MeterPriceTierInput, jy as NotFoundError, jz as OpenDispute, jA as Order, jB as OrderErrorResponse, jC as OrderLineItem, jD as OrderListResponse, jE as Pagination, jF as PauseSubscriptionInput, jG as PayOrderRequest, jH as Payment, jI as PaymentAttempt, jJ as PaymentAttemptErrorResponse, jK as PaymentAttemptListResponse, jL as PaymentAttemptSingleResponse, jM as PaymentErrorResponse, jN as PaymentIntent, jO as PaymentIntentErrorResponse, jP as PaymentIntentListResponse, jQ as PaymentIntentsCancelError, jR as PaymentIntentsCaptureError, jS as PaymentIntentsConfirmError, jT as PaymentIntentsCreateError, jU as PaymentIntentsGetError, jV as PaymentIntentsListError, jW as PaymentLinksActivateError, jX as PaymentLinksArchiveError, jY as PaymentLinksCreateError, jZ as PaymentLinksDeactivateError, j_ as PaymentLinksExpireError, j$ as PaymentLinksGetError, k0 as PaymentLinksListError, k1 as PaymentLinksUpdateError, k2 as PaymentListResponse, k3 as PaymentMethod, k4 as PaymentMethodList, k5 as PaymentSecurityResponse, k6 as PaymentSecurityResult, k7 as Payout, k8 as PayoutPayment, k9 as PhaseItem, ka as PortalCustomer, kb as PortalCustomerResponse, kc as PortalInvoice, kd as PortalInvoiceList, ke as PortalInvoiceResponse, kf as PortalMandate, kg as PortalMandateList, kh as PortalReauthorizeMandateRequest, ki as PortalReauthorizeMandateResponse, kj as PortalReauthorizeSendOtpResponse, kk as PortalReauthorizeVerifyOtpRequest, kl as PortalReauthorizeVerifyOtpResponse, km as PortalSubscription, kn as PortalSubscriptionCancelResponse, ko as PortalSubscriptionList, kp as PortalSubscriptionResponse, kq as PreviewCollectionRequest, kr as PreviewCollectionResponse, ks as PreviewCreditNoteInput, kt as Price, ku as PriceErrorResponse, kv as PriceListResponse, kw as PriceTier, kx as PricesArchiveError, ky as PricesCreateError, kz as PricesGetError, kA as PricesListError, kB as PricesUpdateError, kC as Product, kD as ProductCreateResponse, kE as ProductErrorResponse, kF as ProductListResponse, kG as ProductRetrieveResponse, kH as ProductUpdateResponse, kI as ProductsCreateError, kJ as ProductsGetError, kK as ProductsListError, kL as ProductsUpdateError, kM as Refund, kN as RefundCreateResponse, kO as RefundListResponse, kP as RefundRetrieveResponse, kQ as RefundTerminalPaymentRequest, kR as ReleaseSubscriptionScheduleRequest, kS as ResendWebhookResponse, kT as RetryEligibilityResponse, kU as ScheduleCollectionRequest, kV as ScheduleCollectionResponse, kW as SchedulePhase, kX as SetCartContactInput, kY as SetupIntent, kZ as SetupIntentError, k_ as SetupIntentList, k$ as SetupIntentNextAction, l0 as StaleUpdateResponse, l1 as StorefrontAvailability, l2 as StorefrontKeyStatus, l3 as StorefrontOrigin, l4 as StorefrontOriginCreateRequest, l5 as StorefrontOriginCreateResponse, l6 as StorefrontOriginDeleteResponse, l7 as StorefrontOriginError, l8 as StorefrontOriginListResponse, l9 as StorefrontOriginsCreateError, la as StorefrontOriginsDeleteError, lb as StorefrontOriginsListError, lc as StorefrontPrice, ld as StorefrontProduct, le as StorefrontProductError, lf as StorefrontProductListResponse, lg as StorefrontProductResponse, lh as StorefrontProductsGetError, li as StorefrontProductsListError, lj as StorefrontStatus, lk as StorefrontStatusCheck, ll as StorefrontStatusError, lm as StorefrontStatusGetError, ln as StorefrontStatusResponse, lo as Subscription, lp as SubscriptionCancelResponse, lq as SubscriptionCancelSubscriptionResponse, lr as SubscriptionChangePlanResponse, ls as SubscriptionChangeQuantityResponse, lt as SubscriptionCreateResponse, lu as SubscriptionItem, lv as SubscriptionItemCreateResponse, lw as SubscriptionItemDeleteResponse, lx as SubscriptionItemListResponse, ly as SubscriptionItemUpdateResponse, lz as SubscriptionListResponse, lA as SubscriptionPauseResponse, lB as SubscriptionPreviewRenewalResponse, lC as SubscriptionReactivateResponse, lD as SubscriptionResumeResponse, lE as SubscriptionRetrieveResponse, lF as SubscriptionSchedule, lG as SubscriptionScheduleErrorResponse, lH as SubscriptionScheduleListResponse, lI as SubscriptionTerms, lJ as SubscriptionUpdateResponse, lK as SuccessResponse, lL as TaxRate, lM as TaxRateErrorResponse, lN as TaxRateListResponse, lO as TerminalDevice, lP as TerminalDeviceErrorResponse, lQ as TerminalDeviceListResponse, lR as TerminalDeviceResponse, lS as TerminalPayment, lT as TerminalPaymentErrorResponse, lU as TerminalPaymentListResponse, lV as TerminalPaymentResponse, lW as TestEventResponse, lX as ToggleCartAddOnInput, lY as Transaction, lZ as TransactionListResponse, l_ as TransactionRetrieveResponse, l$ as TransactionReversalEligibilityResponse, m0 as TransactionsGetError, m1 as TransactionsListError, m2 as TransformQuantity, m3 as UnchangedContentResponse, m4 as UpdateCartLineItemInput, m5 as UpdateDiscountInput, m6 as UpdateMeterPriceRequest, m7 as UpdateMeterRequest, m8 as UpdateMeterResponse, m9 as UpdateOrderRequest, ma as UpdatePaymentIntentRequest, mb as UpdatePaymentMethodRequest, mc as UpdatePriceRequest, md as UpdateProductRequest, me as UpdateSetupIntentRequest, mf as UpdateSubscriptionItemInput, mg as UpdateSubscriptionScheduleRequest, mh as UpdateTaxRateRequest, mi as UsageAggregateResponse, mj as UsageBalanceMeter, mk as UsageBalanceResponse, U as UsageEvent, ml as UsageEventError, mm as UsageEventListResponse, mn as UsageEventRecord, mo as ValidateBankAccountRequest, mp as ValidateBankAccountResponse, mq as ValidationError, mr as Void, ms as VoidCreateResponse, mt as VoidListResponse, mu as VoidRetrieveResponse, mv as VoidTerminalPaymentRequest, mw as WebhookDeliveriesGetError, mx as WebhookDeliveriesListError, my as WebhookDeliveriesRetryError, mz as WebhookDelivery, mA as WebhookDeliveryErrorResponse, mB as WebhookDeliveryListResponse, mC as WebhookDeliveryResponse, mD as WebhookDeliveryRetryResponse, mE as WebhookEndpoint, mF as WebhookEvent, mG as Webhooks, mH as WebhooksCheckoutSessionCompletedWebhookPayload, mI as WebhooksCheckoutSessionCompletedWebhookRequest, mJ as WebhooksCheckoutSessionExpiredWebhookPayload, mK as WebhooksCheckoutSessionExpiredWebhookRequest, mL as WebhooksCollectionFailedWebhookPayload, mM as WebhooksCollectionFailedWebhookRequest, mN as WebhooksCollectionIndemnityClaimedWebhookPayload, mO as WebhooksCollectionIndemnityClaimedWebhookRequest, mP as WebhooksCollectionNoticeSentWebhookPayload, mQ as WebhooksCollectionNoticeSentWebhookRequest, mR as WebhooksCollectionScheduledWebhookPayload, mS as WebhooksCollectionScheduledWebhookRequest, mT as WebhooksCollectionSucceededWebhookPayload, mU as WebhooksCollectionSucceededWebhookRequest, mV as WebhooksCreditNoteCreatedWebhookPayload, mW as WebhooksCreditNoteCreatedWebhookRequest, mX as WebhooksCreditNoteIssuedWebhookPayload, mY as WebhooksCreditNoteIssuedWebhookRequest, mZ as WebhooksCreditNoteVoidedWebhookPayload, m_ as WebhooksCreditNoteVoidedWebhookRequest, m$ as WebhooksCustomerCreatedWebhookPayload, n0 as WebhooksCustomerCreatedWebhookRequest, n1 as WebhooksCustomerUpdatedWebhookPayload, n2 as WebhooksCustomerUpdatedWebhookRequest, n3 as WebhooksInvoiceCreatedWebhookPayload, n4 as WebhooksInvoiceCreatedWebhookRequest, n5 as WebhooksInvoiceOverdueWebhookPayload, n6 as WebhooksInvoiceOverdueWebhookRequest, n7 as WebhooksInvoicePaidWebhookPayload, n8 as WebhooksInvoicePaidWebhookRequest, n9 as WebhooksMandateActivatedWebhookPayload, na as WebhooksMandateActivatedWebhookRequest, nb as WebhooksMandateAuddisRejectedWebhookPayload, nc as WebhooksMandateAuddisRejectedWebhookRequest, nd as WebhooksMandateCancelledWebhookPayload, ne as WebhooksMandateCancelledWebhookRequest, nf as WebhooksMandateCreatedWebhookPayload, ng as WebhooksMandateCreatedWebhookRequest, nh as WebhooksMandateSuspendedWebhookPayload, ni as WebhooksMandateSuspendedWebhookRequest, nj as WebhooksMeterArchivedWebhookPayload, nk as WebhooksMeterArchivedWebhookRequest, nl as WebhooksMeterCreatedWebhookPayload, nm as WebhooksMeterCreatedWebhookRequest, nn as WebhooksMeterPriceCreatedWebhookPayload, no as WebhooksMeterPriceCreatedWebhookRequest, np as WebhooksMeterPriceDeactivatedWebhookPayload, nq as WebhooksMeterPriceDeactivatedWebhookRequest, nr as WebhooksMeterPriceUpdatedWebhookPayload, ns as WebhooksMeterPriceUpdatedWebhookRequest, nt as WebhooksMeterUpdatedWebhookPayload, nu as WebhooksMeterUpdatedWebhookRequest, nv as WebhooksOrderCreatedWebhookPayload, nw as WebhooksOrderCreatedWebhookRequest, nx as WebhooksOrderFulfilledWebhookPayload, ny as WebhooksOrderFulfilledWebhookRequest, nz as WebhooksOrderPaidWebhookPayload, nA as WebhooksOrderPaidWebhookRequest, nB as WebhooksPaymentFailedWebhookPayload, nC as WebhooksPaymentFailedWebhookRequest, nD as WebhooksPaymentSucceededWebhookPayload, nE as WebhooksPaymentSucceededWebhookRequest, nF as WebhooksRefundCreatedWebhookPayload, nG as WebhooksRefundCreatedWebhookRequest, nH as WebhooksRefundSucceededWebhookPayload, nI as WebhooksRefundSucceededWebhookRequest, nJ as WebhooksSettlementCreatedWebhookPayload, nK as WebhooksSettlementCreatedWebhookRequest, nL as WebhooksSubscriptionActivatedWebhookPayload, nM as WebhooksSubscriptionActivatedWebhookRequest, nN as WebhooksSubscriptionCanceledWebhookPayload, nO as WebhooksSubscriptionCanceledWebhookRequest, nP as WebhooksSubscriptionCreatedWebhookPayload, nQ as WebhooksSubscriptionCreatedWebhookRequest, nR as WebhooksSubscriptionRenewedWebhookPayload, nS as WebhooksSubscriptionRenewedWebhookRequest, nT as WebhooksTerminalPaymentCancelledWebhookPayload, nU as WebhooksTerminalPaymentCancelledWebhookRequest, nV as WebhooksTerminalPaymentDeclinedWebhookPayload, nW as WebhooksTerminalPaymentDeclinedWebhookRequest, nX as WebhooksTerminalPaymentErrorWebhookPayload, nY as WebhooksTerminalPaymentErrorWebhookRequest, nZ as WebhooksTerminalPaymentRequestedWebhookPayload, n_ as WebhooksTerminalPaymentRequestedWebhookRequest, n$ as WebhooksTerminalPaymentSucceededWebhookPayload, o0 as WebhooksTerminalPaymentSucceededWebhookRequest, o1 as WebhooksTerminalRefundSucceededWebhookPayload, o2 as WebhooksTerminalRefundSucceededWebhookRequest, o3 as WebhooksTerminalVoidSucceededWebhookPayload, o4 as WebhooksTerminalVoidSucceededWebhookRequest, o5 as WebhooksUsageEventIngestedWebhookPayload, o6 as WebhooksUsageEventIngestedWebhookRequest, o7 as WebhooksUsageEventRejectedWebhookPayload, o8 as WebhooksUsageEventRejectedWebhookRequest, o9 as WebhooksUsageInvoiceCreatedWebhookPayload, oa as WebhooksUsageInvoiceCreatedWebhookRequest, ob as WebhooksUsagePeriodFinalizedWebhookPayload, oc as WebhooksUsagePeriodFinalizedWebhookRequest, od as WebhooksUsageThresholdReachedWebhookPayload, oe as WebhooksUsageThresholdReachedWebhookRequest, of as WebhooksVoidCreatedWebhookPayload, og as WebhooksVoidCreatedWebhookRequest, oh as WebhooksVoidFailedWebhookPayload, oi as WebhooksVoidFailedWebhookRequest, oj as WebhooksVoidSucceededWebhookPayload, ok as WebhooksVoidSucceededWebhookRequest } from './types.gen-C_v7ucau.mjs'; import { OAuthConfig } from './auth.mjs'; export { OAuthTokenManager } from './auth.mjs'; export { WEBHOOK_TOLERANCE_IN_SECONDS, WebhookHeaders, WebhookSignatureVerificationError, WebhookEvent as WebhookUtilityEvent, WebhookEventData as WebhookUtilityEventData, WebhookEventType as WebhookUtilityEventType, WebhookVerifyOptions, constructEvent, constructEventWithHeaders, extractWebhookHeaders, verifySignature, default as webhooks } from './webhooks.mjs'; /** * AUTO-GENERATED FILE. DO NOT EDIT MANUALLY. * * Generated by: pnpm --dir packages/sdk generate:wrapper * Source of truth: packages/openapi/sdk-openapi.json */ interface GeneratedResourceRuntime { requestData(fn: (options: unknown) => Promise<{ data?: T; error?: unknown; }>, options?: Record): Promise; } interface AccountingResource { invoicePaymentRequestsCreate: (body?: NonNullable) => Promise; invoicePaymentRequestsGet: (id: NonNullable["id"]) => Promise; } interface AnalyticsResource { revenueMrrSummary: (query?: NonNullable) => Promise; revenueTimeSeries: (query?: NonNullable) => Promise; } interface CartResource { apiKeysEnsure: () => Promise; apiKeysRotate: (id: NonNullable["kind"], body?: NonNullable) => Promise; apiKeysStatus: () => Promise; sessionsAddLineItem: (id: NonNullable["id"], body?: NonNullable) => Promise; sessionsApplyDiscountCode: (id: NonNullable["id"], body?: NonNullable) => Promise; sessionsConvert: (id: NonNullable["id"]) => Promise; sessionsCreate: (body?: NonNullable) => Promise; sessionsGet: (id: NonNullable["id"]) => Promise; sessionsRemoveLineItem: (path: NonNullable) => Promise; sessionsSetContact: (id: NonNullable["id"], body?: NonNullable) => Promise; sessionsToggleAddOn: (id: NonNullable["id"], body?: NonNullable) => Promise; sessionsUpdateLineItem: (params: { path: NonNullable; body?: NonNullable; }) => Promise; } interface CheckoutSessionsResource { create: (body?: NonNullable) => Promise; expire: (id: NonNullable["id"]) => Promise; get: (id: NonNullable["id"]) => Promise; } interface CreditNotesResource { create: (body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; listLines: (id: NonNullable["id"], query?: NonNullable) => Promise; preview: (body: NonNullable) => Promise; void: (id: NonNullable["id"]) => Promise; } interface CustomerResource { metersGet: (path: NonNullable) => Promise; metersList: (query?: NonNullable) => Promise; portalCustomerGet: () => Promise; portalInvoicesGet: (id: NonNullable["id"]) => Promise; portalInvoicesList: (query?: NonNullable) => Promise; portalMandatesCancel: (id: NonNullable["id"], body?: NonNullable) => Promise; portalMandatesList: () => Promise; portalMandatesReauthorize: (id: NonNullable["id"], body: NonNullable) => Promise; portalMandatesReauthorizeSendOtp: (id: NonNullable["id"]) => Promise; portalMandatesReauthorizeVerifyOtp: (id: NonNullable["id"], body: NonNullable) => Promise; portalSessionsCreate: (body: NonNullable) => Promise; portalSubscriptionsCancel: (id: NonNullable["id"], body?: NonNullable) => Promise; portalSubscriptionsGet: (id: NonNullable["id"]) => Promise; portalSubscriptionsList: (query?: NonNullable) => Promise; } interface CustomersResource { create: (body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; paymentMethodsList: (id: NonNullable["id"]) => Promise; paymentRailsGet: (id: NonNullable["id"], query?: NonNullable) => Promise; preferredRailsGet: (id: NonNullable["id"], query?: NonNullable) => Promise; update: (id: NonNullable["id"], body?: NonNullable) => Promise; } interface DdResource { mandateRequestsGet: (id: NonNullable["token"]) => Promise; preview: (body?: NonNullable) => Promise; validate: (body?: NonNullable) => Promise; } interface EntitlementsResource { check: (query?: NonNullable) => Promise; list: (query?: NonNullable) => Promise; } interface EventsResource { get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; resend: (id: NonNullable["id"]) => Promise; } interface InvoicesResource { create: (body: NonNullable) => Promise; finalize: (id: NonNullable["id"], body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; marginEstimate: (id: NonNullable["id"], body: NonNullable) => Promise; send: (id: NonNullable["id"], body?: NonNullable) => Promise; update: (id: NonNullable["id"], body: NonNullable) => Promise; void: (id: NonNullable["id"], body?: NonNullable) => Promise; } interface MandatesResource { cancel: (id: NonNullable["id"], body?: NonNullable) => Promise; create: (body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; reinstate: (id: NonNullable["id"], body?: NonNullable) => Promise; scheduleCollection: (id: NonNullable["id"], body?: NonNullable) => Promise; suspend: (id: NonNullable["id"], body?: NonNullable) => Promise; } interface PaymentIntentsResource { cancel: (id: NonNullable["id"], body?: NonNullable) => Promise; capture: (id: NonNullable["id"], body?: NonNullable) => Promise; confirm: (id: NonNullable["id"], body?: NonNullable) => Promise; create: (body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; } interface PaymentLinksResource { activate: (id: NonNullable["id"]) => Promise; archive: (id: NonNullable["id"]) => Promise; create: (body?: NonNullable) => Promise; deactivate: (id: NonNullable["id"]) => Promise; expire: (id: NonNullable["id"], body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; update: (id: NonNullable["id"], body?: NonNullable) => Promise; } interface PricesResource { archive: (id: NonNullable["id"]) => Promise; create: (body: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; update: (id: NonNullable["id"], body: NonNullable) => Promise; } interface ProductsResource { create: (body: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; update: (id: NonNullable["id"], body: NonNullable) => Promise; } interface RefundsResource { create: (body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; } interface StorefrontResource { originsCreate: (body?: NonNullable) => Promise; originsDelete: (id: NonNullable["originId"]) => Promise; originsList: () => Promise; productsGet: (id: NonNullable["productId"]) => Promise; productsList: (query?: NonNullable) => Promise; statusGet: () => Promise; } interface SubscriptionsResource { cancel: (id: NonNullable["id"], body?: NonNullable) => Promise; create: (body?: NonNullable) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; update: (id: NonNullable["id"], body?: NonNullable) => Promise; } interface TransactionsResource { get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; } interface WebhookResource { deliveriesGet: (id: NonNullable["id"]) => Promise; deliveriesList: (query?: NonNullable) => Promise; deliveriesRetry: (id: NonNullable["id"]) => Promise; } interface WebhookEndpointsResource { create: (body?: NonNullable) => Promise; delete: (id: NonNullable["id"]) => Promise; get: (id: NonNullable["id"]) => Promise; list: (query?: NonNullable) => Promise; rotateSecret: (id: NonNullable["id"]) => Promise; update: (id: NonNullable["id"], body?: NonNullable) => Promise; } interface GeneratedResources { accounting: AccountingResource; analytics: AnalyticsResource; cart: CartResource; checkoutSessions: CheckoutSessionsResource; creditNotes: CreditNotesResource; customer: CustomerResource; customers: CustomersResource; dd: DdResource; entitlements: EntitlementsResource; events: EventsResource; invoices: InvoicesResource; mandates: MandatesResource; paymentIntents: PaymentIntentsResource; paymentLinks: PaymentLinksResource; prices: PricesResource; products: ProductsResource; refunds: RefundsResource; storefront: StorefrontResource; subscriptions: SubscriptionsResource; transactions: TransactionsResource; webhook: WebhookResource; webhookEndpoints: WebhookEndpointsResource; } declare function buildGeneratedResources(runtime: GeneratedResourceRuntime): GeneratedResources; interface RevKeenClientOptions { apiKey?: string; oauth?: OAuthConfig; baseUrl?: string; timeout?: number; headers?: Record; fetch?: typeof fetch; } interface UsageResource { ingest: (body: UsageIngestRequest) => Promise; dryRun: (body: UsageIngestRequest) => Promise; } declare class RevKeenClient implements GeneratedResourceRuntime { private readonly generatedClient; readonly usage: UsageResource; constructor(options: RevKeenClientOptions); requestData(fn: (options: unknown) => Promise<{ data?: T; error?: unknown; }>, options?: Record): Promise; private postUsage; } interface RevKeenClient extends GeneratedResources { } declare class RevKeenError extends Error { constructor(message: string); } declare class RevKeenAPIError extends RevKeenError { readonly status: number; readonly body: unknown; constructor(status: number, message: string, body: unknown); } declare class RevKeenTimeoutError extends RevKeenError { constructor(message: string); } type AuthToken = string | undefined; interface Auth { /** * Which part of the request do we use to send the auth? * * @default 'header' */ in?: 'header' | 'query' | 'cookie'; /** * Header or query parameter name. * * @default 'Authorization' */ name?: string; scheme?: 'basic' | 'bearer'; type: 'apiKey' | 'http'; } interface SerializerOptions { /** * @default true */ explode: boolean; style: T; } type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; type ObjectStyle = 'form' | 'deepObject'; type QuerySerializer = (query: Record) => string; type BodySerializer = (body: unknown) => unknown; type QuerySerializerOptionsObject = { allowReserved?: boolean; array?: Partial>; object?: Partial>; }; type QuerySerializerOptions = QuerySerializerOptionsObject & { /** * Per-parameter serialization overrides. When provided, these settings * override the global array/object settings for specific parameter names. */ parameters?: Record; }; type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace'; type Client$1 = { /** * Returns the final request URL. */ buildUrl: BuildUrlFn; getConfig: () => Config; request: RequestFn; setConfig: (config: Config) => Config; } & { [K in HttpMethod]: MethodFn; } & ([SseFn] extends [never] ? { sse?: never; } : { sse: { [K in HttpMethod]: SseFn; }; }); interface Config$1 { /** * Auth token or a function returning auth token. The resolved value will be * added to the request payload as defined by its `security` array. */ auth?: ((auth: Auth) => Promise | AuthToken) | AuthToken; /** * A function for serializing request body parameter. By default, * {@link JSON.stringify()} will be used. */ bodySerializer?: BodySerializer | null; /** * An object containing any HTTP headers that you want to pre-populate your * `Headers` object with. * * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} */ headers?: RequestInit['headers'] | Record; /** * The request method. * * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} */ method?: Uppercase; /** * A function for serializing request query parameters. By default, arrays * will be exploded in form style, objects will be exploded in deepObject * style, and reserved characters are percent-encoded. * * This method will have no effect if the native `paramsSerializer()` Axios * API function is used. * * {@link https://swagger.io/docs/specification/serialization/#query View examples} */ querySerializer?: QuerySerializer | QuerySerializerOptions; /** * A function validating request data. This is useful if you want to ensure * the request conforms to the desired shape, so it can be safely sent to * the server. */ requestValidator?: (data: unknown) => Promise; /** * A function transforming response data before it's returned. This is useful * for post-processing data, e.g., converting ISO strings into Date objects. */ responseTransformer?: (data: unknown) => Promise; /** * A function validating response data. This is useful if you want to ensure * the response conforms to the desired shape, so it can be safely passed to * the transformers and returned to the user. */ responseValidator?: (data: unknown) => Promise; } type ServerSentEventsOptions = Omit & Pick & { /** * Fetch API implementation. You can use this option to provide a custom * fetch instance. * * @default globalThis.fetch */ fetch?: typeof fetch; /** * Implementing clients can call request interceptors inside this hook. */ onRequest?: (url: string, init: RequestInit) => Promise; /** * Callback invoked when a network or parsing error occurs during streaming. * * This option applies only if the endpoint returns a stream of events. * * @param error The error that occurred. */ onSseError?: (error: unknown) => void; /** * Callback invoked when an event is streamed from the server. * * This option applies only if the endpoint returns a stream of events. * * @param event Event streamed from the server. * @returns Nothing (void). */ onSseEvent?: (event: StreamEvent) => void; serializedBody?: RequestInit['body']; /** * Default retry delay in milliseconds. * * This option applies only if the endpoint returns a stream of events. * * @default 3000 */ sseDefaultRetryDelay?: number; /** * Maximum number of retry attempts before giving up. */ sseMaxRetryAttempts?: number; /** * Maximum retry delay in milliseconds. * * Applies only when exponential backoff is used. * * This option applies only if the endpoint returns a stream of events. * * @default 30000 */ sseMaxRetryDelay?: number; /** * Optional sleep function for retry backoff. * * Defaults to using `setTimeout`. */ sseSleepFn?: (ms: number) => Promise; url: string; }; interface StreamEvent { data: TData; event?: string; id?: string; retry?: number; } type ServerSentEventsResult = { stream: AsyncGenerator ? TData[keyof TData] : TData, TReturn, TNext>; }; type ErrInterceptor = (error: Err, response: Res, request: Req, options: Options) => Err | Promise; type ReqInterceptor = (request: Req, options: Options) => Req | Promise; type ResInterceptor = (response: Res, request: Req, options: Options) => Res | Promise; declare class Interceptors { fns: Array; clear(): void; eject(id: number | Interceptor): void; exists(id: number | Interceptor): boolean; getInterceptorIndex(id: number | Interceptor): number; update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false; use(fn: Interceptor): number; } interface Middleware { error: Interceptors>; request: Interceptors>; response: Interceptors>; } type ResponseStyle = 'data' | 'fields'; interface Config extends Omit, Config$1 { /** * Base URL for all requests made by this client. */ baseUrl?: T['baseUrl']; /** * Fetch API implementation. You can use this option to provide a custom * fetch instance. * * @default globalThis.fetch */ fetch?: typeof fetch; /** * Please don't use the Fetch client for Next.js applications. The `next` * options won't have any effect. * * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead. */ next?: never; /** * Return the response data parsed in a specified format. By default, `auto` * will infer the appropriate method from the `Content-Type` response header. * You can override this behavior with any of the {@link Body} methods. * Select `stream` if you don't want to parse response data at all. * * @default 'auto' */ parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text'; /** * Should we return only data or multiple fields (data, error, response, etc.)? * * @default 'fields' */ responseStyle?: ResponseStyle; /** * Throw an error instead of returning it in the response? * * @default false */ throwOnError?: T['throwOnError']; } interface RequestOptions extends Config<{ responseStyle: TResponseStyle; throwOnError: ThrowOnError; }>, Pick, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> { /** * Any body that you want to add to your request. * * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} */ body?: unknown; path?: Record; query?: Record; /** * Security mechanism(s) to use for the request. */ security?: ReadonlyArray; url: Url; } interface ResolvedRequestOptions extends RequestOptions { serializedBody?: string; } type RequestResult = ThrowOnError extends true ? Promise ? TData[keyof TData] : TData : { data: TData extends Record ? TData[keyof TData] : TData; request: Request; response: Response; }> : Promise ? TData[keyof TData] : TData) | undefined : ({ data: TData extends Record ? TData[keyof TData] : TData; error: undefined; } | { data: undefined; error: TError extends Record ? TError[keyof TError] : TError; }) & { request: Request; response: Response; }>; interface ClientOptions { baseUrl?: string; responseStyle?: ResponseStyle; throwOnError?: boolean; } type MethodFn = (options: Omit, 'method'>) => RequestResult; type SseFn = (options: Omit, 'method'>) => Promise>; type RequestFn = (options: Omit, 'method'> & Pick>, 'method'>) => RequestResult; type BuildUrlFn = ; query?: Record; url: string; }>(options: TData & Options$1) => string; type Client = Client$1 & { interceptors: Middleware; }; interface TDataShape { body?: unknown; headers?: unknown; path?: unknown; query?: unknown; url: string; } type OmitKeys = Pick>; type Options$1 = OmitKeys, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit); type Options = Options$1 & { /** * You can provide a client instance returned by `createClient()` instead of * individual options. This might be also useful if you want to implement a * custom client. */ client?: Client; /** * You can pass arbitrary values through the `meta` object. This can be * used to access values that aren't defined as part of the SDK function. */ meta?: Record; }; /** * List invoices * * List invoices with pagination and filtering. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `POST /invoices` — Create invoice * - `GET /invoices/{id}` — Get invoice * - `PATCH /invoices/{id}` — Update invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail * - `POST /invoices/{id}/refund` — Refund invoice * - `POST /invoices/{id}/reject` — Reject invoice * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const invoicesList: (options?: Options) => RequestResult; /** * Create invoice * * Create a new invoice. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `GET /invoices` — List invoices * - `GET /invoices/{id}` — Get invoice * - `PATCH /invoices/{id}` — Update invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail * - `POST /invoices/{id}/refund` — Refund invoice * - `POST /invoices/{id}/reject` — Reject invoice * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const invoicesCreate: (options: Options) => RequestResult; /** * Get invoice * * Get a single invoice by ID. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `GET /invoices` — List invoices * - `POST /invoices` — Create invoice * - `PATCH /invoices/{id}` — Update invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail * - `POST /invoices/{id}/refund` — Refund invoice * - `POST /invoices/{id}/reject` — Reject invoice */ declare const invoicesGet: (options: Options) => RequestResult; /** * Update invoice * * Update an existing invoice. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `GET /invoices` — List invoices * - `POST /invoices` — Create invoice * - `GET /invoices/{id}` — Get invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail * - `POST /invoices/{id}/refund` — Refund invoice * - `POST /invoices/{id}/reject` — Reject invoice * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const invoicesUpdate: (options: Options) => RequestResult; /** * Estimate invoice net by payment rail * * Estimate per-rail processing fees and net-after-fees for an invoice amount. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `GET /invoices` — List invoices * - `POST /invoices` — Create invoice * - `GET /invoices/{id}` — Get invoice * - `PATCH /invoices/{id}` — Update invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/refund` — Refund invoice * - `POST /invoices/{id}/reject` — Reject invoice * * **Common errors** * * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const invoicesMarginEstimate: (options: Options) => RequestResult; /** * Finalize an invoice * * Finalizes a draft invoice, locking it for payment. Assigns invoice number and generates public token. After finalization, financial fields become immutable. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `GET /invoices` — List invoices * - `POST /invoices` — Create invoice * - `GET /invoices/{id}` — Get invoice * - `PATCH /invoices/{id}` — Update invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail * - `POST /invoices/{id}/refund` — Refund invoice * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const invoicesFinalize: (options: Options) => RequestResult; /** * Void an invoice * * Voids an invoice. Only invoices without recorded payments can be voided. Use refund instead for paid invoices. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `GET /invoices` — List invoices * - `POST /invoices` — Create invoice * - `GET /invoices/{id}` — Get invoice * - `PATCH /invoices/{id}` — Update invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail * - `POST /invoices/{id}/refund` — Refund invoice * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const invoicesVoid: (options: Options) => RequestResult; /** * Send an invoice * * Sends an invoice to the customer via the specified channel (email, SMS, or WhatsApp). Invoice must be approved first. * * --- * * **Related endpoints** * * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID * - `GET /invoices` — List invoices * - `POST /invoices` — Create invoice * - `GET /invoices/{id}` — Get invoice * - `PATCH /invoices/{id}` — Update invoice * - `DELETE /invoices/{id}` — Delete invoice * - `POST /invoices/{id}/margin-estimate` — Estimate invoice net by payment rail * - `POST /invoices/{id}/refund` — Refund invoice * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const invoicesSend: (options: Options) => RequestResult; /** * List products * * List products with pagination and optional search. * * --- * * **Related endpoints** * * - `POST /products` — Create product * - `GET /products/{id}` — Get product by ID * - `PATCH /products/{id}` — Update product * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID * - `PUT /products/external/batch` — Batch upsert products by external ID * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const productsList: (options?: Options) => RequestResult; /** * Create product * * Create a new product. Requires 'products:write' scope. * * --- * * **Related endpoints** * * - `GET /products` — List products * - `GET /products/{id}` — Get product by ID * - `PATCH /products/{id}` — Update product * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID * - `PUT /products/external/batch` — Batch upsert products by external ID * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const productsCreate: (options: Options) => RequestResult; /** * Get product by ID * * Get a product by its ID. Requires 'products:read' scope. * * --- * * **Related endpoints** * * - `GET /products` — List products * - `POST /products` — Create product * - `PATCH /products/{id}` — Update product * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID * - `PUT /products/external/batch` — Batch upsert products by external ID * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const productsGet: (options: Options) => RequestResult; /** * Update product * * Update an existing product. Requires 'products:write' scope. * * --- * * **Related endpoints** * * - `GET /products` — List products * - `POST /products` — Create product * - `GET /products/{id}` — Get product by ID * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID * - `PUT /products/external/batch` — Batch upsert products by external ID * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const productsUpdate: (options: Options) => RequestResult; /** * Create a checkout session * * Create a checkout session for an invoice or product. * * --- * * **Related endpoints** * * - `GET /checkout-sessions/{id}` — Retrieve a checkout session * - `POST /checkout-sessions/{id}/expire` — Expire a checkout session * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const checkoutSessionsCreate: (options?: Options) => RequestResult; /** * Retrieve a checkout session * * Retrieve a checkout session by its ID. * * --- * * **Related endpoints** * * - `POST /checkout-sessions` — Create a checkout session * - `POST /checkout-sessions/{id}/expire` — Expire a checkout session * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const checkoutSessionsGet: (options: Options) => RequestResult; /** * Expire a checkout session * * Manually expire an open checkout session. Only sessions with status 'open' or 'pending' and no active payment attempt can be expired. * * --- * * **Related endpoints** * * - `POST /checkout-sessions` — Create a checkout session * - `GET /checkout-sessions/{id}` — Retrieve a checkout session * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const checkoutSessionsExpire: (options: Options) => RequestResult; /** * Create a cart session * * Create an empty (or pre-populated) cart session. The returned cart is `open` and mutable until it is converted into a checkout session, or until it is swept to `abandoned` / `expired`. * * --- * * **Related endpoints** * * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/convert` — Convert to a checkout session * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). * * --- * * **Related endpoints** * * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `422 unprocessable_entity` — business-rule failure (for example, refunding more than the original charge). * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsCreate: (options?: Options) => RequestResult; /** * Retrieve a cart session * * Fetch the current state of a cart session by id. Returns the same shape as the create response. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const cartSessionsGet: (options: Options) => RequestResult; /** * Add a line item to a cart session * * Append a line item to an open cart session. Subtotals are recomputed atomically; the updated cart is returned. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsAddLineItem: (options: Options) => RequestResult; /** * Remove a line item from a cart session * * Remove a line item from an open cart. Subtotals are recomputed; the updated cart is returned. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsRemoveLineItem: (options: Options) => RequestResult; /** * Update a line item's quantity * * Change the quantity of a single line item on an open cart. Other fields on the line item are immutable; recreate the item to change them. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsUpdateLineItem: (options: Options) => RequestResult; /** * Toggle an add-on on a cart session * * Add or remove an add-on product from `add_ons_selected`. The call is idempotent: sending the same desired state for an add-on already in that state is a no-op and emits no event. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsToggleAddOn: (options: Options) => RequestResult; /** * Set or clear a cart discount code * * Set the cart's discount code. Pass `null` to clear. The code is validated against the merchant's active discounts and priced into the cart total immediately; convert then carries the discounted amount. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsApplyDiscountCode: (options: Options) => RequestResult; /** * Capture customer email + consent on a cart * * Capture the customer's email and marketing/recovery consent on an open cart so an abandoned cart can be recovered (REV-5517). Every field is optional; pass `null` to clear. Setting a field records its consent/capture timestamp. Idempotent — an input that changes nothing is a no-op. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/convert` — Convert a cart session into a checkout session * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsSetContact: (options: Options) => RequestResult; /** * Convert a cart session into a checkout session * * Atomically materialise a pending checkout session from the cart snapshot, reserve tracked availability, flip the cart to `converted`, and emit `commerce.cart.converted` + `commerce.checkout.started` through the outbox. * * Idempotent on re-call (returns the existing checkout session). Concurrency-safe via a compare-and-swap lock on cart status; product availability is guarded by the database reserve step. * * Validation that runs inside the lock and rolls back on failure: * - `CART_SESSION_EMPTY` — the cart has no line items. * - `AVAILABILITY_EXCEEDED` — a tracked/capacity-limited product can no longer satisfy the requested quantity. * - `CART_SESSION_NOT_FOUND` — no cart for this id under the calling merchant. * - `CART_SESSION_CLOSED` — the cart is already `abandoned` or `expired`. * * On rollback the cart returns to `open` and the customer can retry after fixing the cause. * * --- * * **Related endpoints** * * - `POST /cart-sessions` — Create a cart session * - `GET /cart-sessions/{id}` — Retrieve a cart session * - `POST /cart-sessions/{id}/line-items` — Add a line item to a cart session * - `PATCH /cart-sessions/{id}/line-items/{lineId}` — Update a line item's quantity * - `DELETE /cart-sessions/{id}/line-items/{lineId}` — Remove a line item from a cart session * - `POST /cart-sessions/{id}/add-ons` — Toggle an add-on on a cart session * - `POST /cart-sessions/{id}/discount-code` — Set or clear a cart discount code * - `POST /cart-sessions/{id}/contact` — Capture customer email + consent on a cart * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartSessionsConvert: (options: Options) => RequestResult; /** * Get managed Cart API key status * * Returns whether the authenticated merchant has managed RevKeen Cart publishable and secret keys. Existing key values are never returned. * * --- * * **Related endpoints** * * - `POST /cart-api-keys/ensure` — Ensure managed Cart API keys exist * - `POST /cart-api-keys/{kind}/rotate` — Rotate a managed Cart API key * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. */ declare const cartApiKeysStatus: (options?: Options) => RequestResult; /** * Ensure managed Cart API keys exist * * Creates any missing managed RevKeen Cart publishable and secret keys for the authenticated merchant. Newly created key values are returned once; existing secret values are never re-exposed. * * --- * * **Related endpoints** * * - `GET /cart-api-keys/status` — Get managed Cart API key status * - `POST /cart-api-keys/{kind}/rotate` — Rotate a managed Cart API key * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartApiKeysEnsure: (options?: Options) => RequestResult; /** * Rotate a managed Cart API key * * Rotates the managed RevKeen Cart publishable or secret key. The new key value is returned once; previous keys remain valid for the requested grace window. * * --- * * **Related endpoints** * * - `GET /cart-api-keys/status` — Get managed Cart API key status * - `POST /cart-api-keys/ensure` — Ensure managed Cart API keys exist * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const cartApiKeysRotate: (options: Options) => RequestResult; /** * List storefront products * * List active, cart-eligible products with browser-safe display data, active prices, and derived availability. Intended for publishable-key storefront and CMS-picker use; never returns product metadata or internal fields. * * --- * * **Related endpoints** * * - `GET /storefront/products/{productId}` — Get a storefront product * - `GET /storefront/origins` — List storefront origins * - `POST /storefront/origins` — Register a storefront origin * - `DELETE /storefront/origins/{originId}` — Remove a storefront origin * - `GET /storefront/status` — Get storefront integration status * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const storefrontProductsList: (options?: Options) => RequestResult; /** * Get a storefront product * * Fetch one active, cart-eligible product by UUID, product reference, or slug. Same browser-safe projection as the list endpoint. * * --- * * **Related endpoints** * * - `GET /storefront/products` — List storefront products * - `GET /storefront/origins` — List storefront origins * - `POST /storefront/origins` — Register a storefront origin * - `DELETE /storefront/origins/{originId}` — Remove a storefront origin * - `GET /storefront/status` — Get storefront integration status * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const storefrontProductsGet: (options: Options) => RequestResult; /** * List storefront origins * * List the browser origins registered for publishable-key storefront calls. * * --- * * **Related endpoints** * * - `GET /storefront/products` — List storefront products * - `GET /storefront/products/{productId}` — Get a storefront product * - `POST /storefront/origins` — Register a storefront origin * - `DELETE /storefront/origins/{originId}` — Remove a storefront origin * - `GET /storefront/status` — Get storefront integration status * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const storefrontOriginsList: (options?: Options) => RequestResult; /** * Register a storefront origin * * Register an exact web origin (scheme://host[:port]) for publishable-key storefront calls. Wildcards are rejected; http is allowed only for localhost. * * --- * * **Related endpoints** * * - `GET /storefront/products` — List storefront products * - `GET /storefront/products/{productId}` — Get a storefront product * - `GET /storefront/origins` — List storefront origins * - `DELETE /storefront/origins/{originId}` — Remove a storefront origin * - `GET /storefront/status` — Get storefront integration status * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const storefrontOriginsCreate: (options?: Options) => RequestResult; /** * Remove a storefront origin * * Remove a registered storefront origin. Browser calls from it fail closed afterwards. * * --- * * **Related endpoints** * * - `GET /storefront/products` — List storefront products * - `GET /storefront/products/{productId}` — Get a storefront product * - `GET /storefront/origins` — List storefront origins * - `POST /storefront/origins` — Register a storefront origin * - `GET /storefront/status` — Get storefront integration status * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const storefrontOriginsDelete: (options: Options) => RequestResult; /** * Get storefront integration status * * Readiness report for the Cart/headless-storefront setup: activation, managed keys, registered origins, product-read readiness, webhook health, and availability tracking. CART_DISABLED / KEYS_MISSING / ORIGIN_MISSING / PRODUCT_READ_UNAVAILABLE are fail-level; WEBHOOK_MISSING / WEBHOOK_UNREACHABLE are warn-level. Never returns key material. * * --- * * **Related endpoints** * * - `GET /storefront/products` — List storefront products * - `GET /storefront/products/{productId}` — Get a storefront product * - `GET /storefront/origins` — List storefront origins * - `POST /storefront/origins` — Register a storefront origin * - `DELETE /storefront/origins/{originId}` — Remove a storefront origin * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. */ declare const storefrontStatusGet: (options?: Options) => RequestResult; /** * List customers * * Retrieve a paginated list of customers for the merchant * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/invoices` — List customer invoices * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions * - `GET /customers/{customerId}/orders` — List customer orders * - `GET /customers/{customerId}/payments` — List customer payments * - `PUT /customers/external/batch` — Batch upsert customers by external ID * - `POST /customers` — Create a new customer * - `GET /customers/{id}` — Get customer by ID * - `PATCH /customers/{id}` — Update customer details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const customersList: (options?: Options) => RequestResult; /** * Create a new customer * * Create a new customer record in the merchant's account * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/invoices` — List customer invoices * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions * - `GET /customers/{customerId}/orders` — List customer orders * - `GET /customers/{customerId}/payments` — List customer payments * - `PUT /customers/external/batch` — Batch upsert customers by external ID * - `GET /customers` — List customers * - `GET /customers/{id}` — Get customer by ID * - `PATCH /customers/{id}` — Update customer details * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customersCreate: (options?: Options) => RequestResult; /** * Get customer by ID * * Retrieve detailed information about a specific customer * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/invoices` — List customer invoices * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions * - `GET /customers/{customerId}/orders` — List customer orders * - `GET /customers/{customerId}/payments` — List customer payments * - `PUT /customers/external/batch` — Batch upsert customers by external ID * - `POST /customers` — Create a new customer * - `GET /customers` — List customers * - `PATCH /customers/{id}` — Update customer details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const customersGet: (options: Options) => RequestResult; /** * Update customer details * * Update an existing customer's information * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/invoices` — List customer invoices * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions * - `GET /customers/{customerId}/orders` — List customer orders * - `GET /customers/{customerId}/payments` — List customer payments * - `PUT /customers/external/batch` — Batch upsert customers by external ID * - `POST /customers` — Create a new customer * - `GET /customers` — List customers * - `GET /customers/{id}` — Get customer by ID * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customersUpdate: (options: Options) => RequestResult; /** * Get customer payment rail availability * * Return per-rail availability for a customer, including mandate state and last successful rail usage. * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/invoices` — List customer invoices * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions * - `GET /customers/{customerId}/orders` — List customer orders * - `GET /customers/{customerId}/payments` — List customer payments * - `PUT /customers/external/batch` — Batch upsert customers by external ID * - `POST /customers` — Create a new customer * - `GET /customers` — List customers * - `GET /customers/{id}` — Get customer by ID * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const customersPaymentRailsGet: (options: Options) => RequestResult; /** * Get preferred payment rails * * Return smart-pick rail recommendations with customer history, mandate state, and margin-aware reasoning. * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/invoices` — List customer invoices * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions * - `GET /customers/{customerId}/orders` — List customer orders * - `GET /customers/{customerId}/payments` — List customer payments * - `PUT /customers/external/batch` — Batch upsert customers by external ID * - `POST /customers` — Create a new customer * - `GET /customers` — List customers * - `GET /customers/{id}` — Get customer by ID * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const customersPreferredRailsGet: (options: Options) => RequestResult; /** * Get customer payment methods * * Retrieve all payment methods for a customer * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/invoices` — List customer invoices * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions * - `GET /customers/{customerId}/orders` — List customer orders * - `GET /customers/{customerId}/payments` — List customer payments * - `PUT /customers/external/batch` — Batch upsert customers by external ID * - `POST /customers` — Create a new customer * - `GET /customers` — List customers * - `GET /customers/{id}` — Get customer by ID * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const customersPaymentMethodsList: (options: Options) => RequestResult; /** * List subscriptions * * Retrieve a paginated list of subscriptions with optional filters * * --- * * **Related endpoints** * * - `POST /subscriptions` — Create a new subscription * - `GET /subscriptions/{id}` — Get subscription by ID * - `PATCH /subscriptions/{id}` — Update subscription details * - `DELETE /subscriptions/{id}` — Delete subscription * - `POST /subscriptions/{id}/change-plan` — Change subscription plan * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal * - `POST /subscriptions/{id}/pause` — Pause subscription * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const subscriptionsList: (options?: Options) => RequestResult; /** * Create a new subscription * * Create a new subscription for a customer * * --- * * **Related endpoints** * * - `GET /subscriptions` — List subscriptions * - `GET /subscriptions/{id}` — Get subscription by ID * - `PATCH /subscriptions/{id}` — Update subscription details * - `DELETE /subscriptions/{id}` — Delete subscription * - `POST /subscriptions/{id}/change-plan` — Change subscription plan * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal * - `POST /subscriptions/{id}/pause` — Pause subscription * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const subscriptionsCreate: (options?: Options) => RequestResult; /** * Get subscription by ID * * Retrieve detailed information about a specific subscription * * --- * * **Related endpoints** * * - `POST /subscriptions` — Create a new subscription * - `GET /subscriptions` — List subscriptions * - `PATCH /subscriptions/{id}` — Update subscription details * - `DELETE /subscriptions/{id}` — Delete subscription * - `POST /subscriptions/{id}/change-plan` — Change subscription plan * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal * - `POST /subscriptions/{id}/pause` — Pause subscription * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const subscriptionsGet: (options: Options) => RequestResult; /** * Update subscription details * * Update an existing subscription's properties * * --- * * **Related endpoints** * * - `POST /subscriptions` — Create a new subscription * - `GET /subscriptions` — List subscriptions * - `GET /subscriptions/{id}` — Get subscription by ID * - `DELETE /subscriptions/{id}` — Delete subscription * - `POST /subscriptions/{id}/change-plan` — Change subscription plan * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal * - `POST /subscriptions/{id}/pause` — Pause subscription * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const subscriptionsUpdate: (options: Options) => RequestResult; /** * Cancel subscription * * Cancel a subscription either immediately or at the end of the current billing period. * * **Modes:** * - `immediately`: Status set to "canceled", access revoked now * - `period_end`: cancelAtPeriodEnd flag set, access continues until period end * * --- * * **Related endpoints** * * - `POST /subscriptions` — Create a new subscription * - `GET /subscriptions` — List subscriptions * - `GET /subscriptions/{id}` — Get subscription by ID * - `PATCH /subscriptions/{id}` — Update subscription details * - `DELETE /subscriptions/{id}` — Delete subscription * - `POST /subscriptions/{id}/change-plan` — Change subscription plan * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const subscriptionsCancel: (options: Options) => RequestResult; /** * MRR Summary * * Get Monthly Recurring Revenue metrics and growth * * --- * * **Related endpoints** * * - `GET /analytics/revenue/time-series` — Revenue Time Series * - `GET /analytics/invoices/ar-aging` — A/R Aging Report * - `GET /analytics/collections/dso` — Days Sales Outstanding * - `GET /analytics/customers/ltv` — Customer LTV * - `GET /analytics/customers/{customerId}` — Customer Analytics * - `GET /analytics/payment-links/conversion` — Payment Link Conversion * - `GET /analytics/checkout/funnel` — Checkout Funnel Analytics * - `GET /analytics/checkout/abandonment/summary` — Abandonment Alert Summary */ declare const analyticsRevenueMrrSummary: (options?: Options) => RequestResult; /** * Revenue Time Series * * Get revenue data over time with configurable granularity * * --- * * **Related endpoints** * * - `GET /analytics/revenue/mrr-summary` — MRR Summary * - `GET /analytics/invoices/ar-aging` — A/R Aging Report * - `GET /analytics/collections/dso` — Days Sales Outstanding * - `GET /analytics/customers/ltv` — Customer LTV * - `GET /analytics/customers/{customerId}` — Customer Analytics * - `GET /analytics/payment-links/conversion` — Payment Link Conversion * - `GET /analytics/checkout/funnel` — Checkout Funnel Analytics * - `GET /analytics/checkout/abandonment/summary` — Abandonment Alert Summary */ declare const analyticsRevenueTimeSeries: (options: Options) => RequestResult; /** * List refunds * * Retrieve a paginated list of refunds with optional filters. Results are ordered by creation date (newest first). * * --- * * **Related endpoints** * * - `POST /refunds` — Create a refund * - `GET /refunds/{id}` — Get refund by ID * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const refundsList: (options?: Options) => RequestResult; /** * Create a refund * * Initiate a refund for a payment. The refund will be processed through the original payment gateway. * * --- * * **Related endpoints** * * - `GET /refunds` — List refunds * - `GET /refunds/{id}` — Get refund by ID * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const refundsCreate: (options?: Options) => RequestResult; /** * Get refund by ID * * Retrieve a single refund by its public ID (ref_xxx) or internal UUID. * * --- * * **Related endpoints** * * - `GET /refunds` — List refunds * - `POST /refunds` — Create a refund * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const refundsGet: (options: Options) => RequestResult; /** * List credit notes * * Retrieve a paginated list of credit notes with optional filters. Results are ordered by creation date (newest first). * * --- * * **Related endpoints** * * - `POST /credit_notes` — Create a credit note * - `GET /credit_notes/{id}` — Get credit note by ID * - `POST /credit_notes/{id}/void` — Void a credit note * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction * - `GET /credit_notes/{id}/lines` — List line items on a credit note * - `POST /credit_notes/preview` — Preview a credit note without creating it * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const creditNotesList: (options?: Options) => RequestResult; /** * Create a credit note * * Issue a credit note for a paid or partially paid invoice. The credit can be applied via refund to payment method, customer balance, or marked as external. * * --- * * **Related endpoints** * * - `GET /credit_notes` — List credit notes * - `GET /credit_notes/{id}` — Get credit note by ID * - `POST /credit_notes/{id}/void` — Void a credit note * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction * - `GET /credit_notes/{id}/lines` — List line items on a credit note * - `POST /credit_notes/preview` — Preview a credit note without creating it * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const creditNotesCreate: (options?: Options) => RequestResult; /** * Get credit note by ID * * Retrieve a single credit note by its UUID. * * --- * * **Related endpoints** * * - `GET /credit_notes` — List credit notes * - `POST /credit_notes` — Create a credit note * - `POST /credit_notes/{id}/void` — Void a credit note * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction * - `GET /credit_notes/{id}/lines` — List line items on a credit note * - `POST /credit_notes/preview` — Preview a credit note without creating it * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const creditNotesGet: (options: Options) => RequestResult; /** * Void a credit note * * Void a credit note that has been issued but not yet fully applied. This is an accounting void — it reverses the credit without creating a new financial transaction. * * --- * * **Related endpoints** * * - `GET /credit_notes` — List credit notes * - `POST /credit_notes` — Create a credit note * - `GET /credit_notes/{id}` — Get credit note by ID * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction * - `GET /credit_notes/{id}/lines` — List line items on a credit note * - `POST /credit_notes/preview` — Preview a credit note without creating it * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const creditNotesVoid: (options: Options) => RequestResult; /** * List line items on a credit note * * Returns the line items attached to a credit note. Each line describes a portion of the invoice that the credit applies to — either a whole invoice line or a prorated slice. Use this to reconstruct the credit's effect per invoice line (for example, when displaying the credit breakdown in your own UI). * * --- * * **Related endpoints** * * - `GET /credit_notes` — List credit notes * - `POST /credit_notes` — Create a credit note * - `GET /credit_notes/{id}` — Get credit note by ID * - `POST /credit_notes/{id}/void` — Void a credit note * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction * - `POST /credit_notes/preview` — Preview a credit note without creating it * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const creditNotesListLines: (options: Options) => RequestResult; /** * Preview a credit note without creating it * * Compute what a credit note would look like against a specific invoice without persisting anything. Use this to validate amounts and show a "here's what will happen" UI before the merchant commits. No side effects — no DB writes, no events emitted, no refunds initiated. Mirrors Stripe's `POST /v1/credit_notes/preview`. * * --- * * **Related endpoints** * * - `GET /credit_notes` — List credit notes * - `POST /credit_notes` — Create a credit note * - `GET /credit_notes/{id}` — Get credit note by ID * - `POST /credit_notes/{id}/void` — Void a credit note * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction * - `GET /credit_notes/{id}/lines` — List line items on a credit note * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const creditNotesPreview: (options: Options) => RequestResult; /** * List payment links * * List payment links for the authenticated merchant with pagination and filters * * --- * * **Related endpoints** * * - `POST /payment-links` — Create a new payment link * - `GET /payment-links/{id}` — Get payment link by ID * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) * - `PATCH /payment-links/{id}/status` — Update payment link status * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const paymentLinksList: (options?: Options) => RequestResult; /** * Create a new payment link * * Create a new payment link for invoices, subscriptions, or custom amounts * * --- * * **Related endpoints** * * - `GET /payment-links` — List payment links * - `GET /payment-links/{id}` — Get payment link by ID * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) * - `PATCH /payment-links/{id}/status` — Update payment link status * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const paymentLinksCreate: (options?: Options) => RequestResult; /** * Get payment link by ID * * Retrieve a payment link by its UUID or public_id * * --- * * **Related endpoints** * * - `POST /payment-links` — Create a new payment link * - `GET /payment-links` — List payment links * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) * - `PATCH /payment-links/{id}/status` — Update payment link status * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const paymentLinksGet: (options: Options) => RequestResult; /** * Expire a payment link (deprecated) * * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "expired"` instead.** This convenience endpoint will be removed in a future API version. Mark a payment link as expired, preventing further use. * * --- * * **Related endpoints** * * - `POST /payment-links` — Create a new payment link * - `GET /payment-links` — List payment links * - `GET /payment-links/{id}` — Get payment link by ID * - `PATCH /payment-links/{id}/status` — Update payment link status * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). * * @deprecated */ declare const paymentLinksExpire: (options: Options) => RequestResult; /** * Update payment link status * * Change the status of a payment link. Active links accept payments, inactive links are temporarily disabled, and archived links are permanently disabled and cannot be reactivated. * * --- * * **Related endpoints** * * - `POST /payment-links` — Create a new payment link * - `GET /payment-links` — List payment links * - `GET /payment-links/{id}` — Get payment link by ID * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const paymentLinksUpdate: (options: Options) => RequestResult; /** * Deactivate a payment link (deprecated) * * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "inactive"` instead.** This convenience endpoint will be removed in a future API version. Temporarily disable a payment link. It can be reactivated later. * * --- * * **Related endpoints** * * - `POST /payment-links` — Create a new payment link * - `GET /payment-links` — List payment links * - `GET /payment-links/{id}` — Get payment link by ID * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) * - `PATCH /payment-links/{id}/status` — Update payment link status * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). * * @deprecated */ declare const paymentLinksDeactivate: (options: Options) => RequestResult; /** * Activate a payment link (deprecated) * * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "active"` instead.** This convenience endpoint will be removed in a future API version. Enable a payment link to accept payments. Cannot be used on archived links. * * --- * * **Related endpoints** * * - `POST /payment-links` — Create a new payment link * - `GET /payment-links` — List payment links * - `GET /payment-links/{id}` — Get payment link by ID * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) * - `PATCH /payment-links/{id}/status` — Update payment link status * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). * * @deprecated */ declare const paymentLinksActivate: (options: Options) => RequestResult; /** * Archive a payment link (deprecated) * * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "archived"` instead.** This convenience endpoint will be removed in a future API version. Permanently disable a payment link. This action cannot be undone. * * --- * * **Related endpoints** * * - `POST /payment-links` — Create a new payment link * - `GET /payment-links` — List payment links * - `GET /payment-links/{id}` — Get payment link by ID * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) * - `PATCH /payment-links/{id}/status` — Update payment link status * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). * * @deprecated */ declare const paymentLinksArchive: (options: Options) => RequestResult; /** * List prices * * List all prices for the authenticated merchant. Supports filtering and cursor-based pagination. * * --- * * **Related endpoints** * * - `POST /prices` — Create a price * - `GET /prices/{id}` — Retrieve a price * - `PATCH /prices/{id}` — Update a price * - `DELETE /prices/{id}` — Archive a price * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const pricesList: (options?: Options) => RequestResult; /** * Create a price * * Creates a new price for a product. Supports fixed, pay-what-you-want, and free pricing models. * * --- * * **Related endpoints** * * - `GET /prices` — List prices * - `GET /prices/{id}` — Retrieve a price * - `PATCH /prices/{id}` — Update a price * - `DELETE /prices/{id}` — Archive a price * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const pricesCreate: (options: Options) => RequestResult; /** * Archive a price * * Archives a price by setting active to false. The price remains in the system but cannot be used for new purchases. * * --- * * **Related endpoints** * * - `GET /prices` — List prices * - `POST /prices` — Create a price * - `GET /prices/{id}` — Retrieve a price * - `PATCH /prices/{id}` — Update a price * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const pricesArchive: (options: Options) => RequestResult; /** * Retrieve a price * * Retrieves a price by its ID. * * --- * * **Related endpoints** * * - `GET /prices` — List prices * - `POST /prices` — Create a price * - `PATCH /prices/{id}` — Update a price * - `DELETE /prices/{id}` — Archive a price * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const pricesGet: (options: Options) => RequestResult; /** * Update a price * * Updates a price. Only certain fields can be updated (active, name, nickname, lookup_key, metadata). Core pricing fields are immutable. * * --- * * **Related endpoints** * * - `GET /prices` — List prices * - `POST /prices` — Create a price * - `GET /prices/{id}` — Retrieve a price * - `DELETE /prices/{id}` — Archive a price * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const pricesUpdate: (options: Options) => RequestResult; /** * Create an accounting-led invoice payment request * * Claims or reuses an ExternalAccountingInvoicePaymentRequest and mints a provider-neutral checkout session. Does not create a RevKeen invoice. Requires Idempotency-Key. * * --- * * **Related endpoints** * * - `GET /integrations/accounting/invoice-payment-requests/{id}` — Get an accounting-led invoice payment request * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const accountingInvoicePaymentRequestsCreate: (options?: Options) => RequestResult; /** * Get an accounting-led invoice payment request * * --- * * **Related endpoints** * * - `POST /integrations/accounting/invoice-payment-requests` — Create an accounting-led invoice payment request * * **Common errors** * * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const accountingInvoicePaymentRequestsGet: (options: Options) => RequestResult; /** * List webhook endpoints * * List all webhook endpoints for the authenticated merchant. Supports filtering by status and pagination. * * --- * * **Related endpoints** * * - `POST /webhook-endpoints` — Create webhook endpoint * - `GET /webhook-endpoints/{id}` — Get webhook endpoint * - `PATCH /webhook-endpoints/{id}` — Update webhook endpoint * - `DELETE /webhook-endpoints/{id}` — Delete webhook endpoint * - `POST /webhook-endpoints/{id}/rotate-secret` — Rotate signing secret * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const webhookEndpointsList: (options?: Options) => RequestResult; /** * Create webhook endpoint * * Create a webhook endpoint to receive event notifications at the given URL. Returns the endpoint with its signing secret — store the secret securely, it is only shown once. * * --- * * **Related endpoints** * * - `GET /webhook-endpoints` — List webhook endpoints * - `GET /webhook-endpoints/{id}` — Get webhook endpoint * - `PATCH /webhook-endpoints/{id}` — Update webhook endpoint * - `DELETE /webhook-endpoints/{id}` — Delete webhook endpoint * - `POST /webhook-endpoints/{id}/rotate-secret` — Rotate signing secret * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const webhookEndpointsCreate: (options?: Options) => RequestResult; /** * Delete webhook endpoint * * Permanently delete a webhook endpoint and all its event subscriptions. * * --- * * **Related endpoints** * * - `GET /webhook-endpoints` — List webhook endpoints * - `POST /webhook-endpoints` — Create webhook endpoint * - `GET /webhook-endpoints/{id}` — Get webhook endpoint * - `PATCH /webhook-endpoints/{id}` — Update webhook endpoint * - `POST /webhook-endpoints/{id}/rotate-secret` — Rotate signing secret * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const webhookEndpointsDelete: (options: Options) => RequestResult; /** * Get webhook endpoint * * Retrieve a single webhook endpoint by ID, including delivery statistics. * * --- * * **Related endpoints** * * - `GET /webhook-endpoints` — List webhook endpoints * - `POST /webhook-endpoints` — Create webhook endpoint * - `PATCH /webhook-endpoints/{id}` — Update webhook endpoint * - `DELETE /webhook-endpoints/{id}` — Delete webhook endpoint * - `POST /webhook-endpoints/{id}/rotate-secret` — Rotate signing secret * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const webhookEndpointsGet: (options: Options) => RequestResult; /** * Update webhook endpoint * * Update a webhook endpoint's URL, subscribed events, description, or enabled status. * * --- * * **Related endpoints** * * - `GET /webhook-endpoints` — List webhook endpoints * - `POST /webhook-endpoints` — Create webhook endpoint * - `GET /webhook-endpoints/{id}` — Get webhook endpoint * - `DELETE /webhook-endpoints/{id}` — Delete webhook endpoint * - `POST /webhook-endpoints/{id}/rotate-secret` — Rotate signing secret * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const webhookEndpointsUpdate: (options: Options) => RequestResult; /** * Rotate signing secret * * Generate a new signing secret for a webhook endpoint. The old secret is immediately invalidated. Store the new secret securely — it is only returned in this response. * * --- * * **Related endpoints** * * - `GET /webhook-endpoints` — List webhook endpoints * - `POST /webhook-endpoints` — Create webhook endpoint * - `GET /webhook-endpoints/{id}` — Get webhook endpoint * - `PATCH /webhook-endpoints/{id}` — Update webhook endpoint * - `DELETE /webhook-endpoints/{id}` — Delete webhook endpoint * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const webhookEndpointsRotateSecret: (options: Options) => RequestResult; /** * List webhook deliveries * * List individual webhook delivery attempts across all endpoints for the authenticated merchant. Use filters to scope to a specific endpoint, a specific event, or a specific delivery status. Results are returned in reverse chronological order. * * --- * * **Related endpoints** * * - `GET /webhook-deliveries/{id}` — Retrieve a webhook delivery * - `POST /webhook-deliveries/{id}/retry` — Retry a webhook delivery * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const webhookDeliveriesList: (options?: Options) => RequestResult; /** * Retrieve a webhook delivery * * Retrieve the details of a single webhook delivery including its last attempt outcome. * * --- * * **Related endpoints** * * - `GET /webhook-deliveries` — List webhook deliveries * - `POST /webhook-deliveries/{id}/retry` — Retry a webhook delivery * * **Common errors** * * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const webhookDeliveriesGet: (options: Options) => RequestResult; /** * Retry a webhook delivery * * Queue an immediate retry of this delivery. The delivery is marked `pending` and `next_retry_at` is set to now; the dispatcher picks it up on its next tick. Calling retry on an already-pending delivery just advances its retry time. Dead-lettered deliveries can be retried once; succeeded deliveries cannot. * * --- * * **Related endpoints** * * - `GET /webhook-deliveries` — List webhook deliveries * - `GET /webhook-deliveries/{id}` — Retrieve a webhook delivery * * **Common errors** * * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const webhookDeliveriesRetry: (options: Options) => RequestResult; /** * Create a customer-portal session * * Mint a short-lived bearer token that authenticates a specific customer against /v2/customer-portal*. Returns an opaque `rkcps_...` token that expires in 60 minutes by default. Call this server-side from the merchant's backend, then hand the token to the customer's browser or embedded client. Treat the token like a password — never log it and never expose it to untrusted code. * * --- * * **Related endpoints** * * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customerPortalSessionsCreate: (options: Options) => RequestResult; /** * Retrieve the authenticated customer * * Returns the customer represented by the bearer token. Useful as a warm-up / identity check when an embedded portal page loads. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const customerPortalCustomerGet: (options?: Options) => RequestResult; /** * List the authenticated customer's subscriptions * * Returns subscriptions where the customer is the subscriber. Results are reverse-chronological by creation time and paginate via `starting_after` / `ending_before` cursors. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const customerPortalSubscriptionsList: (options?: Options) => RequestResult; /** * Retrieve a subscription * * Returns a subscription owned by the authenticated customer. 404s on cross-customer access even if the subscription exists. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const customerPortalSubscriptionsGet: (options: Options) => RequestResult; /** * Cancel a subscription * * Cancel a subscription owned by the authenticated customer. By default the subscription is scheduled to cancel at the end of the current billing period — set `cancel_at_period_end=false` to cancel immediately. Idempotent — cancelling an already-canceled subscription is a no-op that returns the current state. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customerPortalSubscriptionsCancel: (options: Options) => RequestResult; /** * List the authenticated customer's invoices * * Returns invoices owned by the authenticated customer, reverse-chronological by `invoice_date`. Use the same `starting_after`/`ending_before` cursor pattern as subscriptions. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const customerPortalInvoicesList: (options?: Options) => RequestResult; /** * Retrieve an invoice * * Returns an invoice owned by the authenticated customer. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const customerPortalInvoicesGet: (options: Options) => RequestResult; /** * List the authenticated customer's Direct Debit mandates * * Returns the customer's Direct Debit mandates (status, masked account, next collection date). Requires the merchant to have portal DD self-service enabled. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `POST /customer-portal/mandates/{id}/re-authorize` — Re-authorise a Direct Debit mandate with new bank details * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const customerPortalMandatesList: (options?: Options) => RequestResult; /** * Re-authorise a Direct Debit mandate with new bank details * * Updates the existing provider customer with new bank details and returns the mandate to pending while the fresh Bacs instruction is lodged. Requires portal DD self-service. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * - `422 unprocessable_entity` — business-rule failure (for example, refunding more than the original charge). * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customerPortalMandatesReauthorize: (options: Options) => RequestResult; /** * Cancel a Direct Debit mandate * * Cancels the mandate for future collections only. Requires portal DD self-service. Bank changes affect future only (per approved V13 mockup). * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customerPortalMandatesCancel: (options: Options) => RequestResult; /** * Send a step-up OTP for a Direct Debit bank-detail change * * Emails the customer a one-time code that must be verified (verify-otp) before a change-of-bank can be submitted. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * - `422 unprocessable_entity` — business-rule failure (for example, refunding more than the original charge). * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customerPortalMandatesReauthorizeSendOtp: (options: Options) => RequestResult; /** * Verify a step-up OTP and receive a change-of-bank token * * Verifies the one-time code and returns a short-lived verification_token bound to this customer, the change-bank action, and this mandate. Pass it to re-authorize. * * --- * * **Related endpoints** * * - `POST /customer-portal/sessions` — Create a customer-portal session * - `GET /customer-portal/customer` — Retrieve the authenticated customer * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription * - `GET /customer-portal/invoices` — List the authenticated customer's invoices * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice * - `GET /customer-portal/mandates` — List the authenticated customer's Direct Debit mandates * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `422 unprocessable_entity` — business-rule failure (for example, refunding more than the original charge). * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const customerPortalMandatesReauthorizeVerifyOtp: (options: Options) => RequestResult; /** * List a customer's meter usage * * Returns per-meter aggregates for a single customer. Requires a `customer_id` query parameter. For each meter the merchant has defined, the response includes the aggregate quantity (applying the meter's native aggregation function), the event count, and the most recent event timestamp. * * Use this to render a customer's current consumption snapshot in your own UI — for example, a usage dashboard showing "4,820 / 10,000 requests this period". * * --- * * **Related endpoints** * * - `GET /customer-meters/{customer_id}/{meter_id}` — Retrieve a customer-meter aggregate * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const customerMetersList: (options: Options) => RequestResult; /** * Retrieve a customer-meter aggregate * * Returns a single customer-meter aggregate for the specified customer + meter pair. Returns 404 only if the meter itself does not exist on the merchant — if the meter exists but the customer has zero events, the response returns an aggregate with `total_quantity: 0`, `event_count: 0`, `last_event_at: null`. * * --- * * **Related endpoints** * * - `GET /customer-meters` — List a customer's meter usage * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const customerMetersGet: (options: Options) => RequestResult; /** * List payment intents * * Returns a list of payment intents with optional filtering. * * --- * * **Related endpoints** * * - `POST /payment-intents` — Create a payment intent * - `GET /payment-intents/{id}` — Retrieve a payment intent * - `POST /payment-intents/{id}` — Update a payment intent * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent * - `POST /payment-intents/{id}/capture` — Capture a payment intent * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const paymentIntentsList: (options?: Options) => RequestResult; /** * Create a payment intent * * Creates a payment intent to orchestrate payment collection with support for 3DS/SCA authentication. * * --- * * **Related endpoints** * * - `GET /payment-intents` — List payment intents * - `GET /payment-intents/{id}` — Retrieve a payment intent * - `POST /payment-intents/{id}` — Update a payment intent * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent * - `POST /payment-intents/{id}/capture` — Capture a payment intent * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const paymentIntentsCreate: (options?: Options) => RequestResult; /** * Retrieve a payment intent * * Retrieves a payment intent by its ID (pi_xxx). * * --- * * **Related endpoints** * * - `POST /payment-intents` — Create a payment intent * - `GET /payment-intents` — List payment intents * - `POST /payment-intents/{id}` — Update a payment intent * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent * - `POST /payment-intents/{id}/capture` — Capture a payment intent * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent * * **Common errors** * * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const paymentIntentsGet: (options: Options) => RequestResult; /** * Confirm a payment intent * * Confirms the payment intent. May return requires_action if 3DS authentication is needed. * * --- * * **Related endpoints** * * - `POST /payment-intents` — Create a payment intent * - `GET /payment-intents` — List payment intents * - `GET /payment-intents/{id}` — Retrieve a payment intent * - `POST /payment-intents/{id}` — Update a payment intent * - `POST /payment-intents/{id}/capture` — Capture a payment intent * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const paymentIntentsConfirm: (options: Options) => RequestResult; /** * Capture a payment intent * * Captures a payment intent that was created with capture_method=manual. * * --- * * **Related endpoints** * * - `POST /payment-intents` — Create a payment intent * - `GET /payment-intents` — List payment intents * - `GET /payment-intents/{id}` — Retrieve a payment intent * - `POST /payment-intents/{id}` — Update a payment intent * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const paymentIntentsCapture: (options: Options) => RequestResult; /** * Cancel a payment intent * * Cancels a payment intent. Cannot cancel if already succeeded or canceled. * * --- * * **Related endpoints** * * - `POST /payment-intents` — Create a payment intent * - `GET /payment-intents` — List payment intents * - `GET /payment-intents/{id}` — Retrieve a payment intent * - `POST /payment-intents/{id}` — Update a payment intent * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent * - `POST /payment-intents/{id}/capture` — Capture a payment intent * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const paymentIntentsCancel: (options: Options) => RequestResult; /** * List events * * Returns a list of events with optional filters. Events are returned in reverse chronological order. * * --- * * **Related endpoints** * * - `GET /events/{id}` — Retrieve an event * - `POST /events/{id}/resend` — Resend webhook for an event * - `POST /events/test` — Create a test event * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const eventsList: (options?: Options) => RequestResult; /** * Retrieve an event * * Retrieves the details of an event by its ID. * * --- * * **Related endpoints** * * - `GET /events` — List events * - `POST /events/{id}/resend` — Resend webhook for an event * - `POST /events/test` — Create a test event * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const eventsGet: (options: Options) => RequestResult; /** * Resend webhook for an event * * Queues the event to be resent to all configured webhook endpoints. * * --- * * **Related endpoints** * * - `GET /events` — List events * - `GET /events/{id}` — Retrieve an event * - `POST /events/test` — Create a test event * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const eventsResend: (options: Options) => RequestResult; /** * List entitlements * * Retrieve all entitlements for a customer. Pass `customer_id` as a query parameter. Includes computed access status based on subscription state. * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/entitlements` — List customer entitlements * - `POST /customers/{customerId}/entitlements` — Grant entitlement to customer * - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key * - `GET /customers/{customerId}/entitlements/check` — Check customer entitlement * - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID * - `GET /entitlements/check` — Check entitlement access * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const entitlementsList: (options: Options) => RequestResult; /** * Check entitlement access * * Check if a customer has access to a specific benefit by key. This is the primary endpoint for feature gating and licensing checks. * * --- * * **Related endpoints** * * - `GET /customers/{customerId}/entitlements` — List customer entitlements * - `POST /customers/{customerId}/entitlements` — Grant entitlement to customer * - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key * - `GET /customers/{customerId}/entitlements/check` — Check customer entitlement * - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID * - `GET /entitlements` — List entitlements * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const entitlementsCheck: (options: Options) => RequestResult; /** * List transactions * * List all transactions for the authenticated merchant. Transactions represent the unified financial truth — every sale, refund, void, capture, dispute, and adjustment. * * --- * * **Related endpoints** * * - `GET /transactions/{id}` — Get transaction by ID * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const transactionsList: (options?: Options) => RequestResult; /** * Get transaction by ID * * Retrieve a single transaction by its ID. * * --- * * **Related endpoints** * * - `GET /transactions` — List transactions * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const transactionsGet: (options: Options) => RequestResult; /** * Look up a pending signed mandate request * * Public lookup of a pending signed mandate request by its emailed token. Rate-limited; returns 404 for unknown, consumed, cancelled, or expired tokens. * * --- * * **Related endpoints** * * - `POST /dd/validate` — Validate a UK bank account for Direct Debit * - `POST /dd/preview` — Preview the Direct Debit collection date chain * * **Common errors** * * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `429 rate_limit_exceeded` — back off using the `Retry-After` header. */ declare const ddMandateRequestsGet: (options: Options) => RequestResult; /** * Validate a UK bank account for Direct Debit * * Validates UK bank account details (sort code + account number) for Direct Debit eligibility with the bureau. * * --- * * **Related endpoints** * * - `GET /dd/mandate-requests/{token}` — Look up a pending signed mandate request * - `POST /dd/preview` — Preview the Direct Debit collection date chain * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const ddValidate: (options?: Options) => RequestResult; /** * Preview the Direct Debit collection date chain * * Returns the backend-owned working-day date chain (advance notice → submission → collection → settlement) for a Direct Debit collection. Clients never compute these dates. * * --- * * **Related endpoints** * * - `GET /dd/mandate-requests/{token}` — Look up a pending signed mandate request * - `POST /dd/validate` — Validate a UK bank account for Direct Debit * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const ddPreview: (options?: Options) => RequestResult; /** * List Direct Debit mandates * * --- * * **Related endpoints** * * - `POST /mandates` — Create a Direct Debit mandate * - `GET /mandates/{id}` — Retrieve a Direct Debit mandate * - `POST /mandates/{id}/cancel` — Cancel a Direct Debit mandate * - `POST /mandates/{id}/suspend` — Suspend a Direct Debit mandate * - `POST /mandates/{id}/reinstate` — Reinstate a suspended Direct Debit mandate * - `POST /mandates/{id}/collections` — Schedule a one-off Direct Debit collection * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * * **Pagination** * * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers. */ declare const mandatesList: (options?: Options) => RequestResult; /** * Create a Direct Debit mandate * * Creates a Direct Debit mandate for a customer. Bank details are validated with the bureau and stored KMS-encrypted; only masked values are returned. * * --- * * **Related endpoints** * * - `GET /mandates` — List Direct Debit mandates * - `GET /mandates/{id}` — Retrieve a Direct Debit mandate * - `POST /mandates/{id}/cancel` — Cancel a Direct Debit mandate * - `POST /mandates/{id}/suspend` — Suspend a Direct Debit mandate * - `POST /mandates/{id}/reinstate` — Reinstate a suspended Direct Debit mandate * - `POST /mandates/{id}/collections` — Schedule a one-off Direct Debit collection * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * - `410 gone` — the resource has been archived or permanently deleted. * - `422 unprocessable_entity` — business-rule failure (for example, refunding more than the original charge). * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const mandatesCreate: (options: Options) => RequestResult; /** * Retrieve a Direct Debit mandate * * --- * * **Related endpoints** * * - `POST /mandates` — Create a Direct Debit mandate * - `GET /mandates` — List Direct Debit mandates * - `POST /mandates/{id}/cancel` — Cancel a Direct Debit mandate * - `POST /mandates/{id}/suspend` — Suspend a Direct Debit mandate * - `POST /mandates/{id}/reinstate` — Reinstate a suspended Direct Debit mandate * - `POST /mandates/{id}/collections` — Schedule a one-off Direct Debit collection * * **Common errors** * * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. */ declare const mandatesGet: (options: Options) => RequestResult; /** * Cancel a Direct Debit mandate * * Cancels a mandate. If it was lodged with the bureau, the London & Zurich customer is cancelled too. * * --- * * **Related endpoints** * * - `POST /mandates` — Create a Direct Debit mandate * - `GET /mandates` — List Direct Debit mandates * - `GET /mandates/{id}` — Retrieve a Direct Debit mandate * - `POST /mandates/{id}/suspend` — Suspend a Direct Debit mandate * - `POST /mandates/{id}/reinstate` — Reinstate a suspended Direct Debit mandate * - `POST /mandates/{id}/collections` — Schedule a one-off Direct Debit collection * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const mandatesCancel: (options: Options) => RequestResult; /** * Suspend a Direct Debit mandate * * Suspends an active (or pending-lodgement) mandate. * * --- * * **Related endpoints** * * - `POST /mandates` — Create a Direct Debit mandate * - `GET /mandates` — List Direct Debit mandates * - `GET /mandates/{id}` — Retrieve a Direct Debit mandate * - `POST /mandates/{id}/cancel` — Cancel a Direct Debit mandate * - `POST /mandates/{id}/reinstate` — Reinstate a suspended Direct Debit mandate * - `POST /mandates/{id}/collections` — Schedule a one-off Direct Debit collection * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const mandatesSuspend: (options: Options) => RequestResult; /** * Reinstate a suspended Direct Debit mandate * * Reinstates a suspended mandate. This is NOT a status flip — it re-lodges the mandate to Bacs (a new AUDDIS instruction) using the securely stored bank details, then moves the mandate to pending_lodgement (REV-3123). * * --- * * **Related endpoints** * * - `POST /mandates` — Create a Direct Debit mandate * - `GET /mandates` — List Direct Debit mandates * - `GET /mandates/{id}` — Retrieve a Direct Debit mandate * - `POST /mandates/{id}/cancel` — Cancel a Direct Debit mandate * - `POST /mandates/{id}/suspend` — Suspend a Direct Debit mandate * - `POST /mandates/{id}/collections` — Schedule a one-off Direct Debit collection * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * - `422 unprocessable_entity` — business-rule failure (for example, refunding more than the original charge). * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const mandatesReinstate: (options: Options) => RequestResult; /** * Schedule a one-off Direct Debit collection * * Schedules a one-off Bacs collection against an active mandate for an invoice or payment link. L&Z confirms the permitted collection date, the payer receives the configured regulatory advance notice first, and nothing is marked paid until the bureau confirms collection. Idempotent per source: retrying with the same sourceId returns or reconciles the same provider schedule instead of collecting twice. * * --- * * **Related endpoints** * * - `POST /mandates` — Create a Direct Debit mandate * - `GET /mandates` — List Direct Debit mandates * - `GET /mandates/{id}` — Retrieve a Direct Debit mandate * - `POST /mandates/{id}/cancel` — Cancel a Direct Debit mandate * - `POST /mandates/{id}/suspend` — Suspend a Direct Debit mandate * - `POST /mandates/{id}/reinstate` — Reinstate a suspended Direct Debit mandate * * **Common errors** * * - `400 invalid_request` — malformed payload or failed validation. * - `401 unauthenticated` — missing, malformed, or revoked API key. * - `403 permission_denied` — key lacks the required scope, or the resource belongs to a different merchant. * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. * - `422 unprocessable_entity` — business-rule failure (for example, refunding more than the original charge). * * **Idempotency** * * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency). */ declare const mandatesScheduleCollection: (options: Options) => RequestResult; export { AccountingInvoicePaymentRequestsCreateData, AccountingInvoicePaymentRequestsCreateErrors, AccountingInvoicePaymentRequestsCreateResponse, AccountingInvoicePaymentRequestsCreateResponses, AccountingInvoicePaymentRequestsGetData, AccountingInvoicePaymentRequestsGetErrors, AccountingInvoicePaymentRequestsGetResponse, AccountingInvoicePaymentRequestsGetResponses, type AccountingResource, type AnalyticsResource, AnalyticsRevenueMrrSummaryData, AnalyticsRevenueMrrSummaryResponse, AnalyticsRevenueMrrSummaryResponses, AnalyticsRevenueTimeSeriesData, AnalyticsRevenueTimeSeriesResponse, AnalyticsRevenueTimeSeriesResponses, BatchIngestResult, CartApiKeysEnsureData, CartApiKeysEnsureErrors, CartApiKeysEnsureResponse, CartApiKeysEnsureResponses, CartApiKeysRotateData, CartApiKeysRotateErrors, CartApiKeysRotateResponse, CartApiKeysRotateResponses, CartApiKeysStatusData, CartApiKeysStatusErrors, CartApiKeysStatusResponse, CartApiKeysStatusResponses, type CartResource, CartSessionsAddLineItemData, CartSessionsAddLineItemErrors, CartSessionsAddLineItemResponse, CartSessionsAddLineItemResponses, CartSessionsApplyDiscountCodeData, CartSessionsApplyDiscountCodeErrors, CartSessionsApplyDiscountCodeResponse, CartSessionsApplyDiscountCodeResponses, CartSessionsConvertData, CartSessionsConvertErrors, CartSessionsConvertResponse, CartSessionsConvertResponses, CartSessionsCreateData, CartSessionsCreateErrors, CartSessionsCreateResponse, CartSessionsCreateResponses, CartSessionsGetData, CartSessionsGetErrors, CartSessionsGetResponse, CartSessionsGetResponses, CartSessionsRemoveLineItemData, CartSessionsRemoveLineItemErrors, CartSessionsRemoveLineItemResponse, CartSessionsRemoveLineItemResponses, CartSessionsSetContactData, CartSessionsSetContactErrors, CartSessionsSetContactResponse, CartSessionsSetContactResponses, CartSessionsToggleAddOnData, CartSessionsToggleAddOnErrors, CartSessionsToggleAddOnResponse, CartSessionsToggleAddOnResponses, CartSessionsUpdateLineItemData, CartSessionsUpdateLineItemErrors, CartSessionsUpdateLineItemResponse, CartSessionsUpdateLineItemResponses, CheckoutSessionsCreateData, CheckoutSessionsCreateErrors, CheckoutSessionsCreateResponse, CheckoutSessionsCreateResponses, CheckoutSessionsExpireData, CheckoutSessionsExpireErrors, CheckoutSessionsExpireResponse, CheckoutSessionsExpireResponses, CheckoutSessionsGetData, CheckoutSessionsGetErrors, CheckoutSessionsGetResponse, CheckoutSessionsGetResponses, type CheckoutSessionsResource, CreditNotesCreateData, CreditNotesCreateErrors, CreditNotesCreateResponse, CreditNotesCreateResponses, CreditNotesGetData, CreditNotesGetErrors, CreditNotesGetResponse, CreditNotesGetResponses, CreditNotesListData, CreditNotesListErrors, CreditNotesListLinesData, CreditNotesListLinesErrors, CreditNotesListLinesResponse, CreditNotesListLinesResponses, CreditNotesListResponse, CreditNotesListResponses, CreditNotesPreviewData, CreditNotesPreviewErrors, CreditNotesPreviewResponse, CreditNotesPreviewResponses, type CreditNotesResource, CreditNotesVoidData, CreditNotesVoidErrors, CreditNotesVoidResponse, CreditNotesVoidResponses, CustomerMetersGetData, CustomerMetersGetErrors, CustomerMetersGetResponse, CustomerMetersGetResponses, CustomerMetersListData, CustomerMetersListErrors, CustomerMetersListResponse, CustomerMetersListResponses, CustomerPortalCustomerGetData, CustomerPortalCustomerGetErrors, CustomerPortalCustomerGetResponse, CustomerPortalCustomerGetResponses, CustomerPortalInvoicesGetData, CustomerPortalInvoicesGetErrors, CustomerPortalInvoicesGetResponse, CustomerPortalInvoicesGetResponses, CustomerPortalInvoicesListData, CustomerPortalInvoicesListErrors, CustomerPortalInvoicesListResponse, CustomerPortalInvoicesListResponses, CustomerPortalMandatesCancelData, CustomerPortalMandatesCancelErrors, CustomerPortalMandatesCancelResponse, CustomerPortalMandatesCancelResponses, CustomerPortalMandatesListData, CustomerPortalMandatesListErrors, CustomerPortalMandatesListResponse, CustomerPortalMandatesListResponses, CustomerPortalMandatesReauthorizeData, CustomerPortalMandatesReauthorizeErrors, CustomerPortalMandatesReauthorizeResponse, CustomerPortalMandatesReauthorizeResponses, CustomerPortalMandatesReauthorizeSendOtpData, CustomerPortalMandatesReauthorizeSendOtpErrors, CustomerPortalMandatesReauthorizeSendOtpResponse, CustomerPortalMandatesReauthorizeSendOtpResponses, CustomerPortalMandatesReauthorizeVerifyOtpData, CustomerPortalMandatesReauthorizeVerifyOtpErrors, CustomerPortalMandatesReauthorizeVerifyOtpResponse, CustomerPortalMandatesReauthorizeVerifyOtpResponses, CustomerPortalSessionsCreateData, CustomerPortalSessionsCreateErrors, CustomerPortalSessionsCreateResponse, CustomerPortalSessionsCreateResponses, CustomerPortalSubscriptionsCancelData, CustomerPortalSubscriptionsCancelErrors, CustomerPortalSubscriptionsCancelResponse, CustomerPortalSubscriptionsCancelResponses, CustomerPortalSubscriptionsGetData, CustomerPortalSubscriptionsGetErrors, CustomerPortalSubscriptionsGetResponse, CustomerPortalSubscriptionsGetResponses, CustomerPortalSubscriptionsListData, CustomerPortalSubscriptionsListErrors, CustomerPortalSubscriptionsListResponse, CustomerPortalSubscriptionsListResponses, type CustomerResource, CustomersCreateData, CustomersCreateErrors, CustomersCreateResponse, CustomersCreateResponses, CustomersGetData, CustomersGetErrors, CustomersGetResponse, CustomersGetResponses, CustomersListData, CustomersListErrors, CustomersListResponse, CustomersListResponses, CustomersPaymentMethodsListData, CustomersPaymentMethodsListErrors, CustomersPaymentMethodsListResponse, CustomersPaymentMethodsListResponses, CustomersPaymentRailsGetData, CustomersPaymentRailsGetErrors, CustomersPaymentRailsGetResponse, CustomersPaymentRailsGetResponses, CustomersPreferredRailsGetData, CustomersPreferredRailsGetErrors, CustomersPreferredRailsGetResponse, CustomersPreferredRailsGetResponses, type CustomersResource, CustomersUpdateData, CustomersUpdateErrors, CustomersUpdateResponse, CustomersUpdateResponses, DdMandateRequestsGetData, DdMandateRequestsGetErrors, DdMandateRequestsGetResponse, DdMandateRequestsGetResponses, DdPreviewData, DdPreviewErrors, DdPreviewResponse, DdPreviewResponses, type DdResource, DdValidateData, DdValidateErrors, DdValidateResponse, DdValidateResponses, DryRunResult, EntitlementsCheckData, EntitlementsCheckErrors, EntitlementsCheckResponse, EntitlementsCheckResponses, EntitlementsListData, EntitlementsListErrors, EntitlementsListResponse, EntitlementsListResponses, type EntitlementsResource, EventsGetData, EventsGetErrors, EventsGetResponse, EventsGetResponses, EventsListData, EventsListErrors, EventsListResponse, EventsListResponses, EventsResendData, EventsResendErrors, EventsResendResponse, EventsResendResponses, type EventsResource, type GeneratedResourceRuntime, type GeneratedResources, InvoicesCreateData, InvoicesCreateResponse, InvoicesCreateResponses, InvoicesFinalizeData, InvoicesFinalizeErrors, InvoicesFinalizeResponse, InvoicesFinalizeResponses, InvoicesGetData, InvoicesGetResponse, InvoicesGetResponses, InvoicesListData, InvoicesListResponse, InvoicesListResponses, InvoicesMarginEstimateData, InvoicesMarginEstimateErrors, InvoicesMarginEstimateResponse, InvoicesMarginEstimateResponses, type InvoicesResource, InvoicesSendData, InvoicesSendErrors, InvoicesSendResponse, InvoicesSendResponses, InvoicesUpdateData, InvoicesUpdateResponse, InvoicesUpdateResponses, InvoicesVoidData, InvoicesVoidErrors, InvoicesVoidResponse, InvoicesVoidResponses, MandatesCancelData, MandatesCancelErrors, MandatesCancelResponse, MandatesCancelResponses, MandatesCreateData, MandatesCreateErrors, MandatesCreateResponse, MandatesCreateResponses, MandatesGetData, MandatesGetErrors, MandatesGetResponse, MandatesGetResponses, MandatesListData, MandatesListErrors, MandatesListResponse, MandatesListResponses, MandatesReinstateData, MandatesReinstateErrors, MandatesReinstateResponse, MandatesReinstateResponses, type MandatesResource, MandatesScheduleCollectionData, MandatesScheduleCollectionErrors, MandatesScheduleCollectionResponse, MandatesScheduleCollectionResponses, MandatesSuspendData, MandatesSuspendErrors, MandatesSuspendResponse, MandatesSuspendResponses, OAuthConfig, type Options, PaymentIntentsCancelData, PaymentIntentsCancelErrors, PaymentIntentsCancelResponse, PaymentIntentsCancelResponses, PaymentIntentsCaptureData, PaymentIntentsCaptureErrors, PaymentIntentsCaptureResponse, PaymentIntentsCaptureResponses, PaymentIntentsConfirmData, PaymentIntentsConfirmErrors, PaymentIntentsConfirmResponse, PaymentIntentsConfirmResponses, PaymentIntentsCreateData, PaymentIntentsCreateErrors, PaymentIntentsCreateResponse, PaymentIntentsCreateResponses, PaymentIntentsGetData, PaymentIntentsGetErrors, PaymentIntentsGetResponse, PaymentIntentsGetResponses, PaymentIntentsListData, PaymentIntentsListErrors, PaymentIntentsListResponse, PaymentIntentsListResponses, type PaymentIntentsResource, PaymentLinksActivateData, PaymentLinksActivateErrors, PaymentLinksActivateResponse, PaymentLinksActivateResponses, PaymentLinksArchiveData, PaymentLinksArchiveErrors, PaymentLinksArchiveResponse, PaymentLinksArchiveResponses, PaymentLinksCreateData, PaymentLinksCreateErrors, PaymentLinksCreateResponse, PaymentLinksCreateResponses, PaymentLinksDeactivateData, PaymentLinksDeactivateErrors, PaymentLinksDeactivateResponse, PaymentLinksDeactivateResponses, PaymentLinksExpireData, PaymentLinksExpireErrors, PaymentLinksExpireResponse, PaymentLinksExpireResponses, PaymentLinksGetData, PaymentLinksGetErrors, PaymentLinksGetResponse, PaymentLinksGetResponses, PaymentLinksListData, PaymentLinksListErrors, PaymentLinksListResponse, PaymentLinksListResponses, type PaymentLinksResource, PaymentLinksUpdateData, PaymentLinksUpdateErrors, PaymentLinksUpdateResponse, PaymentLinksUpdateResponses, PricesArchiveData, PricesArchiveErrors, PricesArchiveResponse, PricesArchiveResponses, PricesCreateData, PricesCreateErrors, PricesCreateResponse, PricesCreateResponses, PricesGetData, PricesGetErrors, PricesGetResponse, PricesGetResponses, PricesListData, PricesListErrors, PricesListResponse, PricesListResponses, type PricesResource, PricesUpdateData, PricesUpdateErrors, PricesUpdateResponse, PricesUpdateResponses, ProductsCreateData, ProductsCreateErrors, ProductsCreateResponse, ProductsCreateResponses, ProductsGetData, ProductsGetErrors, ProductsGetResponse, ProductsGetResponses, ProductsListData, ProductsListErrors, ProductsListResponse, ProductsListResponses, type ProductsResource, ProductsUpdateData, ProductsUpdateErrors, ProductsUpdateResponse, ProductsUpdateResponses, RefundsCreateData, RefundsCreateErrors, RefundsCreateResponse, RefundsCreateResponses, RefundsGetData, RefundsGetErrors, RefundsGetResponse, RefundsGetResponses, RefundsListData, RefundsListErrors, RefundsListResponse, RefundsListResponses, type RefundsResource, RevKeenClient as RevKeen, RevKeenAPIError, RevKeenClient, type RevKeenClientOptions, RevKeenError, RevKeenTimeoutError, StorefrontOriginsCreateData, StorefrontOriginsCreateErrors, StorefrontOriginsCreateResponse, StorefrontOriginsCreateResponses, StorefrontOriginsDeleteData, StorefrontOriginsDeleteErrors, StorefrontOriginsDeleteResponse, StorefrontOriginsDeleteResponses, StorefrontOriginsListData, StorefrontOriginsListErrors, StorefrontOriginsListResponse, StorefrontOriginsListResponses, StorefrontProductsGetData, StorefrontProductsGetErrors, StorefrontProductsGetResponse, StorefrontProductsGetResponses, StorefrontProductsListData, StorefrontProductsListErrors, StorefrontProductsListResponse, StorefrontProductsListResponses, type StorefrontResource, StorefrontStatusGetData, StorefrontStatusGetErrors, StorefrontStatusGetResponse, StorefrontStatusGetResponses, SubscriptionsCancelData, SubscriptionsCancelErrors, SubscriptionsCancelResponse, SubscriptionsCancelResponses, SubscriptionsCreateData, SubscriptionsCreateErrors, SubscriptionsCreateResponse, SubscriptionsCreateResponses, SubscriptionsGetData, SubscriptionsGetErrors, SubscriptionsGetResponse, SubscriptionsGetResponses, SubscriptionsListData, SubscriptionsListErrors, SubscriptionsListResponse, SubscriptionsListResponses, type SubscriptionsResource, SubscriptionsUpdateData, SubscriptionsUpdateErrors, SubscriptionsUpdateResponse, SubscriptionsUpdateResponses, TransactionsGetData, TransactionsGetErrors, TransactionsGetResponse, TransactionsGetResponses, TransactionsListData, TransactionsListErrors, TransactionsListResponse, TransactionsListResponses, type TransactionsResource, UsageIngestRequest, type UsageResource, WebhookDeliveriesGetData, WebhookDeliveriesGetErrors, WebhookDeliveriesGetResponse, WebhookDeliveriesGetResponses, WebhookDeliveriesListData, WebhookDeliveriesListErrors, WebhookDeliveriesListResponse, WebhookDeliveriesListResponses, WebhookDeliveriesRetryData, WebhookDeliveriesRetryErrors, WebhookDeliveriesRetryResponse, WebhookDeliveriesRetryResponses, WebhookEndpointsCreateData, WebhookEndpointsCreateErrors, WebhookEndpointsCreateResponse, WebhookEndpointsCreateResponses, WebhookEndpointsDeleteData, WebhookEndpointsDeleteErrors, WebhookEndpointsDeleteResponse, WebhookEndpointsDeleteResponses, WebhookEndpointsGetData, WebhookEndpointsGetErrors, WebhookEndpointsGetResponse, WebhookEndpointsGetResponses, WebhookEndpointsListData, WebhookEndpointsListErrors, WebhookEndpointsListResponse, WebhookEndpointsListResponses, type WebhookEndpointsResource, WebhookEndpointsRotateSecretData, WebhookEndpointsRotateSecretErrors, WebhookEndpointsRotateSecretResponse, WebhookEndpointsRotateSecretResponses, WebhookEndpointsUpdateData, WebhookEndpointsUpdateErrors, WebhookEndpointsUpdateResponse, WebhookEndpointsUpdateResponses, type WebhookResource, accountingInvoicePaymentRequestsCreate, accountingInvoicePaymentRequestsGet, analyticsRevenueMrrSummary, analyticsRevenueTimeSeries, buildGeneratedResources, cartApiKeysEnsure, cartApiKeysRotate, cartApiKeysStatus, cartSessionsAddLineItem, cartSessionsApplyDiscountCode, cartSessionsConvert, cartSessionsCreate, cartSessionsGet, cartSessionsRemoveLineItem, cartSessionsSetContact, cartSessionsToggleAddOn, cartSessionsUpdateLineItem, checkoutSessionsCreate, checkoutSessionsExpire, checkoutSessionsGet, creditNotesCreate, creditNotesGet, creditNotesList, creditNotesListLines, creditNotesPreview, creditNotesVoid, customerMetersGet, customerMetersList, customerPortalCustomerGet, customerPortalInvoicesGet, customerPortalInvoicesList, customerPortalMandatesCancel, customerPortalMandatesList, customerPortalMandatesReauthorize, customerPortalMandatesReauthorizeSendOtp, customerPortalMandatesReauthorizeVerifyOtp, customerPortalSessionsCreate, customerPortalSubscriptionsCancel, customerPortalSubscriptionsGet, customerPortalSubscriptionsList, customersCreate, customersGet, customersList, customersPaymentMethodsList, customersPaymentRailsGet, customersPreferredRailsGet, customersUpdate, ddMandateRequestsGet, ddPreview, ddValidate, RevKeenClient as default, entitlementsCheck, entitlementsList, eventsGet, eventsList, eventsResend, invoicesCreate, invoicesFinalize, invoicesGet, invoicesList, invoicesMarginEstimate, invoicesSend, invoicesUpdate, invoicesVoid, mandatesCancel, mandatesCreate, mandatesGet, mandatesList, mandatesReinstate, mandatesScheduleCollection, mandatesSuspend, paymentIntentsCancel, paymentIntentsCapture, paymentIntentsConfirm, paymentIntentsCreate, paymentIntentsGet, paymentIntentsList, paymentLinksActivate, paymentLinksArchive, paymentLinksCreate, paymentLinksDeactivate, paymentLinksExpire, paymentLinksGet, paymentLinksList, paymentLinksUpdate, pricesArchive, pricesCreate, pricesGet, pricesList, pricesUpdate, productsCreate, productsGet, productsList, productsUpdate, refundsCreate, refundsGet, refundsList, storefrontOriginsCreate, storefrontOriginsDelete, storefrontOriginsList, storefrontProductsGet, storefrontProductsList, storefrontStatusGet, subscriptionsCancel, subscriptionsCreate, subscriptionsGet, subscriptionsList, subscriptionsUpdate, transactionsGet, transactionsList, webhookDeliveriesGet, webhookDeliveriesList, webhookDeliveriesRetry, webhookEndpointsCreate, webhookEndpointsDelete, webhookEndpointsGet, webhookEndpointsList, webhookEndpointsRotateSecret, webhookEndpointsUpdate };