@delopay/sdk 0.100.0 → 0.101.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-HK4S2SQB.js → chunk-NLUEZQZF.js} +61 -8
- package/dist/chunk-NLUEZQZF.js.map +1 -0
- package/dist/index.cjs +60 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +101 -11
- package/dist/index.d.ts +101 -11
- package/dist/index.js +1 -1
- package/dist/internal.cjs +60 -7
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +2 -2
- package/dist/internal.d.ts +2 -2
- package/dist/internal.js +1 -1
- package/dist/internal.js.map +1 -1
- package/package.json +17 -18
- package/dist/chunk-HK4S2SQB.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -1965,7 +1965,7 @@ interface ApiKeyCreateResponse {
|
|
|
1965
1965
|
/**
|
|
1966
1966
|
* The shop (business profile) this key is pinned to, or `null`/absent for
|
|
1967
1967
|
* merchant-wide keys. Only populated by backends with profile-scoped API
|
|
1968
|
-
* key support
|
|
1968
|
+
* key support; absent on older backends.
|
|
1969
1969
|
*/
|
|
1970
1970
|
profile_id?: string | null;
|
|
1971
1971
|
}
|
|
@@ -1981,7 +1981,7 @@ interface ApiKeyResponse {
|
|
|
1981
1981
|
/**
|
|
1982
1982
|
* The shop (business profile) this key is pinned to, or `null`/absent for
|
|
1983
1983
|
* merchant-wide keys. Only populated by backends with profile-scoped API
|
|
1984
|
-
* key support
|
|
1984
|
+
* key support; absent on older backends.
|
|
1985
1985
|
*/
|
|
1986
1986
|
profile_id?: string | null;
|
|
1987
1987
|
}
|
|
@@ -2127,7 +2127,7 @@ interface ProfileDeniedConnectorsResponse {
|
|
|
2127
2127
|
denied_connectors: string[];
|
|
2128
2128
|
}
|
|
2129
2129
|
/**
|
|
2130
|
-
* A buyer-facing surcharge added to the checkout amount
|
|
2130
|
+
* A buyer-facing surcharge added to the checkout amount.
|
|
2131
2131
|
*
|
|
2132
2132
|
* Either a flat amount in minor units, or a percentage of the order amount.
|
|
2133
2133
|
*/
|
|
@@ -3524,6 +3524,49 @@ interface SubscriptionInvoice {
|
|
|
3524
3524
|
billing_processor_invoice_id?: string | null;
|
|
3525
3525
|
/** Connector (billing processor) this invoice was raised through, e.g. `paypal`. */
|
|
3526
3526
|
provider_name?: Connector | null;
|
|
3527
|
+
/**
|
|
3528
|
+
* Refunded against this cycle so far, in the invoice's currency and minor units.
|
|
3529
|
+
*
|
|
3530
|
+
* `amount` stays **gross**: this is reported beside it and never subtracted
|
|
3531
|
+
* from it, because a netted figure cannot be told apart from a smaller charge.
|
|
3532
|
+
*
|
|
3533
|
+
* `null` means the billing processor reported no figure, which is not the
|
|
3534
|
+
* same as `0` — `0` says it answered and nothing was refunded. Render the
|
|
3535
|
+
* absence rather than defaulting it to zero.
|
|
3536
|
+
*/
|
|
3537
|
+
refunded_amount?: number | null;
|
|
3538
|
+
/** ISO 8601 timestamp of when this invoice was recorded. */
|
|
3539
|
+
created_at?: string | null;
|
|
3540
|
+
}
|
|
3541
|
+
/**
|
|
3542
|
+
* One subscription's billing history, returned by
|
|
3543
|
+
* `GET /subscriptions/{id}/invoices`.
|
|
3544
|
+
*/
|
|
3545
|
+
interface SubscriptionInvoiceListResponse {
|
|
3546
|
+
/** Recorded billing cycles, newest first. */
|
|
3547
|
+
invoices: SubscriptionInvoice[];
|
|
3548
|
+
}
|
|
3549
|
+
/** Paging for {@link SubscriptionInvoiceListResponse}. */
|
|
3550
|
+
interface SubscriptionInvoiceListParams {
|
|
3551
|
+
/** Maximum cycles to return. Clamped server-side to 100. */
|
|
3552
|
+
limit?: number;
|
|
3553
|
+
/** Cycles to skip, counting from the newest. */
|
|
3554
|
+
offset?: number;
|
|
3555
|
+
}
|
|
3556
|
+
/**
|
|
3557
|
+
* The billing processor a shop's subscriptions run on, returned by
|
|
3558
|
+
* `GET /subscriptions/billing_processor`.
|
|
3559
|
+
*
|
|
3560
|
+
* Identity only, deliberately not capabilities: how a processor originates a
|
|
3561
|
+
* subscription, whether its trials are configurable and whether a cancel takes
|
|
3562
|
+
* effect immediately are client-side concerns that belong in one place on the
|
|
3563
|
+
* client rather than half here.
|
|
3564
|
+
*/
|
|
3565
|
+
interface SubscriptionBillingProcessorResponse {
|
|
3566
|
+
/** The merchant connector account named as the shop's `billing_processor_id`. */
|
|
3567
|
+
merchant_connector_id: string;
|
|
3568
|
+
/** The connector behind it, e.g. `creem`, `paypal` or `stripebilling`. */
|
|
3569
|
+
connector_name: Connector;
|
|
3527
3570
|
}
|
|
3528
3571
|
/** A purchasable price option for a subscription item (plan or addon). */
|
|
3529
3572
|
interface SubscriptionItemPrice {
|
|
@@ -4731,7 +4774,7 @@ interface SettlementLineBase {
|
|
|
4731
4774
|
}
|
|
4732
4775
|
/**
|
|
4733
4776
|
* A line whose processor cost is known — the rail reported it, or a
|
|
4734
|
-
* configured schedule estimated it
|
|
4777
|
+
* configured schedule estimated it.
|
|
4735
4778
|
*
|
|
4736
4779
|
* `processor_cost_amount` is minor units of `processor_cost_currency`, which
|
|
4737
4780
|
* is the processor's **own** settlement currency and not necessarily the
|
|
@@ -4822,7 +4865,7 @@ type LimitedOperation = 'refund';
|
|
|
4822
4865
|
type OperationLimitScope = 'merchant' | 'role' | 'user';
|
|
4823
4866
|
/**
|
|
4824
4867
|
* What happens when an operation would exceed its limit. v1 ships `block`
|
|
4825
|
-
* only; `require_approval` (four-eyes) arrives
|
|
4868
|
+
* only; `require_approval` (four-eyes) arrives in a later release.
|
|
4826
4869
|
*/
|
|
4827
4870
|
type OperationLimitOnExceeded = 'block';
|
|
4828
4871
|
/** How the usage window is anchored. Rolling is the default. */
|
|
@@ -7758,6 +7801,46 @@ declare class Subscriptions {
|
|
|
7758
7801
|
* At most 200 ids per call.
|
|
7759
7802
|
*/
|
|
7760
7803
|
lookupPayments(params: SubscriptionPaymentLookupRequest, options?: RequestExtras): Promise<SubscriptionPaymentLookupResponse>;
|
|
7804
|
+
/**
|
|
7805
|
+
* One subscription's billing history, newest cycle first.
|
|
7806
|
+
* `GET /subscriptions/{subscriptionId}/invoices`
|
|
7807
|
+
*
|
|
7808
|
+
* {@link retrieve} carries only the *latest* invoice, which is the current
|
|
7809
|
+
* cycle — a subscription that has renewed monthly for a year has one of those
|
|
7810
|
+
* and twelve of these. Use this wherever a merchant needs to see what a
|
|
7811
|
+
* subscription has actually billed, in particular on self-charging processors
|
|
7812
|
+
* (Creem, PayPal) where each renewal is charged by the processor and mirrored
|
|
7813
|
+
* here rather than raised as a DeloPay payment.
|
|
7814
|
+
*
|
|
7815
|
+
* Two things to render honestly, both decided rather than incidental:
|
|
7816
|
+
*
|
|
7817
|
+
* - `amount` is **gross** and `refunded_amount` sits beside it. Do not net
|
|
7818
|
+
* them: the difference between the two is not a smaller charge.
|
|
7819
|
+
* - A `refunded_amount` of `null` is "not reported" and must not render as
|
|
7820
|
+
* `0`. Likewise a processor-hosted origination records a bootstrap invoice
|
|
7821
|
+
* at `0` before the buyer has paid anything, so a zero amount on such a
|
|
7822
|
+
* subscription is a placeholder rather than a free cycle.
|
|
7823
|
+
*
|
|
7824
|
+
* Profile-scoped like every other subscription route.
|
|
7825
|
+
*/
|
|
7826
|
+
listInvoices(subscriptionId: string, params?: SubscriptionInvoiceListParams, options?: RequestExtras): Promise<SubscriptionInvoiceListResponse>;
|
|
7827
|
+
/**
|
|
7828
|
+
* Which billing processor this shop's subscriptions run on.
|
|
7829
|
+
* `GET /subscriptions/billing_processor`
|
|
7830
|
+
*
|
|
7831
|
+
* The same mapping is derivable from the connector inventory
|
|
7832
|
+
* (`GET /account/{merchant_id}/connectors`), but that route is gated by a
|
|
7833
|
+
* connector-read permission granted independently of subscriptions — so a
|
|
7834
|
+
* role authorised to create subscriptions could be unable to learn which
|
|
7835
|
+
* processor it was creating them on. This answers under the same
|
|
7836
|
+
* authorization as the rest of the subscription API.
|
|
7837
|
+
*
|
|
7838
|
+
* Reach for it when the client must branch on the processor *before* calling
|
|
7839
|
+
* — origination differs by processor, and guessing is destructive. Resolve
|
|
7840
|
+
* the shop's `billing_processor_id` first: a shop that runs no subscriptions
|
|
7841
|
+
* has none assigned, and this route has no identity to report for it.
|
|
7842
|
+
*/
|
|
7843
|
+
getBillingProcessor(options?: RequestExtras): Promise<SubscriptionBillingProcessorResponse>;
|
|
7761
7844
|
}
|
|
7762
7845
|
|
|
7763
7846
|
/**
|
|
@@ -8777,7 +8860,7 @@ declare class CheckoutSession {
|
|
|
8777
8860
|
* own types and runtime gates — hence the loose return type.
|
|
8778
8861
|
*
|
|
8779
8862
|
* `theme` is the route's one declared query parameter (a named checkout
|
|
8780
|
-
* variant
|
|
8863
|
+
* variant). `locale` travels as `Accept-Language` — the only
|
|
8781
8864
|
* channel the backend's locale resolution reads; a `?locale=` query is
|
|
8782
8865
|
* silently ignored by this route.
|
|
8783
8866
|
*
|
|
@@ -8857,10 +8940,17 @@ declare class CheckoutSession {
|
|
|
8857
8940
|
/**
|
|
8858
8941
|
* A short-lived VGS Collect session for browser-side card capture.
|
|
8859
8942
|
*
|
|
8860
|
-
*
|
|
8861
|
-
*
|
|
8862
|
-
*
|
|
8863
|
-
*
|
|
8943
|
+
* **Exactly one refusal means "this shop has no vault": a 400 carrying
|
|
8944
|
+
* `IR_19`.** Every other refusal means a vault exists and could not be used,
|
|
8945
|
+
* and answering it by falling back to the processor's own card pane sends an
|
|
8946
|
+
* unprotected card number to the very processor the shop pays to hide it
|
|
8947
|
+
* from — the bug this endpoint's error contract exists to prevent.
|
|
8948
|
+
*
|
|
8949
|
+
* A **404 is not benign.** The router answers it when the shop's vault
|
|
8950
|
+
* account cannot be found — the state a shop is left in when its vault
|
|
8951
|
+
* connector is deleted while the profile keeps naming the id: it still
|
|
8952
|
+
* reports the vault as enabled and still expects its cards cloaked. The same
|
|
8953
|
+
* status also covers a payment that does not exist.
|
|
8864
8954
|
*
|
|
8865
8955
|
* `GET /payment-link/{merchantId}/{paymentId}/vault/collect-session`
|
|
8866
8956
|
*/
|
|
@@ -9135,4 +9225,4 @@ declare function focusedCheckoutUrl(params: FocusedCheckoutUrlParams): string;
|
|
|
9135
9225
|
declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned"];
|
|
9136
9226
|
type CheckoutEventKind = (typeof CHECKOUT_EVENT_KINDS)[number];
|
|
9137
9227
|
|
|
9138
|
-
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountFilter, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type CheckoutThemeComparisonSide, type CheckoutThemeConversionCaveat, type CheckoutThemeConversionCell, type CheckoutThemeConversionComparison, type CheckoutThemeConversionQuery, type CheckoutThemeConversionResponse, type CheckoutThemeConversionSegment, type CheckoutThemeDenominatorBasis, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type CheckoutThemeSampleVerdict, type ClientAnalyticsCaveat, type ClientAnalyticsFilters, type ClientAnalyticsRequest, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillRequest, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillPayment, type DrillResponse, type EncodedBranding, type EpayoutsCatalogEntry, type EpayoutsCatalogResponse, type EpayoutsLocality, type EpayoutsMethod, type EpayoutsMethodsResponse, type EpayoutsRail, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeStatementDetail, type FeeStatementSummary, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GeoAnalyticsChild, type GeoAnalyticsResponse, type GeoAnalyticsTotals, type GeoCitySlice, type GeoCountrySlice, type GeoDrillRequest, type GeoLanguageSlice, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListFilterConstraints, type PaymentListFilteredResponse, type PaymentListOrder, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PaymentsDeletePolicyResponse, type PaymentsDeleteResponse, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PayseproMethod, type PayseproMethodsResponse, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostSource, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopSettlementOverview, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type ShopVisibilityResponse, type ShopVisibilityUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StatementAdjustment, type StatementAdjustmentCreateRequest, type StatementAdjustmentListResponse, type StatementGenerateRequest, type StatementPayoutUpdateRequest, type StatementPdfParams, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TimeToPayBucket, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VaultCheck, type VaultCheckId, type VaultCheckStatus, type VaultCollectSessionResponse, type VaultEnvironment, type VaultPaymentMethodRequest, type VaultPaymentMethodResponse, type VaultRouteApplyVerification, type VaultRouteChange, type VaultRouteChangeKind, type VaultRouteFieldChange, type VaultRouteIds, type VaultRoutePurpose, type VaultRouteWarning, type VaultRouteWarningCode, type VaultRoutesApplyRequest, type VaultRoutesApplyResponse, type VaultRoutesFingerprint, type VaultRoutesPreviewRequest, type VaultRoutesPreviewResponse, type VaultVerificationResponse, type VaultVerifyRequest, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|
|
9228
|
+
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountFilter, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type CheckoutThemeComparisonSide, type CheckoutThemeConversionCaveat, type CheckoutThemeConversionCell, type CheckoutThemeConversionComparison, type CheckoutThemeConversionQuery, type CheckoutThemeConversionResponse, type CheckoutThemeConversionSegment, type CheckoutThemeDenominatorBasis, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type CheckoutThemeSampleVerdict, type ClientAnalyticsCaveat, type ClientAnalyticsFilters, type ClientAnalyticsRequest, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillRequest, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillPayment, type DrillResponse, type EncodedBranding, type EpayoutsCatalogEntry, type EpayoutsCatalogResponse, type EpayoutsLocality, type EpayoutsMethod, type EpayoutsMethodsResponse, type EpayoutsRail, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeStatementDetail, type FeeStatementSummary, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GeoAnalyticsChild, type GeoAnalyticsResponse, type GeoAnalyticsTotals, type GeoCitySlice, type GeoCountrySlice, type GeoDrillRequest, type GeoLanguageSlice, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListFilterConstraints, type PaymentListFilteredResponse, type PaymentListOrder, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PaymentsDeletePolicyResponse, type PaymentsDeleteResponse, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PayseproMethod, type PayseproMethodsResponse, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostSource, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopSettlementOverview, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type ShopVisibilityResponse, type ShopVisibilityUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StatementAdjustment, type StatementAdjustmentCreateRequest, type StatementAdjustmentListResponse, type StatementGenerateRequest, type StatementPayoutUpdateRequest, type StatementPdfParams, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionBillingProcessorResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionInvoiceListParams, type SubscriptionInvoiceListResponse, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TimeToPayBucket, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VaultCheck, type VaultCheckId, type VaultCheckStatus, type VaultCollectSessionResponse, type VaultEnvironment, type VaultPaymentMethodRequest, type VaultPaymentMethodResponse, type VaultRouteApplyVerification, type VaultRouteChange, type VaultRouteChangeKind, type VaultRouteFieldChange, type VaultRouteIds, type VaultRoutePurpose, type VaultRouteWarning, type VaultRouteWarningCode, type VaultRoutesApplyRequest, type VaultRoutesApplyResponse, type VaultRoutesFingerprint, type VaultRoutesPreviewRequest, type VaultRoutesPreviewResponse, type VaultVerificationResponse, type VaultVerifyRequest, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|
package/dist/index.d.ts
CHANGED
|
@@ -1965,7 +1965,7 @@ interface ApiKeyCreateResponse {
|
|
|
1965
1965
|
/**
|
|
1966
1966
|
* The shop (business profile) this key is pinned to, or `null`/absent for
|
|
1967
1967
|
* merchant-wide keys. Only populated by backends with profile-scoped API
|
|
1968
|
-
* key support
|
|
1968
|
+
* key support; absent on older backends.
|
|
1969
1969
|
*/
|
|
1970
1970
|
profile_id?: string | null;
|
|
1971
1971
|
}
|
|
@@ -1981,7 +1981,7 @@ interface ApiKeyResponse {
|
|
|
1981
1981
|
/**
|
|
1982
1982
|
* The shop (business profile) this key is pinned to, or `null`/absent for
|
|
1983
1983
|
* merchant-wide keys. Only populated by backends with profile-scoped API
|
|
1984
|
-
* key support
|
|
1984
|
+
* key support; absent on older backends.
|
|
1985
1985
|
*/
|
|
1986
1986
|
profile_id?: string | null;
|
|
1987
1987
|
}
|
|
@@ -2127,7 +2127,7 @@ interface ProfileDeniedConnectorsResponse {
|
|
|
2127
2127
|
denied_connectors: string[];
|
|
2128
2128
|
}
|
|
2129
2129
|
/**
|
|
2130
|
-
* A buyer-facing surcharge added to the checkout amount
|
|
2130
|
+
* A buyer-facing surcharge added to the checkout amount.
|
|
2131
2131
|
*
|
|
2132
2132
|
* Either a flat amount in minor units, or a percentage of the order amount.
|
|
2133
2133
|
*/
|
|
@@ -3524,6 +3524,49 @@ interface SubscriptionInvoice {
|
|
|
3524
3524
|
billing_processor_invoice_id?: string | null;
|
|
3525
3525
|
/** Connector (billing processor) this invoice was raised through, e.g. `paypal`. */
|
|
3526
3526
|
provider_name?: Connector | null;
|
|
3527
|
+
/**
|
|
3528
|
+
* Refunded against this cycle so far, in the invoice's currency and minor units.
|
|
3529
|
+
*
|
|
3530
|
+
* `amount` stays **gross**: this is reported beside it and never subtracted
|
|
3531
|
+
* from it, because a netted figure cannot be told apart from a smaller charge.
|
|
3532
|
+
*
|
|
3533
|
+
* `null` means the billing processor reported no figure, which is not the
|
|
3534
|
+
* same as `0` — `0` says it answered and nothing was refunded. Render the
|
|
3535
|
+
* absence rather than defaulting it to zero.
|
|
3536
|
+
*/
|
|
3537
|
+
refunded_amount?: number | null;
|
|
3538
|
+
/** ISO 8601 timestamp of when this invoice was recorded. */
|
|
3539
|
+
created_at?: string | null;
|
|
3540
|
+
}
|
|
3541
|
+
/**
|
|
3542
|
+
* One subscription's billing history, returned by
|
|
3543
|
+
* `GET /subscriptions/{id}/invoices`.
|
|
3544
|
+
*/
|
|
3545
|
+
interface SubscriptionInvoiceListResponse {
|
|
3546
|
+
/** Recorded billing cycles, newest first. */
|
|
3547
|
+
invoices: SubscriptionInvoice[];
|
|
3548
|
+
}
|
|
3549
|
+
/** Paging for {@link SubscriptionInvoiceListResponse}. */
|
|
3550
|
+
interface SubscriptionInvoiceListParams {
|
|
3551
|
+
/** Maximum cycles to return. Clamped server-side to 100. */
|
|
3552
|
+
limit?: number;
|
|
3553
|
+
/** Cycles to skip, counting from the newest. */
|
|
3554
|
+
offset?: number;
|
|
3555
|
+
}
|
|
3556
|
+
/**
|
|
3557
|
+
* The billing processor a shop's subscriptions run on, returned by
|
|
3558
|
+
* `GET /subscriptions/billing_processor`.
|
|
3559
|
+
*
|
|
3560
|
+
* Identity only, deliberately not capabilities: how a processor originates a
|
|
3561
|
+
* subscription, whether its trials are configurable and whether a cancel takes
|
|
3562
|
+
* effect immediately are client-side concerns that belong in one place on the
|
|
3563
|
+
* client rather than half here.
|
|
3564
|
+
*/
|
|
3565
|
+
interface SubscriptionBillingProcessorResponse {
|
|
3566
|
+
/** The merchant connector account named as the shop's `billing_processor_id`. */
|
|
3567
|
+
merchant_connector_id: string;
|
|
3568
|
+
/** The connector behind it, e.g. `creem`, `paypal` or `stripebilling`. */
|
|
3569
|
+
connector_name: Connector;
|
|
3527
3570
|
}
|
|
3528
3571
|
/** A purchasable price option for a subscription item (plan or addon). */
|
|
3529
3572
|
interface SubscriptionItemPrice {
|
|
@@ -4731,7 +4774,7 @@ interface SettlementLineBase {
|
|
|
4731
4774
|
}
|
|
4732
4775
|
/**
|
|
4733
4776
|
* A line whose processor cost is known — the rail reported it, or a
|
|
4734
|
-
* configured schedule estimated it
|
|
4777
|
+
* configured schedule estimated it.
|
|
4735
4778
|
*
|
|
4736
4779
|
* `processor_cost_amount` is minor units of `processor_cost_currency`, which
|
|
4737
4780
|
* is the processor's **own** settlement currency and not necessarily the
|
|
@@ -4822,7 +4865,7 @@ type LimitedOperation = 'refund';
|
|
|
4822
4865
|
type OperationLimitScope = 'merchant' | 'role' | 'user';
|
|
4823
4866
|
/**
|
|
4824
4867
|
* What happens when an operation would exceed its limit. v1 ships `block`
|
|
4825
|
-
* only; `require_approval` (four-eyes) arrives
|
|
4868
|
+
* only; `require_approval` (four-eyes) arrives in a later release.
|
|
4826
4869
|
*/
|
|
4827
4870
|
type OperationLimitOnExceeded = 'block';
|
|
4828
4871
|
/** How the usage window is anchored. Rolling is the default. */
|
|
@@ -7758,6 +7801,46 @@ declare class Subscriptions {
|
|
|
7758
7801
|
* At most 200 ids per call.
|
|
7759
7802
|
*/
|
|
7760
7803
|
lookupPayments(params: SubscriptionPaymentLookupRequest, options?: RequestExtras): Promise<SubscriptionPaymentLookupResponse>;
|
|
7804
|
+
/**
|
|
7805
|
+
* One subscription's billing history, newest cycle first.
|
|
7806
|
+
* `GET /subscriptions/{subscriptionId}/invoices`
|
|
7807
|
+
*
|
|
7808
|
+
* {@link retrieve} carries only the *latest* invoice, which is the current
|
|
7809
|
+
* cycle — a subscription that has renewed monthly for a year has one of those
|
|
7810
|
+
* and twelve of these. Use this wherever a merchant needs to see what a
|
|
7811
|
+
* subscription has actually billed, in particular on self-charging processors
|
|
7812
|
+
* (Creem, PayPal) where each renewal is charged by the processor and mirrored
|
|
7813
|
+
* here rather than raised as a DeloPay payment.
|
|
7814
|
+
*
|
|
7815
|
+
* Two things to render honestly, both decided rather than incidental:
|
|
7816
|
+
*
|
|
7817
|
+
* - `amount` is **gross** and `refunded_amount` sits beside it. Do not net
|
|
7818
|
+
* them: the difference between the two is not a smaller charge.
|
|
7819
|
+
* - A `refunded_amount` of `null` is "not reported" and must not render as
|
|
7820
|
+
* `0`. Likewise a processor-hosted origination records a bootstrap invoice
|
|
7821
|
+
* at `0` before the buyer has paid anything, so a zero amount on such a
|
|
7822
|
+
* subscription is a placeholder rather than a free cycle.
|
|
7823
|
+
*
|
|
7824
|
+
* Profile-scoped like every other subscription route.
|
|
7825
|
+
*/
|
|
7826
|
+
listInvoices(subscriptionId: string, params?: SubscriptionInvoiceListParams, options?: RequestExtras): Promise<SubscriptionInvoiceListResponse>;
|
|
7827
|
+
/**
|
|
7828
|
+
* Which billing processor this shop's subscriptions run on.
|
|
7829
|
+
* `GET /subscriptions/billing_processor`
|
|
7830
|
+
*
|
|
7831
|
+
* The same mapping is derivable from the connector inventory
|
|
7832
|
+
* (`GET /account/{merchant_id}/connectors`), but that route is gated by a
|
|
7833
|
+
* connector-read permission granted independently of subscriptions — so a
|
|
7834
|
+
* role authorised to create subscriptions could be unable to learn which
|
|
7835
|
+
* processor it was creating them on. This answers under the same
|
|
7836
|
+
* authorization as the rest of the subscription API.
|
|
7837
|
+
*
|
|
7838
|
+
* Reach for it when the client must branch on the processor *before* calling
|
|
7839
|
+
* — origination differs by processor, and guessing is destructive. Resolve
|
|
7840
|
+
* the shop's `billing_processor_id` first: a shop that runs no subscriptions
|
|
7841
|
+
* has none assigned, and this route has no identity to report for it.
|
|
7842
|
+
*/
|
|
7843
|
+
getBillingProcessor(options?: RequestExtras): Promise<SubscriptionBillingProcessorResponse>;
|
|
7761
7844
|
}
|
|
7762
7845
|
|
|
7763
7846
|
/**
|
|
@@ -8777,7 +8860,7 @@ declare class CheckoutSession {
|
|
|
8777
8860
|
* own types and runtime gates — hence the loose return type.
|
|
8778
8861
|
*
|
|
8779
8862
|
* `theme` is the route's one declared query parameter (a named checkout
|
|
8780
|
-
* variant
|
|
8863
|
+
* variant). `locale` travels as `Accept-Language` — the only
|
|
8781
8864
|
* channel the backend's locale resolution reads; a `?locale=` query is
|
|
8782
8865
|
* silently ignored by this route.
|
|
8783
8866
|
*
|
|
@@ -8857,10 +8940,17 @@ declare class CheckoutSession {
|
|
|
8857
8940
|
/**
|
|
8858
8941
|
* A short-lived VGS Collect session for browser-side card capture.
|
|
8859
8942
|
*
|
|
8860
|
-
*
|
|
8861
|
-
*
|
|
8862
|
-
*
|
|
8863
|
-
*
|
|
8943
|
+
* **Exactly one refusal means "this shop has no vault": a 400 carrying
|
|
8944
|
+
* `IR_19`.** Every other refusal means a vault exists and could not be used,
|
|
8945
|
+
* and answering it by falling back to the processor's own card pane sends an
|
|
8946
|
+
* unprotected card number to the very processor the shop pays to hide it
|
|
8947
|
+
* from — the bug this endpoint's error contract exists to prevent.
|
|
8948
|
+
*
|
|
8949
|
+
* A **404 is not benign.** The router answers it when the shop's vault
|
|
8950
|
+
* account cannot be found — the state a shop is left in when its vault
|
|
8951
|
+
* connector is deleted while the profile keeps naming the id: it still
|
|
8952
|
+
* reports the vault as enabled and still expects its cards cloaked. The same
|
|
8953
|
+
* status also covers a payment that does not exist.
|
|
8864
8954
|
*
|
|
8865
8955
|
* `GET /payment-link/{merchantId}/{paymentId}/vault/collect-session`
|
|
8866
8956
|
*/
|
|
@@ -9135,4 +9225,4 @@ declare function focusedCheckoutUrl(params: FocusedCheckoutUrlParams): string;
|
|
|
9135
9225
|
declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned"];
|
|
9136
9226
|
type CheckoutEventKind = (typeof CHECKOUT_EVENT_KINDS)[number];
|
|
9137
9227
|
|
|
9138
|
-
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountFilter, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type CheckoutThemeComparisonSide, type CheckoutThemeConversionCaveat, type CheckoutThemeConversionCell, type CheckoutThemeConversionComparison, type CheckoutThemeConversionQuery, type CheckoutThemeConversionResponse, type CheckoutThemeConversionSegment, type CheckoutThemeDenominatorBasis, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type CheckoutThemeSampleVerdict, type ClientAnalyticsCaveat, type ClientAnalyticsFilters, type ClientAnalyticsRequest, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillRequest, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillPayment, type DrillResponse, type EncodedBranding, type EpayoutsCatalogEntry, type EpayoutsCatalogResponse, type EpayoutsLocality, type EpayoutsMethod, type EpayoutsMethodsResponse, type EpayoutsRail, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeStatementDetail, type FeeStatementSummary, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GeoAnalyticsChild, type GeoAnalyticsResponse, type GeoAnalyticsTotals, type GeoCitySlice, type GeoCountrySlice, type GeoDrillRequest, type GeoLanguageSlice, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListFilterConstraints, type PaymentListFilteredResponse, type PaymentListOrder, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PaymentsDeletePolicyResponse, type PaymentsDeleteResponse, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PayseproMethod, type PayseproMethodsResponse, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostSource, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopSettlementOverview, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type ShopVisibilityResponse, type ShopVisibilityUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StatementAdjustment, type StatementAdjustmentCreateRequest, type StatementAdjustmentListResponse, type StatementGenerateRequest, type StatementPayoutUpdateRequest, type StatementPdfParams, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TimeToPayBucket, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VaultCheck, type VaultCheckId, type VaultCheckStatus, type VaultCollectSessionResponse, type VaultEnvironment, type VaultPaymentMethodRequest, type VaultPaymentMethodResponse, type VaultRouteApplyVerification, type VaultRouteChange, type VaultRouteChangeKind, type VaultRouteFieldChange, type VaultRouteIds, type VaultRoutePurpose, type VaultRouteWarning, type VaultRouteWarningCode, type VaultRoutesApplyRequest, type VaultRoutesApplyResponse, type VaultRoutesFingerprint, type VaultRoutesPreviewRequest, type VaultRoutesPreviewResponse, type VaultVerificationResponse, type VaultVerifyRequest, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|
|
9228
|
+
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountFilter, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type CheckoutThemeComparisonSide, type CheckoutThemeConversionCaveat, type CheckoutThemeConversionCell, type CheckoutThemeConversionComparison, type CheckoutThemeConversionQuery, type CheckoutThemeConversionResponse, type CheckoutThemeConversionSegment, type CheckoutThemeDenominatorBasis, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type CheckoutThemeSampleVerdict, type ClientAnalyticsCaveat, type ClientAnalyticsFilters, type ClientAnalyticsRequest, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillRequest, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillPayment, type DrillResponse, type EncodedBranding, type EpayoutsCatalogEntry, type EpayoutsCatalogResponse, type EpayoutsLocality, type EpayoutsMethod, type EpayoutsMethodsResponse, type EpayoutsRail, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeStatementDetail, type FeeStatementSummary, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GeoAnalyticsChild, type GeoAnalyticsResponse, type GeoAnalyticsTotals, type GeoCitySlice, type GeoCountrySlice, type GeoDrillRequest, type GeoLanguageSlice, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListFilterConstraints, type PaymentListFilteredResponse, type PaymentListOrder, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PaymentsDeletePolicyResponse, type PaymentsDeleteResponse, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PayseproMethod, type PayseproMethodsResponse, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostSource, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopSettlementOverview, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type ShopVisibilityResponse, type ShopVisibilityUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StatementAdjustment, type StatementAdjustmentCreateRequest, type StatementAdjustmentListResponse, type StatementGenerateRequest, type StatementPayoutUpdateRequest, type StatementPdfParams, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionBillingProcessorResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionInvoiceListParams, type SubscriptionInvoiceListResponse, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TimeToPayBucket, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VaultCheck, type VaultCheckId, type VaultCheckStatus, type VaultCollectSessionResponse, type VaultEnvironment, type VaultPaymentMethodRequest, type VaultPaymentMethodResponse, type VaultRouteApplyVerification, type VaultRouteChange, type VaultRouteChangeKind, type VaultRouteFieldChange, type VaultRouteIds, type VaultRoutePurpose, type VaultRouteWarning, type VaultRouteWarningCode, type VaultRoutesApplyRequest, type VaultRoutesApplyResponse, type VaultRoutesFingerprint, type VaultRoutesPreviewRequest, type VaultRoutesPreviewResponse, type VaultVerificationResponse, type VaultVerifyRequest, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|
package/dist/index.js
CHANGED
package/dist/internal.cjs
CHANGED
|
@@ -231,8 +231,7 @@ var ApiKeys = class {
|
|
|
231
231
|
// JWT-authenticated routes under `/account/{merchantId}/profile/api-keys`.
|
|
232
232
|
// The caller's shop (business profile) comes from the JWT, never from the
|
|
233
233
|
// request, so a shop-scoped user can only mint/list/manage keys pinned to
|
|
234
|
-
// their own shop. Requires a backend with profile-scoped API key support
|
|
235
|
-
// (DeloPay-net/delopay-backend#344).
|
|
234
|
+
// their own shop. Requires a backend with profile-scoped API key support.
|
|
236
235
|
/**
|
|
237
236
|
* Create a new API key pinned to the caller's shop (business profile).
|
|
238
237
|
* `POST /account/{merchantId}/profile/api-keys`
|
|
@@ -3830,6 +3829,53 @@ var Subscriptions = class {
|
|
|
3830
3829
|
async lookupPayments(params, options) {
|
|
3831
3830
|
return this.request("POST", "/subscriptions/payments/lookup", { body: params, ...options });
|
|
3832
3831
|
}
|
|
3832
|
+
/**
|
|
3833
|
+
* One subscription's billing history, newest cycle first.
|
|
3834
|
+
* `GET /subscriptions/{subscriptionId}/invoices`
|
|
3835
|
+
*
|
|
3836
|
+
* {@link retrieve} carries only the *latest* invoice, which is the current
|
|
3837
|
+
* cycle — a subscription that has renewed monthly for a year has one of those
|
|
3838
|
+
* and twelve of these. Use this wherever a merchant needs to see what a
|
|
3839
|
+
* subscription has actually billed, in particular on self-charging processors
|
|
3840
|
+
* (Creem, PayPal) where each renewal is charged by the processor and mirrored
|
|
3841
|
+
* here rather than raised as a DeloPay payment.
|
|
3842
|
+
*
|
|
3843
|
+
* Two things to render honestly, both decided rather than incidental:
|
|
3844
|
+
*
|
|
3845
|
+
* - `amount` is **gross** and `refunded_amount` sits beside it. Do not net
|
|
3846
|
+
* them: the difference between the two is not a smaller charge.
|
|
3847
|
+
* - A `refunded_amount` of `null` is "not reported" and must not render as
|
|
3848
|
+
* `0`. Likewise a processor-hosted origination records a bootstrap invoice
|
|
3849
|
+
* at `0` before the buyer has paid anything, so a zero amount on such a
|
|
3850
|
+
* subscription is a placeholder rather than a free cycle.
|
|
3851
|
+
*
|
|
3852
|
+
* Profile-scoped like every other subscription route.
|
|
3853
|
+
*/
|
|
3854
|
+
async listInvoices(subscriptionId, params, options) {
|
|
3855
|
+
return this.request("GET", `/subscriptions/${encodeURIComponent(subscriptionId)}/invoices`, {
|
|
3856
|
+
query: params,
|
|
3857
|
+
...options
|
|
3858
|
+
});
|
|
3859
|
+
}
|
|
3860
|
+
/**
|
|
3861
|
+
* Which billing processor this shop's subscriptions run on.
|
|
3862
|
+
* `GET /subscriptions/billing_processor`
|
|
3863
|
+
*
|
|
3864
|
+
* The same mapping is derivable from the connector inventory
|
|
3865
|
+
* (`GET /account/{merchant_id}/connectors`), but that route is gated by a
|
|
3866
|
+
* connector-read permission granted independently of subscriptions — so a
|
|
3867
|
+
* role authorised to create subscriptions could be unable to learn which
|
|
3868
|
+
* processor it was creating them on. This answers under the same
|
|
3869
|
+
* authorization as the rest of the subscription API.
|
|
3870
|
+
*
|
|
3871
|
+
* Reach for it when the client must branch on the processor *before* calling
|
|
3872
|
+
* — origination differs by processor, and guessing is destructive. Resolve
|
|
3873
|
+
* the shop's `billing_processor_id` first: a shop that runs no subscriptions
|
|
3874
|
+
* has none assigned, and this route has no identity to report for it.
|
|
3875
|
+
*/
|
|
3876
|
+
async getBillingProcessor(options) {
|
|
3877
|
+
return this.request("GET", "/subscriptions/billing_processor", { ...options });
|
|
3878
|
+
}
|
|
3833
3879
|
};
|
|
3834
3880
|
|
|
3835
3881
|
// src/resources/settlement.ts
|
|
@@ -5737,7 +5783,7 @@ var CheckoutSession = class {
|
|
|
5737
5783
|
* own types and runtime gates — hence the loose return type.
|
|
5738
5784
|
*
|
|
5739
5785
|
* `theme` is the route's one declared query parameter (a named checkout
|
|
5740
|
-
* variant
|
|
5786
|
+
* variant). `locale` travels as `Accept-Language` — the only
|
|
5741
5787
|
* channel the backend's locale resolution reads; a `?locale=` query is
|
|
5742
5788
|
* silently ignored by this route.
|
|
5743
5789
|
*
|
|
@@ -5892,10 +5938,17 @@ var CheckoutSession = class {
|
|
|
5892
5938
|
/**
|
|
5893
5939
|
* A short-lived VGS Collect session for browser-side card capture.
|
|
5894
5940
|
*
|
|
5895
|
-
*
|
|
5896
|
-
*
|
|
5897
|
-
*
|
|
5898
|
-
*
|
|
5941
|
+
* **Exactly one refusal means "this shop has no vault": a 400 carrying
|
|
5942
|
+
* `IR_19`.** Every other refusal means a vault exists and could not be used,
|
|
5943
|
+
* and answering it by falling back to the processor's own card pane sends an
|
|
5944
|
+
* unprotected card number to the very processor the shop pays to hide it
|
|
5945
|
+
* from — the bug this endpoint's error contract exists to prevent.
|
|
5946
|
+
*
|
|
5947
|
+
* A **404 is not benign.** The router answers it when the shop's vault
|
|
5948
|
+
* account cannot be found — the state a shop is left in when its vault
|
|
5949
|
+
* connector is deleted while the profile keeps naming the id: it still
|
|
5950
|
+
* reports the vault as enabled and still expects its cards cloaked. The same
|
|
5951
|
+
* status also covers a payment that does not exist.
|
|
5899
5952
|
*
|
|
5900
5953
|
* `GET /payment-link/{merchantId}/{paymentId}/vault/collect-session`
|
|
5901
5954
|
*/
|