@paddle/paddle-node-sdk 3.9.0 → 3.11.0

package/dist/types/types/subscription/subscription-consent-requirement-response.d.ts

@@ -0,0 +1,11 @@
+import { type SubscriptionConsentRequirementStatus, type SubscriptionConsentRequirementType } from '../../enums/index.js';
+import { type ISubscriptionTimePeriodResponse } from './subscription-time-period-response.js';
+export interface ISubscriptionConsentRequirementResponse {
+    id: string;
+    requirement: SubscriptionConsentRequirementType;
+    status: SubscriptionConsentRequirementStatus;
+    created_at: string;
+    consent_period: ISubscriptionTimePeriodResponse | null;
+    granted_at: string | null;
+    voided_at: string | null;
+}

package/dist/types/types/subscription/subscription-discount-response.d.ts

@@ -1,5 +1,7 @@
+import { type SubscriptionDiscountType } from '../../enums/index.js';
 export interface ISubscriptionDiscountResponse {
     id: string;
     starts_at: string | null;
     ends_at?: string | null;
+    type: SubscriptionDiscountType;
 }

package/dist/types/types/subscription/subscription-management-response.d.ts

@@ -1,4 +1,5 @@
 export interface ISubscriptionManagementResponse {
     update_payment_method?: string | null;
     cancel: string;
+    view_subscription: string;
 }

package/dist/types/types/subscription/subscription-preview-response.d.ts

@@ -7,6 +7,7 @@ import { type ISubscriptionManagementResponse } from './subscription-management-
 import { type ISubscriptionItemResponse } from './subscription-item-response.js';
 import { type INextTransactionResponse } from './next-transaction-response.js';
 import { type ISubscriptionPreviewUpdateSummary } from './subscription-preview-update-summary.js';
+import { type ISubscriptionConsentRequirementResponse } from './subscription-consent-requirement-response.js';
 export interface ISubscriptionPreviewResponse {
     status: SubscriptionStatus;
     customer_id: string;
@@ -34,4 +35,5 @@ export interface ISubscriptionPreviewResponse {
     recurring_transaction_details?: ITransactionDetailsPreviewResponse | null;
     update_summary?: ISubscriptionPreviewUpdateSummary | null;
     import_meta?: IImportMetaResponse | null;
+    consent_requirements: ISubscriptionConsentRequirementResponse[];
 }

package/dist/types/types/subscription/subscription-response.d.ts

@@ -6,6 +6,7 @@ import { type ISubscriptionScheduledChangeResponse } from './subscription-schedu
 import { type ISubscriptionManagementResponse } from './subscription-management-response.js';
 import { type ISubscriptionItemResponse } from './subscription-item-response.js';
 import { type INextTransactionResponse } from './next-transaction-response.js';
+import { type ISubscriptionConsentRequirementResponse } from './subscription-consent-requirement-response.js';
 export interface ISubscriptionResponse {
     id: string;
     status: SubscriptionStatus;
@@ -32,4 +33,5 @@ export interface ISubscriptionResponse {
     next_transaction?: INextTransactionResponse | null;
     recurring_transaction_details?: ITransactionDetailsPreviewResponse | null;
     import_meta?: IImportMetaResponse | null;
+    consent_requirements: ISubscriptionConsentRequirementResponse[];
 }

package/dist/types/types/subscription-history/index.d.ts

@@ -0,0 +1,5 @@
+export * from './subscription-history-item-response.js';
+export * from './subscription-history-discount-response.js';
+export * from './subscription-history-item-update-summary-response.js';
+export * from './subscription-history-detail-response.js';
+export * from './subscription-history-response.js';

package/dist/types/types/subscription-history/subscription-history-detail-response.d.ts

@@ -0,0 +1,185 @@
+import { type CollectionMode, type CurrencyCode, type ProrationBillingMode, type SubscriptionEffectiveFrom, type SubscriptionHistoryPaymentAttemptedOperation, type SubscriptionOnPaymentFailure, type SubscriptionOnResume, type SubscriptionStatus } from '../../enums/index.js';
+import { type IAddressResponse } from '../address/index.js';
+import { type IBusinessResponse } from '../business/index.js';
+import { type ICustomerResponse } from '../customer/index.js';
+import { type IPriceResponse } from '../price/index.js';
+import { type IBillingDetailsResponse, type ICustomData, type ITimePeriod } from '../shared/index.js';
+import { type ISubscriptionConsentRequirementResponse, type ISubscriptionScheduledChangeResponse, type ISubscriptionTimePeriodResponse } from '../subscription/index.js';
+import { type ISubscriptionHistoryDiscountResponse } from './subscription-history-discount-response.js';
+import { type ISubscriptionHistoryItemResponse } from './subscription-history-item-response.js';
+import { type ISubscriptionHistoryItemUpdateSummaryResponse } from './subscription-history-item-update-summary-response.js';
+export interface ISubscriptionHistoryActivatedDetailResponse {
+    action: 'subscription_activated';
+    status: SubscriptionStatus;
+    first_billed_at: string | null;
+    next_billed_at: string | null;
+    current_billing_period: ISubscriptionTimePeriodResponse;
+    transaction_id: string;
+}
+export interface ISubscriptionHistoryAddressUpdatedDetailResponse {
+    action: 'subscription_address_updated';
+    address: IAddressResponse;
+}
+export interface ISubscriptionHistoryBillingCycleUpdatedDetailResponse {
+    action: 'subscription_billing_cycle_updated';
+    billing_cycle: ITimePeriod;
+    current_billing_period: ISubscriptionTimePeriodResponse;
+    next_billed_at: string | null;
+}
+export interface ISubscriptionHistoryBillingDateUpdatedDetailResponse {
+    action: 'subscription_billing_date_updated';
+    next_billed_at: string | null;
+    current_billing_period: ISubscriptionTimePeriodResponse;
+    transaction_id: string | null;
+    proration_billing_mode: ProrationBillingMode;
+}
+export interface ISubscriptionHistoryBillingDetailsUpdatedDetailResponse {
+    action: 'subscription_billing_details_updated';
+    billing_details: IBillingDetailsResponse;
+}
+export interface ISubscriptionHistoryBusinessAddedDetailResponse {
+    action: 'subscription_business_added';
+    business: IBusinessResponse;
+}
+export interface ISubscriptionHistoryBusinessRemovedDetailResponse {
+    action: 'subscription_business_removed';
+    business: IBusinessResponse;
+}
+export interface ISubscriptionHistoryBusinessUpdatedDetailResponse {
+    action: 'subscription_business_updated';
+    business: IBusinessResponse;
+}
+export interface ISubscriptionHistoryCanceledDetailResponse {
+    action: 'subscription_canceled';
+    effective_from: SubscriptionEffectiveFrom | null;
+}
+export interface ISubscriptionHistoryCollectionModeUpdatedDetailResponse {
+    action: 'subscription_collection_mode_updated';
+    collection_mode: CollectionMode;
+}
+export interface ISubscriptionHistoryConsentRequirementGrantedDetailResponse {
+    action: 'subscription_consent_requirement_granted';
+    consent_requirement: ISubscriptionConsentRequirementResponse;
+}
+export interface ISubscriptionHistoryCreatedDetailResponse {
+    action: 'subscription_created';
+    status: SubscriptionStatus | null;
+    collection_mode: CollectionMode | null;
+    billing_details: IBillingDetailsResponse | null;
+    customer: ICustomerResponse | null;
+    address: IAddressResponse | null;
+    business: IBusinessResponse | null;
+    currency_code: CurrencyCode | null;
+    current_billing_period: ISubscriptionTimePeriodResponse | null;
+    billing_cycle: ITimePeriod | null;
+    items: ISubscriptionHistoryItemResponse[] | null;
+    custom_data: ICustomData | null;
+    discount: ISubscriptionHistoryDiscountResponse | null;
+    has_payment_method: boolean | null;
+}
+export interface ISubscriptionHistoryCurrencyUpdatedDetailResponse {
+    action: 'subscription_currency_updated';
+    currency_code: CurrencyCode;
+}
+export interface ISubscriptionHistoryCustomDataUpdatedDetailResponse {
+    action: 'subscription_custom_data_updated';
+    custom_data: ICustomData | null;
+}
+export interface ISubscriptionHistoryCustomerUpdatedDetailResponse {
+    action: 'subscription_customer_updated';
+    customer: ICustomerResponse;
+}
+export interface ISubscriptionHistoryDiscountAddedDetailResponse {
+    action: 'subscription_discount_added';
+    discount: ISubscriptionHistoryDiscountResponse;
+}
+export interface ISubscriptionHistoryDiscountExpiredDetailResponse {
+    action: 'subscription_discount_expired';
+    discount: ISubscriptionHistoryDiscountResponse;
+}
+export interface ISubscriptionHistoryDiscountRemovedDetailResponse {
+    action: 'subscription_discount_removed';
+    discount: ISubscriptionHistoryDiscountResponse;
+}
+export interface ISubscriptionHistoryItemAddedDetailResponse {
+    action: 'subscription_item_added';
+    price: IPriceResponse;
+    quantity: number;
+    update_summary: ISubscriptionHistoryItemUpdateSummaryResponse;
+    proration_billing_mode: ProrationBillingMode;
+    on_payment_failure: SubscriptionOnPaymentFailure;
+    transaction_id: string | null;
+}
+export interface ISubscriptionHistoryItemQuantityUpdatedDetailResponse {
+    action: 'subscription_item_quantity_updated';
+    price: IPriceResponse;
+    quantity: number;
+    update_summary: ISubscriptionHistoryItemUpdateSummaryResponse;
+    proration_billing_mode: ProrationBillingMode;
+    on_payment_failure: SubscriptionOnPaymentFailure;
+    transaction_id: string | null;
+}
+export interface ISubscriptionHistoryItemRemovedDetailResponse {
+    action: 'subscription_item_removed';
+    price: IPriceResponse;
+    quantity: number;
+    update_summary: ISubscriptionHistoryItemUpdateSummaryResponse;
+    proration_billing_mode: ProrationBillingMode;
+    on_payment_failure: SubscriptionOnPaymentFailure;
+    transaction_id: string | null;
+}
+export interface ISubscriptionHistoryOneOffChargeAppliedDetailResponse {
+    action: 'subscription_one_off_charge_applied';
+    effective_from: SubscriptionEffectiveFrom;
+    items: ISubscriptionHistoryItemResponse[];
+    on_payment_failure: SubscriptionOnPaymentFailure;
+    transaction_id: string | null;
+}
+export interface ISubscriptionHistoryPastDueDetailResponse {
+    action: 'subscription_past_due';
+    status: SubscriptionStatus;
+    transaction_id: string;
+}
+export interface ISubscriptionHistoryPausedDetailResponse {
+    action: 'subscription_paused';
+    effective_from: SubscriptionEffectiveFrom;
+    status: SubscriptionStatus;
+}
+export interface ISubscriptionHistoryPaymentAttemptedDetailResponse {
+    action: 'subscription_payment_attempted';
+    operation: SubscriptionHistoryPaymentAttemptedOperation;
+    transaction_id: string;
+}
+export interface ISubscriptionHistoryPaymentMethodAddedDetailResponse {
+    action: 'subscription_payment_method_added';
+}
+export interface ISubscriptionHistoryPaymentMethodRemovedDetailResponse {
+    action: 'subscription_payment_method_removed';
+}
+export interface ISubscriptionHistoryPaymentMethodUpdatedDetailResponse {
+    action: 'subscription_payment_method_updated';
+}
+export interface ISubscriptionHistoryRenewedDetailResponse {
+    action: 'subscription_renewed';
+    next_billed_at: string;
+    current_billing_period: ISubscriptionTimePeriodResponse;
+    transaction_id: string;
+}
+export interface ISubscriptionHistoryResumedDetailResponse {
+    action: 'subscription_resumed';
+    status: SubscriptionStatus;
+    on_resume: SubscriptionOnResume;
+}
+export interface ISubscriptionHistoryScheduledChangeAddedDetailResponse {
+    action: 'subscription_scheduled_change_added';
+    scheduled_change: ISubscriptionScheduledChangeResponse;
+}
+export interface ISubscriptionHistoryScheduledChangeRemovedDetailResponse {
+    action: 'subscription_scheduled_change_removed';
+    scheduled_change: ISubscriptionScheduledChangeResponse;
+}
+export interface ISubscriptionHistoryScheduledChangeUpdatedDetailResponse {
+    action: 'subscription_scheduled_change_updated';
+    scheduled_change: ISubscriptionScheduledChangeResponse;
+}
+export type ISubscriptionHistoryDetailResponse = ISubscriptionHistoryActivatedDetailResponse | ISubscriptionHistoryAddressUpdatedDetailResponse | ISubscriptionHistoryBillingCycleUpdatedDetailResponse | ISubscriptionHistoryBillingDateUpdatedDetailResponse | ISubscriptionHistoryBillingDetailsUpdatedDetailResponse | ISubscriptionHistoryBusinessAddedDetailResponse | ISubscriptionHistoryBusinessRemovedDetailResponse | ISubscriptionHistoryBusinessUpdatedDetailResponse | ISubscriptionHistoryCanceledDetailResponse | ISubscriptionHistoryCollectionModeUpdatedDetailResponse | ISubscriptionHistoryConsentRequirementGrantedDetailResponse | ISubscriptionHistoryCreatedDetailResponse | ISubscriptionHistoryCurrencyUpdatedDetailResponse | ISubscriptionHistoryCustomDataUpdatedDetailResponse | ISubscriptionHistoryCustomerUpdatedDetailResponse | ISubscriptionHistoryDiscountAddedDetailResponse | ISubscriptionHistoryDiscountExpiredDetailResponse | ISubscriptionHistoryDiscountRemovedDetailResponse | ISubscriptionHistoryItemAddedDetailResponse | ISubscriptionHistoryItemQuantityUpdatedDetailResponse | ISubscriptionHistoryItemRemovedDetailResponse | ISubscriptionHistoryOneOffChargeAppliedDetailResponse | ISubscriptionHistoryPastDueDetailResponse | ISubscriptionHistoryPausedDetailResponse | ISubscriptionHistoryPaymentAttemptedDetailResponse | ISubscriptionHistoryPaymentMethodAddedDetailResponse | ISubscriptionHistoryPaymentMethodRemovedDetailResponse | ISubscriptionHistoryPaymentMethodUpdatedDetailResponse | ISubscriptionHistoryRenewedDetailResponse | ISubscriptionHistoryResumedDetailResponse | ISubscriptionHistoryScheduledChangeAddedDetailResponse | ISubscriptionHistoryScheduledChangeRemovedDetailResponse | ISubscriptionHistoryScheduledChangeUpdatedDetailResponse;

package/dist/types/types/subscription-history/subscription-history-discount-response.d.ts

@@ -0,0 +1,8 @@
+import { type SubscriptionHistoryDiscountType } from '../../enums/index.js';
+import { type IDiscountResponse } from '../discount/index.js';
+export interface ISubscriptionHistoryDiscountResponse {
+    discount: IDiscountResponse;
+    type: SubscriptionHistoryDiscountType;
+    starts_at: string;
+    ends_at: string | null;
+}

package/dist/types/types/subscription-history/subscription-history-item-response.d.ts

@@ -0,0 +1,5 @@
+import { type IPriceResponse } from '../price/index.js';
+export interface ISubscriptionHistoryItemResponse {
+    price: IPriceResponse;
+    quantity: number;
+}

package/dist/types/types/subscription-history/subscription-history-item-update-summary-response.d.ts

@@ -0,0 +1,3 @@
+export interface ISubscriptionHistoryItemUpdateSummaryResponse {
+    quantity_delta: number;
+}

package/dist/types/types/subscription-history/subscription-history-response.d.ts

@@ -0,0 +1,13 @@
+import { type ActionSource, type SubscriptionHistoryReason } from '../../enums/index.js';
+import { type IActorResponse } from '../shared/index.js';
+import { type ISubscriptionHistoryDetailResponse } from './subscription-history-detail-response.js';
+export interface ISubscriptionHistoryResponse {
+    id: string;
+    group_id: string;
+    subscription_id: string;
+    occurred_at: string;
+    source: ActionSource;
+    actor: IActorResponse;
+    reason: SubscriptionHistoryReason | null;
+    detail: ISubscriptionHistoryDetailResponse;
+}

package/dist/types/types/transaction/adjustment-totals-response.d.ts

@@ -5,6 +5,7 @@ export interface IAdjustmentTotalsResponse {
     tax: string;
     total: string;
     fee: string;
+    retained_fee: string;
     earnings: string;
     breakdown?: IAdjustmentTotalsBreakdown | null;
     currency_code: CurrencyCode;

package/dist/types/types/transaction/transaction-adjustment-response.d.ts

@@ -1,19 +1,22 @@
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
+import { type AdjustmentActionType, type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
 import { type ITransactionAdjustmentItemResponse } from './transaction-adjustment-item-response.js';
 import { type IPayoutTotalsAdjustmentResponse, type ITotalAdjustmentsResponse } from '../shared/index.js';
+import { type IAdjustmentTaxRatesUsedResponse } from '../adjustment/index.js';
 export interface ITransactionAdjustmentResponse {
     id: string;
     action: AdjustmentAction;
+    type: AdjustmentActionType;
     transaction_id: string;
     subscription_id?: string | null;
     customer_id: string;
     reason: string;
-    credit_applied_to_balance: boolean;
+    credit_applied_to_balance: boolean | null;
     currency_code: CurrencyCode;
     status: AdjustmentStatus;
     items: ITransactionAdjustmentItemResponse[];
     totals?: ITotalAdjustmentsResponse | null;
     payout_totals?: IPayoutTotalsAdjustmentResponse | null;
+    tax_rates_used: IAdjustmentTaxRatesUsedResponse[];
     created_at: string;
     updated_at: string;
 }

package/dist/types/types/transaction/transaction-preview-response.d.ts

@@ -24,5 +24,6 @@ export interface ITransactionPreviewResponse {
     ignore_trials?: boolean | null;
     items: ITransactionItemPreviewResponse[];
     details: ITransactionDetailsPreviewResponse;
+    available_payment_methods?: AvailablePaymentMethod[] | null;
     available_payment_method?: AvailablePaymentMethod | null;
 }

package/dist/types/types/usage-balance/index.d.ts

@@ -0,0 +1 @@
+export * from './usage-balance-response.js';

package/dist/types/types/usage-balance/usage-balance-response.d.ts

@@ -0,0 +1,21 @@
+export interface IUsageBalanceAmountResponse {
+    total: string;
+    subscription: string;
+}
+export interface IUsageBalanceOverageResponse {
+    total: string;
+    started_at?: string | null;
+}
+export interface IUsageBalanceBalanceResponse {
+    used: IUsageBalanceAmountResponse;
+    remaining: IUsageBalanceAmountResponse;
+    overage: IUsageBalanceOverageResponse;
+}
+export interface IUsageBalanceResponse {
+    id: string;
+    customer_id: string;
+    usage_balance_unit_id: string;
+    balance: IUsageBalanceBalanceResponse;
+    created_at: string;
+    updated_at: string;
+}

package/dist/types/types/usage-balance-unit/index.d.ts

@@ -0,0 +1 @@
+export * from './usage-balance-unit-response.js';

package/dist/types/types/usage-balance-unit/usage-balance-unit-response.d.ts

@@ -0,0 +1,9 @@
+import { type Status } from '../../enums/index.js';
+export interface IUsageBalanceUnitResponse {
+    id: string;
+    name: string;
+    unit_name: string;
+    status: Status;
+    created_at: string;
+    updated_at: string;
+}

package/dist/types/types/verification/index.d.ts

@@ -0,0 +1,2 @@
+export * from './verification-step.js';
+export * from './verification.js';

package/dist/types/types/verification/verification-step.d.ts

@@ -0,0 +1,9 @@
+import { type VerificationStepKey, type VerificationStepStatus } from '../../enums/index.js';
+export interface IVerificationStep {
+    id: string;
+    key: VerificationStepKey;
+    status: VerificationStepStatus;
+    expires_at: string | null;
+    created_at: string;
+    updated_at: string;
+}

package/dist/types/types/verification/verification.d.ts

@@ -0,0 +1,10 @@
+import { type VerificationStatus, type VerificationType } from '../../enums/index.js';
+import { type IVerificationStep } from './verification-step.js';
+export interface IVerificationResponse {
+    id: string;
+    status: VerificationStatus;
+    verification_type: VerificationType;
+    created_at: string;
+    updated_at: string;
+    steps: IVerificationStep[];
+}

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.9.0";
+export declare const SDK_VERSION = "3.11.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "3.9.0",
+  "version": "3.11.0",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
   "main": "dist/cjs/index.cjs.node.js",
   "module": "dist/esm/index.esm.node.js",